| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054250552505625057250582505925060250612506225063250642506525066250672506825069250702507125072250732507425075250762507725078250792508025081250822508325084250852508625087250882508925090250912509225093250942509525096250972509825099251002510125102251032510425105251062510725108251092511025111251122511325114251152511625117251182511925120251212512225123251242512525126251272512825129251302513125132251332513425135251362513725138251392514025141251422514325144251452514625147251482514925150251512515225153251542515525156251572515825159251602516125162251632516425165251662516725168251692517025171251722517325174251752517625177251782517925180251812518225183251842518525186251872518825189251902519125192251932519425195251962519725198251992520025201252022520325204252052520625207252082520925210252112521225213252142521525216252172521825219252202522125222252232522425225252262522725228252292523025231252322523325234252352523625237252382523925240252412524225243252442524525246252472524825249252502525125252252532525425255252562525725258252592526025261252622526325264252652526625267252682526925270252712527225273252742527525276252772527825279252802528125282252832528425285252862528725288252892529025291252922529325294252952529625297252982529925300253012530225303253042530525306253072530825309253102531125312253132531425315253162531725318253192532025321253222532325324253252532625327253282532925330253312533225333253342533525336253372533825339253402534125342253432534425345253462534725348253492535025351253522535325354253552535625357253582535925360253612536225363253642536525366253672536825369253702537125372253732537425375253762537725378253792538025381253822538325384253852538625387253882538925390253912539225393253942539525396253972539825399254002540125402254032540425405254062540725408254092541025411254122541325414254152541625417254182541925420254212542225423254242542525426254272542825429254302543125432254332543425435254362543725438254392544025441254422544325444254452544625447254482544925450254512545225453254542545525456254572545825459254602546125462254632546425465254662546725468254692547025471254722547325474254752547625477254782547925480254812548225483254842548525486254872548825489254902549125492254932549425495254962549725498254992550025501255022550325504255052550625507255082550925510255112551225513255142551525516255172551825519255202552125522255232552425525255262552725528255292553025531255322553325534255352553625537255382553925540255412554225543255442554525546255472554825549255502555125552255532555425555255562555725558255592556025561255622556325564255652556625567255682556925570255712557225573255742557525576255772557825579255802558125582255832558425585255862558725588255892559025591255922559325594255952559625597255982559925600256012560225603256042560525606256072560825609256102561125612256132561425615256162561725618256192562025621256222562325624256252562625627256282562925630256312563225633256342563525636256372563825639256402564125642256432564425645256462564725648256492565025651256522565325654256552565625657256582565925660256612566225663256642566525666256672566825669256702567125672256732567425675256762567725678256792568025681256822568325684256852568625687256882568925690256912569225693256942569525696256972569825699257002570125702257032570425705257062570725708257092571025711257122571325714257152571625717257182571925720257212572225723257242572525726257272572825729257302573125732257332573425735257362573725738257392574025741257422574325744257452574625747257482574925750257512575225753257542575525756257572575825759257602576125762257632576425765257662576725768257692577025771257722577325774257752577625777257782577925780257812578225783257842578525786257872578825789257902579125792257932579425795257962579725798257992580025801258022580325804258052580625807258082580925810258112581225813258142581525816258172581825819258202582125822258232582425825258262582725828258292583025831258322583325834258352583625837258382583925840258412584225843258442584525846258472584825849258502585125852258532585425855258562585725858258592586025861258622586325864258652586625867258682586925870258712587225873258742587525876258772587825879258802588125882258832588425885258862588725888258892589025891258922589325894258952589625897258982589925900259012590225903259042590525906259072590825909259102591125912259132591425915259162591725918259192592025921259222592325924259252592625927259282592925930259312593225933259342593525936259372593825939259402594125942259432594425945259462594725948259492595025951259522595325954259552595625957259582595925960259612596225963259642596525966259672596825969259702597125972259732597425975259762597725978259792598025981259822598325984259852598625987259882598925990259912599225993259942599525996259972599825999260002600126002260032600426005260062600726008260092601026011260122601326014260152601626017260182601926020260212602226023260242602526026260272602826029260302603126032260332603426035260362603726038260392604026041260422604326044260452604626047260482604926050260512605226053260542605526056260572605826059260602606126062260632606426065260662606726068260692607026071260722607326074260752607626077260782607926080260812608226083260842608526086260872608826089260902609126092260932609426095260962609726098260992610026101261022610326104261052610626107261082610926110261112611226113261142611526116261172611826119261202612126122261232612426125261262612726128261292613026131261322613326134261352613626137261382613926140261412614226143261442614526146261472614826149261502615126152261532615426155261562615726158261592616026161261622616326164261652616626167261682616926170261712617226173261742617526176261772617826179261802618126182261832618426185261862618726188261892619026191261922619326194261952619626197261982619926200262012620226203262042620526206262072620826209262102621126212262132621426215262162621726218262192622026221262222622326224262252622626227262282622926230262312623226233262342623526236262372623826239262402624126242262432624426245262462624726248262492625026251262522625326254262552625626257262582625926260262612626226263262642626526266262672626826269262702627126272262732627426275262762627726278262792628026281262822628326284262852628626287262882628926290262912629226293262942629526296262972629826299263002630126302263032630426305263062630726308263092631026311263122631326314263152631626317263182631926320263212632226323263242632526326263272632826329263302633126332263332633426335263362633726338263392634026341263422634326344263452634626347263482634926350263512635226353263542635526356263572635826359263602636126362263632636426365263662636726368263692637026371263722637326374263752637626377263782637926380263812638226383263842638526386263872638826389263902639126392263932639426395263962639726398263992640026401264022640326404264052640626407264082640926410264112641226413264142641526416264172641826419264202642126422264232642426425264262642726428264292643026431264322643326434264352643626437264382643926440264412644226443264442644526446264472644826449264502645126452264532645426455264562645726458264592646026461264622646326464264652646626467264682646926470264712647226473264742647526476264772647826479264802648126482264832648426485264862648726488264892649026491264922649326494264952649626497264982649926500265012650226503265042650526506265072650826509265102651126512265132651426515265162651726518265192652026521265222652326524265252652626527265282652926530265312653226533265342653526536265372653826539265402654126542265432654426545265462654726548265492655026551265522655326554265552655626557265582655926560265612656226563265642656526566265672656826569265702657126572265732657426575265762657726578265792658026581265822658326584265852658626587265882658926590265912659226593265942659526596265972659826599266002660126602266032660426605266062660726608266092661026611266122661326614266152661626617266182661926620266212662226623266242662526626266272662826629266302663126632266332663426635266362663726638266392664026641266422664326644266452664626647266482664926650266512665226653266542665526656266572665826659266602666126662266632666426665266662666726668266692667026671266722667326674266752667626677266782667926680266812668226683266842668526686266872668826689266902669126692266932669426695266962669726698266992670026701267022670326704267052670626707267082670926710267112671226713267142671526716267172671826719267202672126722267232672426725267262672726728267292673026731267322673326734267352673626737267382673926740267412674226743267442674526746267472674826749267502675126752267532675426755267562675726758267592676026761267622676326764267652676626767267682676926770267712677226773267742677526776267772677826779267802678126782267832678426785267862678726788267892679026791267922679326794267952679626797267982679926800268012680226803268042680526806268072680826809268102681126812268132681426815268162681726818268192682026821268222682326824268252682626827268282682926830268312683226833268342683526836268372683826839268402684126842268432684426845268462684726848268492685026851268522685326854268552685626857268582685926860268612686226863268642686526866268672686826869268702687126872268732687426875268762687726878268792688026881268822688326884268852688626887268882688926890268912689226893268942689526896268972689826899269002690126902269032690426905269062690726908269092691026911269122691326914269152691626917269182691926920269212692226923269242692526926269272692826929269302693126932269332693426935269362693726938269392694026941269422694326944269452694626947269482694926950269512695226953269542695526956269572695826959269602696126962269632696426965269662696726968269692697026971269722697326974269752697626977269782697926980269812698226983269842698526986269872698826989269902699126992269932699426995269962699726998269992700027001270022700327004270052700627007270082700927010270112701227013270142701527016270172701827019270202702127022270232702427025270262702727028270292703027031270322703327034270352703627037270382703927040270412704227043270442704527046270472704827049270502705127052270532705427055270562705727058270592706027061270622706327064270652706627067270682706927070270712707227073270742707527076270772707827079270802708127082270832708427085270862708727088270892709027091270922709327094270952709627097270982709927100271012710227103271042710527106271072710827109271102711127112271132711427115271162711727118271192712027121271222712327124271252712627127271282712927130271312713227133271342713527136271372713827139271402714127142271432714427145271462714727148271492715027151271522715327154271552715627157271582715927160271612716227163271642716527166271672716827169271702717127172271732717427175271762717727178271792718027181271822718327184271852718627187271882718927190271912719227193271942719527196271972719827199272002720127202272032720427205272062720727208272092721027211272122721327214272152721627217272182721927220272212722227223272242722527226272272722827229272302723127232272332723427235272362723727238272392724027241272422724327244272452724627247272482724927250272512725227253272542725527256272572725827259272602726127262272632726427265272662726727268272692727027271272722727327274272752727627277272782727927280272812728227283272842728527286272872728827289272902729127292272932729427295272962729727298272992730027301273022730327304273052730627307273082730927310273112731227313273142731527316273172731827319273202732127322273232732427325273262732727328273292733027331273322733327334273352733627337273382733927340273412734227343273442734527346273472734827349273502735127352273532735427355273562735727358273592736027361273622736327364273652736627367273682736927370273712737227373273742737527376273772737827379273802738127382273832738427385273862738727388273892739027391273922739327394273952739627397273982739927400274012740227403274042740527406274072740827409274102741127412274132741427415274162741727418274192742027421274222742327424274252742627427274282742927430274312743227433274342743527436274372743827439274402744127442274432744427445274462744727448274492745027451274522745327454274552745627457274582745927460274612746227463274642746527466274672746827469274702747127472274732747427475274762747727478274792748027481274822748327484274852748627487274882748927490274912749227493274942749527496274972749827499275002750127502275032750427505275062750727508275092751027511275122751327514275152751627517275182751927520275212752227523275242752527526275272752827529275302753127532275332753427535275362753727538275392754027541275422754327544275452754627547275482754927550275512755227553275542755527556275572755827559275602756127562275632756427565275662756727568275692757027571275722757327574275752757627577275782757927580275812758227583275842758527586275872758827589275902759127592275932759427595275962759727598275992760027601276022760327604276052760627607276082760927610276112761227613276142761527616276172761827619276202762127622276232762427625276262762727628276292763027631276322763327634276352763627637276382763927640276412764227643276442764527646276472764827649276502765127652276532765427655276562765727658276592766027661276622766327664276652766627667276682766927670276712767227673276742767527676276772767827679276802768127682276832768427685276862768727688276892769027691276922769327694276952769627697276982769927700277012770227703277042770527706277072770827709277102771127712277132771427715277162771727718277192772027721277222772327724277252772627727277282772927730277312773227733277342773527736277372773827739277402774127742277432774427745277462774727748277492775027751277522775327754277552775627757277582775927760277612776227763277642776527766277672776827769277702777127772277732777427775277762777727778277792778027781277822778327784277852778627787277882778927790277912779227793277942779527796277972779827799278002780127802278032780427805278062780727808278092781027811278122781327814278152781627817278182781927820278212782227823278242782527826278272782827829278302783127832278332783427835278362783727838278392784027841278422784327844278452784627847278482784927850278512785227853278542785527856278572785827859278602786127862278632786427865278662786727868278692787027871278722787327874278752787627877278782787927880278812788227883278842788527886278872788827889278902789127892278932789427895278962789727898278992790027901279022790327904279052790627907279082790927910279112791227913279142791527916279172791827919279202792127922279232792427925279262792727928279292793027931279322793327934279352793627937279382793927940279412794227943279442794527946279472794827949279502795127952279532795427955279562795727958279592796027961279622796327964279652796627967279682796927970279712797227973279742797527976279772797827979279802798127982279832798427985279862798727988279892799027991279922799327994279952799627997279982799928000280012800228003280042800528006280072800828009280102801128012280132801428015280162801728018280192802028021280222802328024280252802628027280282802928030280312803228033280342803528036280372803828039280402804128042280432804428045280462804728048280492805028051280522805328054280552805628057280582805928060280612806228063280642806528066280672806828069280702807128072280732807428075280762807728078280792808028081280822808328084280852808628087280882808928090280912809228093280942809528096280972809828099281002810128102281032810428105281062810728108281092811028111281122811328114281152811628117281182811928120281212812228123281242812528126281272812828129281302813128132281332813428135281362813728138281392814028141281422814328144281452814628147281482814928150281512815228153281542815528156281572815828159281602816128162281632816428165281662816728168281692817028171281722817328174281752817628177281782817928180281812818228183281842818528186281872818828189281902819128192281932819428195281962819728198281992820028201282022820328204282052820628207282082820928210282112821228213282142821528216282172821828219282202822128222282232822428225282262822728228282292823028231282322823328234282352823628237282382823928240282412824228243282442824528246282472824828249282502825128252282532825428255282562825728258282592826028261282622826328264282652826628267282682826928270282712827228273282742827528276282772827828279282802828128282282832828428285282862828728288282892829028291282922829328294282952829628297282982829928300283012830228303283042830528306283072830828309283102831128312283132831428315283162831728318283192832028321283222832328324283252832628327283282832928330283312833228333283342833528336283372833828339283402834128342283432834428345283462834728348283492835028351283522835328354283552835628357283582835928360283612836228363283642836528366283672836828369283702837128372283732837428375283762837728378283792838028381283822838328384283852838628387283882838928390283912839228393283942839528396283972839828399284002840128402284032840428405284062840728408284092841028411284122841328414284152841628417284182841928420284212842228423284242842528426284272842828429284302843128432284332843428435284362843728438284392844028441284422844328444284452844628447284482844928450284512845228453284542845528456284572845828459284602846128462284632846428465284662846728468284692847028471284722847328474284752847628477284782847928480284812848228483284842848528486284872848828489284902849128492284932849428495284962849728498284992850028501285022850328504285052850628507285082850928510285112851228513285142851528516285172851828519285202852128522285232852428525285262852728528285292853028531285322853328534285352853628537285382853928540285412854228543285442854528546285472854828549285502855128552285532855428555285562855728558285592856028561285622856328564285652856628567285682856928570285712857228573285742857528576285772857828579285802858128582285832858428585285862858728588285892859028591285922859328594285952859628597285982859928600286012860228603286042860528606286072860828609286102861128612286132861428615286162861728618286192862028621286222862328624286252862628627286282862928630286312863228633286342863528636286372863828639286402864128642286432864428645286462864728648286492865028651286522865328654286552865628657286582865928660286612866228663286642866528666286672866828669286702867128672286732867428675286762867728678286792868028681286822868328684286852868628687286882868928690286912869228693286942869528696286972869828699287002870128702287032870428705287062870728708287092871028711287122871328714287152871628717287182871928720287212872228723287242872528726287272872828729287302873128732287332873428735287362873728738287392874028741287422874328744287452874628747287482874928750287512875228753287542875528756287572875828759287602876128762287632876428765287662876728768287692877028771287722877328774287752877628777287782877928780287812878228783287842878528786287872878828789287902879128792287932879428795287962879728798287992880028801288022880328804288052880628807288082880928810288112881228813288142881528816288172881828819288202882128822288232882428825288262882728828288292883028831288322883328834288352883628837288382883928840288412884228843288442884528846288472884828849288502885128852288532885428855288562885728858288592886028861288622886328864288652886628867288682886928870288712887228873288742887528876288772887828879288802888128882288832888428885288862888728888288892889028891288922889328894288952889628897288982889928900289012890228903289042890528906289072890828909289102891128912289132891428915289162891728918289192892028921289222892328924289252892628927289282892928930289312893228933289342893528936289372893828939289402894128942289432894428945289462894728948289492895028951289522895328954289552895628957289582895928960289612896228963289642896528966289672896828969289702897128972289732897428975289762897728978289792898028981289822898328984289852898628987289882898928990289912899228993289942899528996289972899828999290002900129002290032900429005290062900729008290092901029011290122901329014290152901629017290182901929020290212902229023290242902529026290272902829029290302903129032290332903429035290362903729038290392904029041290422904329044290452904629047290482904929050290512905229053290542905529056290572905829059290602906129062290632906429065290662906729068290692907029071290722907329074290752907629077290782907929080290812908229083290842908529086290872908829089290902909129092290932909429095290962909729098290992910029101291022910329104291052910629107291082910929110291112911229113291142911529116291172911829119291202912129122291232912429125291262912729128291292913029131291322913329134291352913629137291382913929140291412914229143291442914529146291472914829149291502915129152291532915429155291562915729158291592916029161291622916329164291652916629167291682916929170291712917229173291742917529176291772917829179291802918129182291832918429185291862918729188291892919029191291922919329194291952919629197291982919929200292012920229203292042920529206292072920829209292102921129212292132921429215292162921729218292192922029221292222922329224292252922629227292282922929230292312923229233292342923529236292372923829239292402924129242292432924429245292462924729248292492925029251292522925329254292552925629257292582925929260292612926229263292642926529266292672926829269292702927129272292732927429275292762927729278292792928029281292822928329284292852928629287292882928929290292912929229293292942929529296292972929829299293002930129302293032930429305293062930729308293092931029311293122931329314293152931629317293182931929320293212932229323293242932529326293272932829329293302933129332293332933429335293362933729338293392934029341293422934329344293452934629347293482934929350293512935229353293542935529356293572935829359293602936129362293632936429365293662936729368293692937029371293722937329374293752937629377293782937929380293812938229383293842938529386293872938829389293902939129392293932939429395293962939729398293992940029401294022940329404294052940629407294082940929410294112941229413294142941529416294172941829419294202942129422294232942429425294262942729428294292943029431294322943329434294352943629437294382943929440294412944229443294442944529446294472944829449294502945129452294532945429455294562945729458294592946029461294622946329464294652946629467294682946929470294712947229473294742947529476294772947829479294802948129482294832948429485294862948729488294892949029491294922949329494294952949629497294982949929500295012950229503295042950529506295072950829509295102951129512295132951429515295162951729518295192952029521295222952329524295252952629527295282952929530295312953229533295342953529536295372953829539295402954129542295432954429545295462954729548295492955029551295522955329554295552955629557295582955929560295612956229563295642956529566295672956829569295702957129572295732957429575295762957729578295792958029581295822958329584295852958629587295882958929590295912959229593295942959529596295972959829599296002960129602296032960429605296062960729608296092961029611296122961329614296152961629617296182961929620296212962229623296242962529626296272962829629296302963129632296332963429635296362963729638296392964029641296422964329644296452964629647296482964929650296512965229653296542965529656296572965829659296602966129662296632966429665296662966729668296692967029671296722967329674296752967629677296782967929680296812968229683296842968529686296872968829689296902969129692296932969429695296962969729698296992970029701297022970329704297052970629707297082970929710297112971229713297142971529716297172971829719297202972129722297232972429725297262972729728297292973029731297322973329734297352973629737297382973929740297412974229743297442974529746297472974829749297502975129752297532975429755297562975729758297592976029761297622976329764297652976629767297682976929770297712977229773297742977529776297772977829779297802978129782297832978429785297862978729788297892979029791297922979329794297952979629797297982979929800298012980229803298042980529806298072980829809298102981129812298132981429815298162981729818298192982029821298222982329824298252982629827298282982929830298312983229833298342983529836298372983829839298402984129842298432984429845298462984729848298492985029851298522985329854298552985629857298582985929860298612986229863298642986529866298672986829869298702987129872298732987429875298762987729878298792988029881298822988329884298852988629887298882988929890298912989229893298942989529896298972989829899299002990129902299032990429905299062990729908299092991029911299122991329914299152991629917299182991929920299212992229923299242992529926299272992829929299302993129932299332993429935299362993729938299392994029941299422994329944299452994629947299482994929950299512995229953299542995529956299572995829959299602996129962299632996429965299662996729968299692997029971299722997329974299752997629977299782997929980299812998229983299842998529986299872998829989299902999129992299932999429995299962999729998299993000030001300023000330004300053000630007300083000930010300113001230013300143001530016300173001830019300203002130022300233002430025300263002730028300293003030031300323003330034300353003630037300383003930040300413004230043300443004530046300473004830049300503005130052300533005430055300563005730058300593006030061300623006330064300653006630067300683006930070300713007230073300743007530076300773007830079300803008130082300833008430085300863008730088300893009030091300923009330094300953009630097300983009930100301013010230103301043010530106301073010830109301103011130112301133011430115301163011730118301193012030121301223012330124301253012630127301283012930130301313013230133301343013530136301373013830139301403014130142301433014430145301463014730148301493015030151301523015330154301553015630157301583015930160301613016230163301643016530166301673016830169301703017130172301733017430175301763017730178301793018030181301823018330184301853018630187301883018930190301913019230193301943019530196301973019830199302003020130202302033020430205302063020730208302093021030211302123021330214302153021630217302183021930220302213022230223302243022530226302273022830229302303023130232302333023430235302363023730238302393024030241302423024330244302453024630247302483024930250302513025230253302543025530256302573025830259302603026130262302633026430265302663026730268302693027030271302723027330274302753027630277302783027930280302813028230283302843028530286302873028830289302903029130292302933029430295302963029730298302993030030301303023030330304303053030630307303083030930310303113031230313303143031530316303173031830319303203032130322303233032430325303263032730328303293033030331303323033330334303353033630337303383033930340303413034230343303443034530346303473034830349303503035130352303533035430355303563035730358303593036030361303623036330364303653036630367303683036930370303713037230373303743037530376303773037830379303803038130382303833038430385303863038730388303893039030391303923039330394303953039630397303983039930400304013040230403304043040530406304073040830409304103041130412304133041430415304163041730418304193042030421304223042330424304253042630427304283042930430304313043230433304343043530436304373043830439304403044130442304433044430445304463044730448304493045030451304523045330454304553045630457304583045930460304613046230463304643046530466304673046830469304703047130472304733047430475304763047730478304793048030481304823048330484304853048630487304883048930490304913049230493304943049530496304973049830499305003050130502305033050430505305063050730508305093051030511305123051330514305153051630517305183051930520305213052230523305243052530526305273052830529305303053130532305333053430535305363053730538305393054030541305423054330544305453054630547305483054930550305513055230553305543055530556305573055830559305603056130562305633056430565305663056730568305693057030571305723057330574305753057630577305783057930580305813058230583305843058530586305873058830589305903059130592305933059430595305963059730598305993060030601306023060330604306053060630607306083060930610306113061230613306143061530616306173061830619306203062130622306233062430625306263062730628306293063030631306323063330634306353063630637306383063930640306413064230643306443064530646306473064830649306503065130652306533065430655306563065730658306593066030661306623066330664306653066630667306683066930670306713067230673306743067530676306773067830679306803068130682306833068430685306863068730688306893069030691306923069330694306953069630697306983069930700307013070230703307043070530706307073070830709307103071130712307133071430715307163071730718307193072030721307223072330724307253072630727307283072930730307313073230733307343073530736307373073830739307403074130742307433074430745307463074730748307493075030751307523075330754307553075630757307583075930760307613076230763307643076530766307673076830769307703077130772307733077430775307763077730778307793078030781307823078330784307853078630787307883078930790307913079230793307943079530796307973079830799308003080130802308033080430805308063080730808308093081030811308123081330814308153081630817308183081930820308213082230823308243082530826308273082830829308303083130832308333083430835308363083730838308393084030841308423084330844308453084630847308483084930850308513085230853308543085530856308573085830859308603086130862308633086430865308663086730868308693087030871308723087330874308753087630877308783087930880308813088230883308843088530886308873088830889308903089130892308933089430895308963089730898308993090030901309023090330904309053090630907309083090930910309113091230913309143091530916309173091830919309203092130922309233092430925309263092730928309293093030931309323093330934309353093630937309383093930940309413094230943309443094530946309473094830949309503095130952309533095430955309563095730958309593096030961309623096330964309653096630967309683096930970309713097230973309743097530976309773097830979309803098130982309833098430985309863098730988309893099030991309923099330994309953099630997309983099931000310013100231003310043100531006310073100831009310103101131012310133101431015310163101731018310193102031021310223102331024310253102631027310283102931030310313103231033310343103531036310373103831039310403104131042310433104431045310463104731048310493105031051310523105331054310553105631057310583105931060310613106231063310643106531066310673106831069310703107131072310733107431075310763107731078310793108031081310823108331084310853108631087310883108931090310913109231093310943109531096310973109831099311003110131102311033110431105311063110731108311093111031111311123111331114311153111631117311183111931120311213112231123311243112531126311273112831129311303113131132311333113431135311363113731138311393114031141311423114331144311453114631147311483114931150311513115231153311543115531156311573115831159311603116131162311633116431165311663116731168311693117031171311723117331174311753117631177311783117931180311813118231183311843118531186311873118831189311903119131192311933119431195311963119731198311993120031201312023120331204312053120631207312083120931210312113121231213312143121531216312173121831219312203122131222312233122431225312263122731228312293123031231312323123331234312353123631237312383123931240312413124231243312443124531246312473124831249312503125131252312533125431255312563125731258312593126031261312623126331264312653126631267312683126931270312713127231273312743127531276312773127831279312803128131282312833128431285312863128731288312893129031291312923129331294312953129631297312983129931300313013130231303313043130531306313073130831309313103131131312313133131431315313163131731318313193132031321313223132331324313253132631327313283132931330313313133231333313343133531336313373133831339313403134131342313433134431345313463134731348313493135031351313523135331354313553135631357313583135931360313613136231363313643136531366313673136831369313703137131372313733137431375313763137731378313793138031381313823138331384313853138631387313883138931390313913139231393313943139531396313973139831399314003140131402314033140431405314063140731408314093141031411314123141331414314153141631417314183141931420314213142231423314243142531426314273142831429314303143131432314333143431435314363143731438314393144031441314423144331444314453144631447314483144931450314513145231453314543145531456314573145831459314603146131462314633146431465314663146731468314693147031471314723147331474314753147631477314783147931480314813148231483314843148531486314873148831489314903149131492314933149431495314963149731498314993150031501315023150331504315053150631507315083150931510315113151231513315143151531516315173151831519315203152131522315233152431525315263152731528315293153031531315323153331534315353153631537315383153931540315413154231543315443154531546315473154831549315503155131552315533155431555315563155731558315593156031561315623156331564315653156631567315683156931570315713157231573315743157531576315773157831579315803158131582315833158431585315863158731588315893159031591315923159331594315953159631597315983159931600316013160231603316043160531606316073160831609316103161131612316133161431615316163161731618316193162031621316223162331624316253162631627316283162931630316313163231633316343163531636316373163831639316403164131642316433164431645316463164731648316493165031651316523165331654316553165631657316583165931660316613166231663316643166531666316673166831669316703167131672316733167431675316763167731678316793168031681316823168331684316853168631687316883168931690316913169231693316943169531696316973169831699317003170131702317033170431705317063170731708317093171031711317123171331714317153171631717317183171931720317213172231723317243172531726317273172831729317303173131732317333173431735317363173731738317393174031741317423174331744317453174631747317483174931750317513175231753317543175531756317573175831759317603176131762317633176431765317663176731768317693177031771317723177331774317753177631777317783177931780317813178231783317843178531786317873178831789317903179131792317933179431795317963179731798317993180031801318023180331804318053180631807318083180931810318113181231813318143181531816318173181831819318203182131822318233182431825318263182731828318293183031831318323183331834318353183631837318383183931840318413184231843318443184531846318473184831849318503185131852318533185431855318563185731858318593186031861318623186331864318653186631867318683186931870318713187231873318743187531876318773187831879318803188131882318833188431885318863188731888318893189031891318923189331894318953189631897318983189931900319013190231903319043190531906319073190831909319103191131912319133191431915319163191731918319193192031921319223192331924319253192631927319283192931930319313193231933319343193531936319373193831939319403194131942319433194431945319463194731948319493195031951319523195331954319553195631957319583195931960319613196231963319643196531966319673196831969319703197131972319733197431975319763197731978319793198031981319823198331984319853198631987319883198931990319913199231993319943199531996319973199831999320003200132002320033200432005320063200732008320093201032011320123201332014320153201632017320183201932020320213202232023320243202532026320273202832029320303203132032320333203432035320363203732038320393204032041320423204332044320453204632047320483204932050320513205232053320543205532056320573205832059320603206132062320633206432065320663206732068320693207032071320723207332074320753207632077320783207932080320813208232083320843208532086320873208832089320903209132092320933209432095320963209732098320993210032101321023210332104321053210632107321083210932110321113211232113321143211532116321173211832119321203212132122321233212432125321263212732128321293213032131321323213332134321353213632137321383213932140321413214232143321443214532146321473214832149321503215132152321533215432155321563215732158321593216032161321623216332164321653216632167321683216932170321713217232173321743217532176321773217832179321803218132182321833218432185321863218732188321893219032191321923219332194321953219632197321983219932200322013220232203322043220532206322073220832209322103221132212322133221432215322163221732218322193222032221322223222332224322253222632227322283222932230322313223232233322343223532236322373223832239322403224132242322433224432245322463224732248322493225032251322523225332254322553225632257322583225932260322613226232263322643226532266322673226832269322703227132272322733227432275322763227732278322793228032281322823228332284322853228632287322883228932290322913229232293322943229532296322973229832299323003230132302323033230432305323063230732308323093231032311323123231332314323153231632317323183231932320323213232232323323243232532326323273232832329323303233132332323333233432335323363233732338323393234032341323423234332344323453234632347323483234932350323513235232353323543235532356323573235832359323603236132362323633236432365323663236732368323693237032371323723237332374323753237632377323783237932380323813238232383323843238532386323873238832389323903239132392323933239432395323963239732398323993240032401324023240332404324053240632407324083240932410324113241232413324143241532416324173241832419324203242132422324233242432425324263242732428324293243032431324323243332434324353243632437324383243932440324413244232443324443244532446324473244832449324503245132452324533245432455324563245732458324593246032461324623246332464324653246632467324683246932470324713247232473324743247532476324773247832479324803248132482324833248432485324863248732488324893249032491324923249332494324953249632497324983249932500325013250232503325043250532506325073250832509325103251132512325133251432515325163251732518325193252032521325223252332524325253252632527325283252932530325313253232533325343253532536325373253832539325403254132542325433254432545325463254732548325493255032551325523255332554325553255632557325583255932560325613256232563325643256532566325673256832569325703257132572325733257432575325763257732578325793258032581325823258332584325853258632587325883258932590325913259232593325943259532596325973259832599326003260132602326033260432605326063260732608326093261032611326123261332614326153261632617326183261932620326213262232623326243262532626326273262832629326303263132632326333263432635326363263732638326393264032641326423264332644326453264632647326483264932650326513265232653326543265532656326573265832659326603266132662326633266432665326663266732668326693267032671326723267332674326753267632677326783267932680326813268232683326843268532686326873268832689326903269132692326933269432695326963269732698326993270032701327023270332704327053270632707327083270932710327113271232713327143271532716327173271832719327203272132722327233272432725327263272732728327293273032731327323273332734327353273632737327383273932740327413274232743327443274532746327473274832749327503275132752327533275432755327563275732758327593276032761327623276332764327653276632767327683276932770327713277232773327743277532776327773277832779327803278132782327833278432785327863278732788327893279032791327923279332794327953279632797327983279932800328013280232803328043280532806328073280832809328103281132812328133281432815328163281732818328193282032821328223282332824328253282632827328283282932830328313283232833328343283532836328373283832839328403284132842328433284432845328463284732848328493285032851328523285332854328553285632857328583285932860328613286232863328643286532866328673286832869328703287132872328733287432875328763287732878328793288032881328823288332884328853288632887328883288932890328913289232893328943289532896328973289832899329003290132902329033290432905329063290732908329093291032911329123291332914329153291632917329183291932920329213292232923329243292532926329273292832929329303293132932329333293432935329363293732938329393294032941329423294332944329453294632947329483294932950329513295232953329543295532956329573295832959329603296132962329633296432965329663296732968329693297032971329723297332974329753297632977329783297932980329813298232983329843298532986329873298832989329903299132992329933299432995329963299732998329993300033001330023300333004330053300633007330083300933010330113301233013330143301533016330173301833019330203302133022330233302433025330263302733028330293303033031330323303333034330353303633037330383303933040330413304233043330443304533046330473304833049330503305133052330533305433055330563305733058330593306033061330623306333064330653306633067330683306933070330713307233073330743307533076330773307833079330803308133082330833308433085330863308733088330893309033091330923309333094330953309633097330983309933100331013310233103331043310533106331073310833109331103311133112331133311433115331163311733118331193312033121331223312333124331253312633127331283312933130331313313233133331343313533136331373313833139331403314133142331433314433145331463314733148331493315033151331523315333154331553315633157331583315933160331613316233163331643316533166331673316833169331703317133172331733317433175331763317733178331793318033181331823318333184331853318633187331883318933190331913319233193331943319533196331973319833199332003320133202332033320433205332063320733208332093321033211332123321333214332153321633217332183321933220332213322233223332243322533226332273322833229332303323133232332333323433235332363323733238332393324033241332423324333244332453324633247332483324933250332513325233253332543325533256332573325833259332603326133262332633326433265332663326733268332693327033271332723327333274332753327633277332783327933280332813328233283332843328533286332873328833289332903329133292332933329433295332963329733298332993330033301333023330333304333053330633307333083330933310333113331233313333143331533316333173331833319333203332133322333233332433325333263332733328333293333033331333323333333334333353333633337333383333933340333413334233343333443334533346333473334833349333503335133352333533335433355333563335733358333593336033361333623336333364333653336633367333683336933370333713337233373333743337533376333773337833379333803338133382333833338433385333863338733388333893339033391333923339333394333953339633397333983339933400334013340233403334043340533406334073340833409334103341133412334133341433415334163341733418334193342033421334223342333424334253342633427334283342933430334313343233433334343343533436334373343833439334403344133442334433344433445334463344733448334493345033451334523345333454334553345633457334583345933460334613346233463334643346533466334673346833469334703347133472334733347433475334763347733478334793348033481334823348333484334853348633487334883348933490334913349233493334943349533496334973349833499335003350133502335033350433505335063350733508335093351033511335123351333514335153351633517335183351933520335213352233523335243352533526335273352833529335303353133532335333353433535335363353733538335393354033541335423354333544335453354633547335483354933550335513355233553335543355533556335573355833559335603356133562335633356433565335663356733568335693357033571335723357333574335753357633577335783357933580335813358233583335843358533586335873358833589335903359133592335933359433595335963359733598335993360033601336023360333604336053360633607336083360933610336113361233613336143361533616336173361833619336203362133622336233362433625336263362733628336293363033631336323363333634336353363633637336383363933640336413364233643336443364533646336473364833649336503365133652336533365433655336563365733658336593366033661336623366333664336653366633667336683366933670336713367233673336743367533676336773367833679336803368133682336833368433685336863368733688336893369033691336923369333694336953369633697336983369933700337013370233703337043370533706337073370833709337103371133712337133371433715337163371733718337193372033721337223372333724337253372633727337283372933730337313373233733337343373533736337373373833739337403374133742337433374433745337463374733748337493375033751337523375333754337553375633757337583375933760337613376233763337643376533766337673376833769337703377133772337733377433775337763377733778337793378033781337823378333784337853378633787337883378933790337913379233793337943379533796337973379833799338003380133802338033380433805338063380733808338093381033811338123381333814338153381633817338183381933820338213382233823338243382533826338273382833829338303383133832338333383433835338363383733838338393384033841338423384333844338453384633847338483384933850338513385233853338543385533856338573385833859338603386133862338633386433865338663386733868338693387033871338723387333874338753387633877338783387933880338813388233883338843388533886338873388833889338903389133892338933389433895338963389733898338993390033901339023390333904339053390633907339083390933910339113391233913339143391533916339173391833919339203392133922339233392433925339263392733928339293393033931339323393333934339353393633937339383393933940339413394233943339443394533946339473394833949339503395133952339533395433955339563395733958339593396033961339623396333964339653396633967339683396933970339713397233973339743397533976339773397833979339803398133982339833398433985339863398733988339893399033991339923399333994339953399633997339983399934000340013400234003340043400534006340073400834009340103401134012340133401434015340163401734018340193402034021340223402334024340253402634027340283402934030340313403234033340343403534036340373403834039340403404134042340433404434045340463404734048340493405034051340523405334054340553405634057340583405934060340613406234063340643406534066340673406834069340703407134072340733407434075340763407734078340793408034081340823408334084340853408634087340883408934090340913409234093340943409534096340973409834099341003410134102341033410434105341063410734108341093411034111341123411334114341153411634117341183411934120341213412234123341243412534126341273412834129341303413134132341333413434135341363413734138341393414034141341423414334144341453414634147341483414934150341513415234153341543415534156341573415834159341603416134162341633416434165341663416734168341693417034171341723417334174341753417634177341783417934180341813418234183341843418534186341873418834189341903419134192341933419434195341963419734198341993420034201342023420334204342053420634207342083420934210342113421234213342143421534216342173421834219342203422134222342233422434225342263422734228342293423034231342323423334234342353423634237342383423934240342413424234243342443424534246342473424834249342503425134252342533425434255342563425734258342593426034261342623426334264342653426634267342683426934270342713427234273342743427534276342773427834279342803428134282342833428434285342863428734288342893429034291342923429334294342953429634297342983429934300343013430234303343043430534306343073430834309343103431134312343133431434315343163431734318343193432034321343223432334324343253432634327343283432934330343313433234333343343433534336343373433834339343403434134342343433434434345343463434734348343493435034351343523435334354343553435634357343583435934360343613436234363343643436534366343673436834369343703437134372343733437434375343763437734378343793438034381343823438334384343853438634387343883438934390343913439234393343943439534396343973439834399344003440134402344033440434405344063440734408344093441034411344123441334414344153441634417344183441934420344213442234423344243442534426344273442834429344303443134432344333443434435344363443734438344393444034441344423444334444344453444634447344483444934450344513445234453344543445534456344573445834459344603446134462344633446434465344663446734468344693447034471344723447334474344753447634477344783447934480344813448234483344843448534486344873448834489344903449134492344933449434495344963449734498344993450034501345023450334504345053450634507345083450934510345113451234513345143451534516345173451834519345203452134522345233452434525345263452734528345293453034531345323453334534345353453634537345383453934540345413454234543345443454534546345473454834549345503455134552345533455434555345563455734558345593456034561345623456334564345653456634567345683456934570345713457234573345743457534576345773457834579345803458134582345833458434585345863458734588345893459034591345923459334594345953459634597345983459934600346013460234603346043460534606346073460834609346103461134612346133461434615346163461734618346193462034621346223462334624346253462634627346283462934630346313463234633346343463534636346373463834639346403464134642346433464434645346463464734648346493465034651346523465334654346553465634657346583465934660346613466234663346643466534666346673466834669346703467134672346733467434675346763467734678346793468034681346823468334684346853468634687346883468934690346913469234693346943469534696346973469834699347003470134702347033470434705347063470734708347093471034711347123471334714347153471634717347183471934720347213472234723347243472534726347273472834729347303473134732347333473434735347363473734738347393474034741347423474334744347453474634747347483474934750347513475234753347543475534756347573475834759347603476134762347633476434765347663476734768347693477034771347723477334774347753477634777347783477934780347813478234783347843478534786347873478834789347903479134792347933479434795347963479734798347993480034801348023480334804348053480634807348083480934810348113481234813348143481534816348173481834819348203482134822348233482434825348263482734828348293483034831348323483334834348353483634837348383483934840348413484234843348443484534846348473484834849348503485134852348533485434855348563485734858348593486034861348623486334864348653486634867348683486934870348713487234873348743487534876348773487834879348803488134882348833488434885348863488734888348893489034891348923489334894348953489634897348983489934900349013490234903349043490534906349073490834909349103491134912349133491434915349163491734918349193492034921349223492334924349253492634927349283492934930349313493234933349343493534936349373493834939349403494134942349433494434945349463494734948349493495034951349523495334954349553495634957349583495934960349613496234963349643496534966349673496834969349703497134972349733497434975349763497734978349793498034981349823498334984349853498634987349883498934990349913499234993349943499534996349973499834999350003500135002350033500435005350063500735008350093501035011350123501335014350153501635017350183501935020350213502235023350243502535026350273502835029350303503135032350333503435035350363503735038350393504035041350423504335044350453504635047350483504935050350513505235053350543505535056350573505835059350603506135062350633506435065350663506735068350693507035071350723507335074350753507635077350783507935080350813508235083350843508535086350873508835089350903509135092350933509435095350963509735098350993510035101351023510335104351053510635107351083510935110351113511235113351143511535116351173511835119351203512135122351233512435125351263512735128351293513035131351323513335134351353513635137351383513935140351413514235143351443514535146351473514835149351503515135152351533515435155351563515735158351593516035161351623516335164351653516635167351683516935170351713517235173351743517535176351773517835179351803518135182351833518435185351863518735188351893519035191351923519335194351953519635197351983519935200352013520235203352043520535206352073520835209352103521135212352133521435215352163521735218352193522035221352223522335224352253522635227352283522935230352313523235233352343523535236352373523835239352403524135242352433524435245352463524735248352493525035251352523525335254352553525635257352583525935260352613526235263352643526535266352673526835269352703527135272352733527435275352763527735278352793528035281352823528335284352853528635287352883528935290352913529235293352943529535296352973529835299353003530135302353033530435305353063530735308353093531035311353123531335314353153531635317353183531935320353213532235323353243532535326353273532835329353303533135332353333533435335353363533735338353393534035341353423534335344353453534635347353483534935350353513535235353353543535535356353573535835359353603536135362353633536435365353663536735368353693537035371353723537335374353753537635377353783537935380353813538235383353843538535386353873538835389353903539135392353933539435395353963539735398353993540035401354023540335404354053540635407354083540935410354113541235413354143541535416354173541835419354203542135422354233542435425354263542735428354293543035431354323543335434354353543635437354383543935440354413544235443354443544535446354473544835449354503545135452354533545435455354563545735458354593546035461354623546335464354653546635467354683546935470354713547235473354743547535476354773547835479354803548135482354833548435485354863548735488354893549035491354923549335494354953549635497354983549935500355013550235503355043550535506355073550835509355103551135512355133551435515355163551735518355193552035521355223552335524355253552635527355283552935530355313553235533355343553535536355373553835539355403554135542355433554435545355463554735548355493555035551355523555335554355553555635557355583555935560355613556235563355643556535566355673556835569355703557135572355733557435575355763557735578355793558035581355823558335584355853558635587355883558935590355913559235593355943559535596355973559835599356003560135602356033560435605356063560735608356093561035611356123561335614356153561635617356183561935620356213562235623356243562535626356273562835629356303563135632356333563435635356363563735638356393564035641356423564335644356453564635647356483564935650356513565235653356543565535656356573565835659356603566135662356633566435665356663566735668356693567035671356723567335674356753567635677356783567935680356813568235683356843568535686356873568835689356903569135692356933569435695356963569735698356993570035701357023570335704357053570635707357083570935710357113571235713357143571535716357173571835719357203572135722357233572435725357263572735728357293573035731357323573335734357353573635737357383573935740357413574235743357443574535746357473574835749357503575135752357533575435755357563575735758357593576035761357623576335764357653576635767357683576935770357713577235773357743577535776357773577835779357803578135782357833578435785357863578735788357893579035791357923579335794357953579635797357983579935800358013580235803358043580535806358073580835809358103581135812358133581435815358163581735818358193582035821358223582335824358253582635827358283582935830358313583235833358343583535836358373583835839358403584135842358433584435845358463584735848358493585035851358523585335854358553585635857358583585935860358613586235863358643586535866358673586835869358703587135872358733587435875358763587735878358793588035881358823588335884358853588635887358883588935890358913589235893358943589535896358973589835899359003590135902359033590435905359063590735908359093591035911359123591335914359153591635917359183591935920359213592235923359243592535926359273592835929359303593135932359333593435935359363593735938359393594035941359423594335944359453594635947359483594935950359513595235953359543595535956359573595835959359603596135962359633596435965359663596735968359693597035971359723597335974359753597635977359783597935980359813598235983359843598535986359873598835989359903599135992359933599435995359963599735998359993600036001360023600336004360053600636007360083600936010360113601236013360143601536016360173601836019360203602136022360233602436025360263602736028360293603036031360323603336034360353603636037360383603936040360413604236043360443604536046360473604836049360503605136052360533605436055360563605736058360593606036061360623606336064360653606636067360683606936070360713607236073360743607536076360773607836079360803608136082360833608436085360863608736088360893609036091360923609336094360953609636097360983609936100361013610236103361043610536106361073610836109361103611136112361133611436115361163611736118361193612036121361223612336124361253612636127361283612936130361313613236133361343613536136361373613836139361403614136142361433614436145361463614736148361493615036151361523615336154361553615636157361583615936160361613616236163361643616536166361673616836169361703617136172361733617436175361763617736178361793618036181361823618336184361853618636187361883618936190361913619236193361943619536196361973619836199362003620136202362033620436205362063620736208362093621036211362123621336214362153621636217362183621936220362213622236223362243622536226362273622836229362303623136232362333623436235362363623736238362393624036241362423624336244362453624636247362483624936250362513625236253362543625536256362573625836259362603626136262362633626436265362663626736268362693627036271362723627336274362753627636277362783627936280362813628236283362843628536286362873628836289362903629136292362933629436295362963629736298362993630036301363023630336304363053630636307363083630936310363113631236313363143631536316363173631836319363203632136322363233632436325363263632736328363293633036331363323633336334363353633636337363383633936340363413634236343363443634536346363473634836349363503635136352363533635436355363563635736358363593636036361363623636336364363653636636367363683636936370363713637236373363743637536376363773637836379363803638136382363833638436385363863638736388363893639036391363923639336394363953639636397363983639936400364013640236403364043640536406364073640836409364103641136412364133641436415364163641736418364193642036421364223642336424364253642636427364283642936430364313643236433364343643536436364373643836439364403644136442364433644436445364463644736448364493645036451364523645336454364553645636457364583645936460364613646236463364643646536466364673646836469364703647136472364733647436475364763647736478364793648036481364823648336484364853648636487364883648936490364913649236493364943649536496364973649836499365003650136502365033650436505365063650736508365093651036511365123651336514365153651636517365183651936520365213652236523365243652536526365273652836529365303653136532365333653436535365363653736538365393654036541365423654336544365453654636547365483654936550365513655236553365543655536556365573655836559365603656136562365633656436565365663656736568365693657036571365723657336574365753657636577365783657936580365813658236583365843658536586365873658836589365903659136592365933659436595365963659736598365993660036601366023660336604366053660636607366083660936610366113661236613366143661536616366173661836619366203662136622366233662436625366263662736628366293663036631366323663336634366353663636637366383663936640366413664236643366443664536646366473664836649366503665136652366533665436655366563665736658366593666036661366623666336664366653666636667366683666936670366713667236673 |
- <!doctype html>
- <html lang="en" class="no-js">
- <head>
-
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width,initial-scale=1">
-
-
-
-
- <link rel="prev" href="../generator/sshkey/">
-
-
- <link rel="next" href="../controller-options/">
-
-
-
-
-
- <link rel="icon" href="../../pictures/eso-round-logo.svg">
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
-
-
-
- <title>API specification - External Secrets Operator</title>
-
-
-
- <link rel="stylesheet" href="../../assets/stylesheets/main.ec1eaa64.min.css">
-
-
- <link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
-
-
-
-
-
-
-
-
-
-
- <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
- <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">
- <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
-
-
-
- <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>
-
-
-
-
-
- <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>
-
- <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
-
-
-
- </head>
-
-
-
-
-
-
-
-
-
- <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
-
-
- <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
- <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
- <label class="md-overlay" for="__drawer"></label>
- <div data-md-component="skip">
-
- </div>
- <div data-md-component="announce">
-
- </div>
-
- <div data-md-color-scheme="default" data-md-component="outdated" hidden>
-
- <aside class="md-banner md-banner--warning">
- <div class="md-banner__inner md-grid md-typeset">
-
- You're not viewing the latest version.
- <a href="../../..">
- <strong>Click here to go to latest.</strong>
- </a>
- </div>
- <script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL("../.."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
- </aside>
-
- </div>
-
-
-
- <header class="md-header" data-md-component="header">
- <nav class="md-header__inner md-grid" aria-label="Header">
- <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
-
- <img src="../../pictures/eso-round-logo.svg" alt="logo">
- </a>
- <label class="md-header__button md-icon" for="__drawer">
-
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
- </label>
- <div class="md-header__title" data-md-component="header-title">
- <div class="md-header__ellipsis">
- <div class="md-header__topic">
- <span class="md-ellipsis">
- External Secrets Operator
- </span>
- </div>
- <div class="md-header__topic" data-md-component="header-topic">
- <span class="md-ellipsis">
-
- API specification
-
- </span>
- </div>
- </div>
- </div>
-
-
- <form class="md-header__option" data-md-component="palette">
-
-
-
-
- <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">
-
- <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
- <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>
- </label>
-
-
-
-
-
- <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">
-
- <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
- <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>
- </label>
-
-
- </form>
-
-
-
- <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>
-
-
-
-
-
- <label class="md-header__button md-icon" for="__search">
-
- <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>
- </label>
- <div class="md-search" data-md-component="search" role="dialog">
- <label class="md-search__overlay" for="__search"></label>
- <div class="md-search__inner" role="search">
- <form class="md-search__form" name="search">
- <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>
- <label class="md-search__icon md-icon" for="__search">
-
- <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>
-
- <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>
- </label>
- <nav class="md-search__options" aria-label="Search">
-
- <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-
- <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>
- </button>
- </nav>
-
- </form>
- <div class="md-search__output">
- <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
- <div class="md-search-result" data-md-component="search-result">
- <div class="md-search-result__meta">
- Initializing search
- </div>
- <ol class="md-search-result__list" role="presentation"></ol>
- </div>
- </div>
- </div>
- </div>
- </div>
-
-
-
- <div class="md-header__source">
- <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
- <div class="md-source__icon md-icon">
-
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
- </div>
- <div class="md-source__repository">
- External Secrets Operator
- </div>
- </a>
- </div>
-
- </nav>
-
- </header>
-
- <div class="md-container" data-md-component="container">
-
-
-
-
-
- <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
- <div class="md-grid">
- <ul class="md-tabs__list">
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../.." class="md-tabs__link">
-
-
-
-
-
- Introduction
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-tabs__item md-tabs__item--active">
- <a href="../components/" class="md-tabs__link">
-
-
-
-
-
- API
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../../guides/introduction/" class="md-tabs__link">
-
-
-
-
-
- Guides
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
-
-
-
-
-
- Provider
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
-
-
-
-
-
- Examples
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../../contributing/devguide/" class="md-tabs__link">
-
-
-
-
-
- Community
- </a>
- </li>
-
-
-
-
-
- </ul>
- </div>
- </nav>
-
-
-
- <main class="md-main" data-md-component="main">
- <div class="md-main__inner md-grid">
-
-
-
- <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
- <div class="md-sidebar__scrollwrap">
- <div class="md-sidebar__inner">
-
-
- <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
- <label class="md-nav__title" for="__drawer">
- <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
-
- <img src="../../pictures/eso-round-logo.svg" alt="logo">
- </a>
- External Secrets Operator
- </label>
-
- <div class="md-nav__source">
- <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
- <div class="md-source__icon md-icon">
-
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
- </div>
- <div class="md-source__repository">
- External Secrets Operator
- </div>
- </a>
- </div>
-
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
-
-
- <div class="md-nav__link md-nav__container">
- <a href="../.." class="md-nav__link ">
-
-
-
- <span class="md-ellipsis">
-
-
- Introduction
-
-
- </span>
-
-
- </a>
-
-
- <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- </div>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_1">
- <span class="md-nav__icon md-icon"></span>
-
-
- Introduction
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/overview/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Overview
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/glossary/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Glossary
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/prerequisites/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Prerequisites
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/getting-started/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Getting started
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/faq/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- FAQ
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/stability-support/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Stability and Support
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/deprecation-policy/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Deprecation Policy
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
-
-
-
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
-
-
- <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
-
-
-
- <span class="md-ellipsis">
-
-
- API
-
-
- </span>
-
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
- <label class="md-nav__title" for="__nav_2">
- <span class="md-nav__icon md-icon"></span>
-
-
- API
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../components/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Components
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
-
-
- <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
-
-
-
- <span class="md-ellipsis">
-
-
- Core Resources
-
-
- </span>
-
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_2_2">
- <span class="md-nav__icon md-icon"></span>
-
-
- Core Resources
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../externalsecret/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- ExternalSecret
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../secretstore/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- SecretStore
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../clustersecretstore/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- ClusterSecretStore
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../clusterexternalsecret/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- ClusterExternalSecret
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../clusterpushsecret/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- ClusterPushSecret
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../pushsecret/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- PushSecret
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
-
-
- <div class="md-nav__link md-nav__container">
- <a href="../generator/" class="md-nav__link ">
-
-
-
- <span class="md-ellipsis">
-
-
- Generators
-
-
- </span>
-
-
- </a>
-
-
- <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- </div>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_2_3">
- <span class="md-nav__icon md-icon"></span>
-
-
- Generators
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/acr/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Azure Container Registry
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/ecr/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- AWS Elastic Container Registry
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/sts/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- AWS STS Session Token
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/cloudsmith/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Cloudsmith
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/cluster/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Cluster Generator
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/gcr/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Google Container Registry
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/grafana/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Grafana
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/quay/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Quay
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/vault/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Vault Dynamic Secret
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/beyondtrustworkloadcredentials/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- BeyondTrust Workload Credentials
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/password/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Password
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/fake/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Fake
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/webhook/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Webhook
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/github/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Github
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/gitlab/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Gitlab
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/uuid/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- UUID
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/mfa/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- MFA
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/sshkey/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- SSHKey
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
-
-
-
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" checked>
-
-
- <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
-
-
-
- <span class="md-ellipsis">
-
-
- Reference Docs
-
-
- </span>
-
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="true">
- <label class="md-nav__title" for="__nav_2_4">
- <span class="md-nav__icon md-icon"></span>
-
-
- Reference Docs
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active">
-
- <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
-
-
-
- <a href="./" class="md-nav__link md-nav__link--active">
-
-
-
- <span class="md-ellipsis">
-
-
- API specification
-
-
- </span>
-
-
- </a>
-
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../controller-options/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Controller Options
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../metrics/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Metrics
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../selectable-fields/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Selectable Fields
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-
-
- <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-
-
-
- <span class="md-ellipsis">
-
-
- Guides
-
-
- </span>
-
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_3">
- <span class="md-nav__icon md-icon"></span>
-
-
- Guides
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/introduction/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Introduction
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
-
-
- <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
-
-
-
- <span class="md-ellipsis">
-
-
- External Secrets
-
-
- </span>
-
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_3_2">
- <span class="md-nav__icon md-icon"></span>
-
-
- External Secrets
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Extract structured data
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/getallsecrets/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Find Secrets by Name or Metadata
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Rewriting Keys
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
-
-
- <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
-
-
-
- <span class="md-ellipsis">
-
-
- Advanced Templating
-
-
- </span>
-
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_3_2_4">
- <span class="md-nav__icon md-icon"></span>
-
-
- Advanced Templating
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/templating/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- v2
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/templating-v1/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- v1
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Kubernetes Secret Types
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Lifecycle: ownership & deletion
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/decoding-strategy/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Decoding Strategies
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/controller-class/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Controller Classes
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/targeting-custom-resources/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Targeting Custom Resources
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/generator/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Generators
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/pushsecrets/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Push Secrets
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
-
-
- <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
-
-
-
- <span class="md-ellipsis">
-
-
- Operations
-
-
- </span>
-
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_3_6">
- <span class="md-nav__icon md-icon"></span>
-
-
- Operations
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/multi-tenancy/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Multi Tenancy
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/security-best-practices/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Security Best Practices
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/threat-model/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Threat Model
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/v1beta1/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Upgrading to v1beta1
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/using-latest-image/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Using Latest Image
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/disable-cluster-features/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Disable Cluster Features
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_7" >
-
-
- <label class="md-nav__link" for="__nav_3_7" id="__nav_3_7_label" tabindex="0">
-
-
-
- <span class="md-ellipsis">
-
-
- Tooling
-
-
- </span>
-
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_7_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_3_7">
- <span class="md-nav__icon md-icon"></span>
-
-
- Tooling
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/using-esoctl-tool/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Using the esoctl tool
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-
-
- <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-
-
-
- <span class="md-ellipsis">
-
-
- Provider
-
-
- </span>
-
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_4">
- <span class="md-nav__icon md-icon"></span>
-
-
- Provider
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- AWS Secrets Manager
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/aws-parameter-store/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- AWS Parameter Store
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/aws-certificate-manager/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- AWS Certificate Manager
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/aws-access/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- AWS Access
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/azure-key-vault/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Azure Key Vault
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/barbican/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Barbican
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/beyondtrust/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- BeyondTrust
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/beyondtrustworkloadcredentials/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- BeyondTrust Workload Credentials
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Bitwarden Secrets Manager
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/chef/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Chef
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/cloudru/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Cloud.ru Secret Manager
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/conjur/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- CyberArk Conjur
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/google-secrets-manager/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Google Cloud Secret Manager
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/hashicorp-vault/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- HashiCorp Vault
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/kubernetes/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Kubernetes
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/crd/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Kubernetes CRD
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- IBM Secrets Manager
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/akeyless/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Akeyless
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Yandex Certificate Manager
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/yandex-lockbox/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Yandex Lockbox
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/gitlab-variables/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- GitLab Variables
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/github/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- GitHub Actions and Dependabot Secrets
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/oracle-vault/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Oracle Vault
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/ovhcloud/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- OVHcloud
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/1password-automation/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- 1Password Connect Server
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/1password-sdk/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- 1Password SDK
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/webhook/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Webhook
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/fake/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Fake
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- senhasegura DevOps Secrets Management (DSM)
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/doppler/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Doppler
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/keeper-security/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Keeper Security
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/cloak/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Cloak End 2 End Encrypted Secrets
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/scaleway/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Scaleway
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/delinea/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Delinea
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/secretserver/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Secret Server
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/passbolt/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Passbolt
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/pulumi/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Pulumi ESC
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/onboardbase/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Onboardbase
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider-passworddepot/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Password Depot
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/fortanix/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Fortanix
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/infisical/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Infisical
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/previder/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Previder
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/openbao/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- OpenBao
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/volcengine/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Volcengine
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/ngrok/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- ngrok
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/devolutions-server/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Devolutions Server
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/nebius-mysterybox/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Nebius MysteryBox
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
-
-
- <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
-
-
-
- <span class="md-ellipsis">
-
-
- Examples
-
-
- </span>
-
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_5">
- <span class="md-nav__icon md-icon"></span>
-
-
- Examples
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- FluxCD
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Anchore Engine
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Jenkins
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../examples/bitwarden/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Bitwarden
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
-
-
- <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
-
-
-
- <span class="md-ellipsis">
-
-
- Community
-
-
- </span>
-
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_6">
- <span class="md-nav__icon md-icon"></span>
-
-
- Community
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
-
-
- <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
-
-
-
- <span class="md-ellipsis">
-
-
- Contributing
-
-
- </span>
-
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_6_1">
- <span class="md-nav__icon md-icon"></span>
-
-
- Contributing
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/devguide/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Developer guide
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/process/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Contributing Process
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/release/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Release Process
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/coc/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Code of Conduct
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/calendar/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Community meetings calendar
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/roadmap/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Roadmap
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/burnout-mitigation/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Burnout Prevention
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/llm-policy/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- LLM Policy
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
-
- <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
-
-
- <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
-
-
-
- <span class="md-ellipsis">
-
-
- External Resources
-
-
- </span>
-
-
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_6_2">
- <span class="md-nav__icon md-icon"></span>
-
-
- External Resources
-
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../eso-talks/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Talks
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../eso-demos/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Demos
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../eso-blogs/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Blogs
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../eso-tools/" class="md-nav__link">
-
-
-
- <span class="md-ellipsis">
-
-
- Tools
-
-
- </span>
-
-
- </a>
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
-
- </ul>
- </nav>
-
- </li>
-
-
- </ul>
- </nav>
- </div>
- </div>
- </div>
-
-
-
- <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
- <div class="md-sidebar__scrollwrap">
- <div class="md-sidebar__inner">
-
- <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-
-
-
-
- </nav>
- </div>
- </div>
- </div>
-
-
-
- <div class="md-content" data-md-component="content">
-
- <article class="md-content__inner md-typeset">
-
-
-
-
- <p>Packages:</p>
- <ul>
- <li>
- <a href="#external-secrets.io%2fv1">external-secrets.io/v1</a>
- </li>
- <li>
- <a href="#external-secrets.io%2fv1alpha1">external-secrets.io/v1alpha1</a>
- </li>
- <li>
- <a href="#external-secrets.io%2fv1beta1">external-secrets.io/v1beta1</a>
- </li>
- <li>
- <a href="#generators.external-secrets.io%2fv1alpha1">generators.external-secrets.io/v1alpha1</a>
- </li>
- </ul>
- <h2 id="external-secrets.io/v1">external-secrets.io/v1</h2>
- <p>
- <p>Package v1 contains resources for external-secrets</p>
- </p>
- <p>Resource Types:</p>
- <ul></ul>
- <h3 id="external-secrets.io/v1.AWSAuth">AWSAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AWSProvider">AWSProvider</a>)
- </p>
- <p>
- <p>AWSAuth tells the controller how to do authentication with aws.
- Only one of secretRef or jwt can be specified.
- if none is specified the controller will load credentials using the aws sdk defaults.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.AWSAuthSecretRef">
- AWSAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="#external-secrets.io/v1.AWSJWTAuth">
- AWSJWTAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AWSAuthSecretRef">AWSAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AWSAuth">AWSAuth</a>)
- </p>
- <p>
- <p>AWSAuthSecretRef holds secret references for AWS credentials
- both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessKeyIDSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessKeyID is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretAccessKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SecretAccessKey is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sessionTokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SessionToken used for authentication
- This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
- 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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AWSJWTAuth">AWSJWTAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AWSAuth">AWSAuth</a>)
- </p>
- <p>
- <p>AWSJWTAuth stores reference to Authenticate against AWS using service account tokens.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AWSProvider">AWSProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>AWSProvider configures a store to sync secrets with AWS.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>service</code></br>
- <em>
- <a href="#external-secrets.io/v1.AWSServiceType">
- AWSServiceType
- </a>
- </em>
- </td>
- <td>
- <p>Service defines which service should be used to fetch the secrets</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.AWSAuth">
- AWSAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth defines the information necessary to authenticate against AWS
- if not set aws sdk will infer credentials from your environment
- 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>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Role is a Role ARN which the provider will assume</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>AWS Region to be used for the provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>additionalRoles</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AdditionalRoles is a chained list of Role ARNs which the provider will sequentially assume before assuming the Role</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>AWS External ID set on assumed IAM roles</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sessionTags</code></br>
- <em>
- <a href="#external-secrets.io/v1.*github.com/external-secrets/external-secrets/apis/externalsecrets/v1.Tag">
- []*github.com/external-secrets/external-secrets/apis/externalsecrets/v1.Tag
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AWS STS assume role session tags</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretsManager</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretsManager">
- SecretsManager
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretsManager defines how the provider behaves when interacting with AWS SecretsManager</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>transitiveTagKeys</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AWS STS assume role transitive session tags. Required when multiple rules are used with the provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sessionTagsPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1.SessionTagsPolicy">
- SessionTagsPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SessionTagsPolicy controls whether and how STS session tags are added when assuming roles.
- None (default): no tags are added.
- Simple: automatically adds esoNamespace (from the ExternalSecret), esoStoreName, and esoStoreKind tags.
- Custom: adds esoNamespace, esoStoreName, and esoStoreKind plus any tags defined in CustomSessionTags.
- Note: the IAM role must have sts:TagSession permission when using Simple or Custom.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>customSessionTags</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CustomSessionTags defines additional STS session tags to include when SessionTagsPolicy is Custom.
- These are merged with the automatically injected esoNamespace, esoStoreName, and esoStoreKind tags.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>prefix</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Prefix adds a prefix to all retrieved values.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AWSServiceType">AWSServiceType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AWSProvider">AWSProvider</a>)
- </p>
- <p>
- <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"CertificateManager"</p></td>
- <td><p>AWSServiceCertificateManager is the AWS Certificate Manager service.
- see: <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html">https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html</a></p>
- </td>
- </tr><tr><td><p>"ParameterStore"</p></td>
- <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore service.
- 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>
- </td>
- </tr><tr><td><p>"SecretsManager"</p></td>
- <td><p>AWSServiceSecretsManager is the AWS SecretsManager service.
- 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>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.AkeylessAuth">AkeylessAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AkeylessProvider">AkeylessProvider</a>)
- </p>
- <p>
- <p>AkeylessAuth configures how the operator authenticates with Akeyless.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.AkeylessAuthSecretRef">
- AkeylessAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Reference to a Secret that contains the details
- to authenticate with Akeyless.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetesAuth</code></br>
- <em>
- <a href="#external-secrets.io/v1.AkeylessKubernetesAuth">
- AkeylessKubernetesAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kubernetes authenticates with Akeyless by passing the ServiceAccount
- token stored in the named Secret resource.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ServiceAccountRef specifies a Kubernetes ServiceAccount used for azure_ad
- authentication on AKS Workload Identity. The operator obtains a federated
- identity token from this ServiceAccount via the TokenRequest API instead
- of using the ESO controller pod identity. Ignored for other access types.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AkeylessAuth">AkeylessAuth</a>)
- </p>
- <p>
- <p>AkeylessAuthSecretRef references a Secret that contains the details
- to authenticate with Akeyless.
- AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessID</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SecretAccessID is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessType</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessTypeParam</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AkeylessKubernetesAuth">AkeylessKubernetesAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AkeylessAuth">AkeylessAuth</a>)
- </p>
- <p>
- <p>AkeylessKubernetesAuth configures Kubernetes authentication with Akeyless.
- It authenticates with Kubernetes ServiceAccount token stored.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>the Akeyless Kubernetes auth-method access-id</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>k8sConfName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Kubernetes-auth configuration name in Akeyless-Gateway</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional service account field containing the name of a kubernetes ServiceAccount.
- If the service account is specified, the service account secret token JWT will be used
- for authenticating with Akeyless. If the service account selector is not supplied,
- the secretRef will be used instead.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
- for authenticating with Akeyless. If a name is specified without a key,
- <code>token</code> is the default. If one is not specified, the one bound to
- the controller will be used.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AkeylessProvider">AkeylessProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>akeylessGWApiURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>ignoreCache</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>IgnoreCache bypasses the Gateway cache for secret reads when true.
- Only relevant when akeylessGWApiURL points to an Akeyless Gateway.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>authSecretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.AkeylessAuth">
- AkeylessAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the operator authenticates with Akeyless.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM/base64 encoded CA bundle used to validate Akeyless Gateway certificate. Only used
- if the AkeylessGWApiURL URL is using HTTPS protocol. If not set the system root certificates
- are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Akeyless Gateway certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AuthorizationProtocol">AuthorizationProtocol
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.WebhookProvider">WebhookProvider</a>)
- </p>
- <p>
- <p>AuthorizationProtocol contains the protocol-specific configuration</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>ntlm</code></br>
- <em>
- <a href="#external-secrets.io/v1.NTLMProtocol">
- NTLMProtocol
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>NTLMProtocol configures the store to use NTLM for auth</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AwsAuthCredentials">AwsAuthCredentials
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.InfisicalAuth">InfisicalAuth</a>)
- </p>
- <p>
- <p>AwsAuthCredentials represents the credentials for AWS authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>identityId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AwsCredentialsConfig">AwsCredentialsConfig
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.GCPWorkloadIdentityFederation">GCPWorkloadIdentityFederation</a>)
- </p>
- <p>
- <p>AwsCredentialsConfig holds the region and the Secret reference which contains the AWS credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>region is for configuring the AWS region to be used.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>awsCredentialsSecretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretReference">
- SecretReference
- </a>
- </em>
- </td>
- <td>
- <p>awsCredentialsSecretRef is the reference to the secret which holds the AWS credentials.
- Secret should be created with below names for keys
- - aws_access_key_id: Access Key ID, which is the unique identifier for the AWS account or the IAM user.
- - aws_secret_access_key: Secret Access Key, which is used to authenticate requests made to AWS services.
- - aws_session_token: Session Token, is the short-lived token to authenticate requests made to AWS services.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AzureAuthCredentials">AzureAuthCredentials
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.InfisicalAuth">InfisicalAuth</a>)
- </p>
- <p>
- <p>AzureAuthCredentials represents the credentials for Azure authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>identityId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>resource</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AzureAuthType">AzureAuthType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AzureKVProvider">AzureKVProvider</a>)
- </p>
- <p>
- <p>AzureAuthType describes how to authenticate to the Azure Keyvault
- Only one of the following auth types may be specified.
- If none of the following auth type is specified, the default one
- is ServicePrincipal.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ManagedIdentity"</p></td>
- <td><p>AzureManagedIdentity uses Managed Identity to authenticate. Used with aad-pod-identity installed in the cluster.</p>
- </td>
- </tr><tr><td><p>"ServicePrincipal"</p></td>
- <td><p>AzureServicePrincipal uses service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.</p>
- </td>
- </tr><tr><td><p>"WorkloadIdentity"</p></td>
- <td><p>AzureWorkloadIdentity uses Workload Identity service accounts to authenticate.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.AzureCustomCloudConfig">AzureCustomCloudConfig
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AzureKVProvider">AzureKVProvider</a>)
- </p>
- <p>
- <p>AzureCustomCloudConfig specifies custom cloud configuration for private Azure environments
- IMPORTANT: Custom cloud configuration is ONLY supported when UseAzureSDK is true.
- The legacy go-autorest SDK does not support custom cloud endpoints.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>activeDirectoryEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ActiveDirectoryEndpoint is the AAD endpoint for authentication
- Required when using custom cloud configuration</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>keyVaultEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>KeyVaultEndpoint is the Key Vault service endpoint</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>keyVaultDNSSuffix</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>KeyVaultDNSSuffix is the DNS suffix for Key Vault URLs</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>resourceManagerEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ResourceManagerEndpoint is the Azure Resource Manager endpoint</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AzureEnvironmentType">AzureEnvironmentType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AzureKVProvider">AzureKVProvider</a>,
- <a href="#generators.external-secrets.io/v1alpha1.ACRAccessTokenSpec">ACRAccessTokenSpec</a>)
- </p>
- <p>
- <p>AzureEnvironmentType specifies the Azure cloud environment endpoints to use for
- connecting and authenticating with Azure. By default, it points to the public cloud AAD endpoint.
- 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>
- PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud, AzureStackCloud</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"AzureStackCloud"</p></td>
- <td></td>
- </tr><tr><td><p>"ChinaCloud"</p></td>
- <td></td>
- </tr><tr><td><p>"GermanCloud"</p></td>
- <td></td>
- </tr><tr><td><p>"PublicCloud"</p></td>
- <td></td>
- </tr><tr><td><p>"USGovernmentCloud"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.AzureKVAuth">AzureKVAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AzureKVProvider">AzureKVProvider</a>)
- </p>
- <p>
- <p>AzureKVAuth is the configuration used to authenticate with Azure.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The Azure clientId of the service principle or managed identity used for authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tenantId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The Azure tenantId of the managed identity used for authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientSecret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The Azure ClientSecret of the service principle used for authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientCertificate</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The Azure ClientCertificate of the service principle used for authentication.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.AzureKVProvider">AzureKVProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>AzureKVProvider configures a store to sync secrets using Azure KV.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>authType</code></br>
- <em>
- <a href="#external-secrets.io/v1.AzureAuthType">
- AzureAuthType
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth type defines how to authenticate to the keyvault service.
- Valid values are:
- - “ServicePrincipal” (default): Using a service principal (tenantId, clientId, clientSecret)
- - “ManagedIdentity”: Using Managed Identity assigned to the pod (see aad-pod-identity)
- - “WorkloadIdentity”: Using a Kubernetes ServiceAccount federated with Entra ID</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vaultUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Vault Url from which the secrets to be fetched from.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tenantId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type. Optional for WorkloadIdentity.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environmentType</code></br>
- <em>
- <a href="#external-secrets.io/v1.AzureEnvironmentType">
- AzureEnvironmentType
- </a>
- </em>
- </td>
- <td>
- <p>EnvironmentType specifies the Azure cloud environment endpoints to use for
- connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
- 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>
- PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud, AzureStackCloud
- Use AzureStackCloud when you need to configure custom Azure Stack Hub or Azure Stack Edge endpoints.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>authSecretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.AzureKVAuth">
- AzureKVAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type. Optional for WorkloadIdentity.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ServiceAccountRef specified the service account
- that should be used when authenticating with WorkloadIdentity.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>identityId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>useAzureSDK</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>UseAzureSDK enables the use of the new Azure SDK for Go (azcore-based) instead of the legacy go-autorest SDK.
- This is experimental and may have behavioral differences. Defaults to false (legacy SDK).</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>customCloudConfig</code></br>
- <em>
- <a href="#external-secrets.io/v1.AzureCustomCloudConfig">
- AzureCustomCloudConfig
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CustomCloudConfig defines custom Azure endpoints for non-standard clouds.
- Required when EnvironmentType is AzureStackCloud.
- Optional for other environment types - useful for Azure China when using Workload Identity
- with AKS, where the OIDC issuer (login.partner.microsoftonline.cn) differs from the
- standard China Cloud endpoint (login.chinacloudapi.cn).
- IMPORTANT: This feature REQUIRES UseAzureSDK to be set to true. Custom cloud
- configuration is not supported with the legacy go-autorest SDK.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BarbicanAuth">BarbicanAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.BarbicanProvider">BarbicanProvider</a>)
- </p>
- <p>
- <p>BarbicanAuth contains the authentication information for Barbican.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- <a href="#external-secrets.io/v1.BarbicanProviderUsernameRef">
- BarbicanProviderUsernameRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>password</code></br>
- <em>
- <a href="#external-secrets.io/v1.BarbicanProviderPasswordRef">
- BarbicanProviderPasswordRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BarbicanProvider">BarbicanProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>BarbicanProvider setup a store to sync secrets with barbican.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>authURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>tenantName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>domainName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.BarbicanAuth">
- BarbicanAuth
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BarbicanProviderPasswordRef">BarbicanProviderPasswordRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.BarbicanAuth">BarbicanAuth</a>)
- </p>
- <p>
- <p>BarbicanProviderPasswordRef defines a reference to a secret containing password for the Barbican provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BarbicanProviderUsernameRef">BarbicanProviderUsernameRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.BarbicanAuth">BarbicanAuth</a>)
- </p>
- <p>
- <p>BarbicanProviderUsernameRef defines a reference to a secret containing username for the Barbican provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BeyondTrustProviderSecretRef">BeyondTrustProviderSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.BeyondtrustAuth">BeyondtrustAuth</a>)
- </p>
- <p>
- <p>BeyondTrustProviderSecretRef references a value that can be specified directly or via a secret
- for a BeyondTrustProvider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Value can be specified directly to set a value without using a secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef references a key in a secret that will be used as value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BeyondtrustAuth">BeyondtrustAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.BeyondtrustProvider">BeyondtrustProvider</a>)
- </p>
- <p>
- <p>BeyondtrustAuth provides different ways to authenticate to a BeyondtrustProvider server.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiKey</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondTrustProviderSecretRef">
- BeyondTrustProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>APIKey If not provided then ClientID/ClientSecret become required.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientId</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondTrustProviderSecretRef">
- BeyondTrustProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>ClientID is the API OAuth Client ID.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientSecret</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondTrustProviderSecretRef">
- BeyondTrustProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>ClientSecret is the API OAuth Client Secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>certificate</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondTrustProviderSecretRef">
- BeyondTrustProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>Certificate (cert.pem) for use when authenticating with an OAuth client Id using a Client Certificate.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>certificateKey</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondTrustProviderSecretRef">
- BeyondTrustProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>Certificate private key (key.pem). For use when authenticating with an OAuth client Id</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BeyondtrustProvider">BeyondtrustProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>BeyondtrustProvider provides access to a BeyondTrust secrets provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondtrustAuth">
- BeyondtrustAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the operator authenticates with Beyondtrust.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>server</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondtrustServer">
- BeyondtrustServer
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how API server works.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BeyondtrustServer">BeyondtrustServer
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.BeyondtrustProvider">BeyondtrustProvider</a>)
- </p>
- <p>
- <p>BeyondtrustServer configures a store to sync secrets using BeyondTrust Password Safe.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>apiVersion</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrievalType</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The secret retrieval type. SECRET = Secrets Safe (credential, text, file). MANAGED_ACCOUNT = Password Safe account associated with a system.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>separator</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>A character that separates the folder names.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>decrypt</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>When true, the response includes the decrypted password. When false, the password field is omitted. This option only applies to the SECRET retrieval type. Default: true.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>verifyCA</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientTimeOutSeconds</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BeyondtrustWorkloadCredentialsAuth">BeyondtrustWorkloadCredentialsAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.BeyondtrustWorkloadCredentialsProvider">BeyondtrustWorkloadCredentialsProvider</a>)
- </p>
- <p>
- <p>BeyondtrustWorkloadCredentialsAuth defines the authentication method for the BeyondTrust Workload Credentials provider.
- Currently supports API key authentication via Kubernetes secret reference.
- For authentication documentation, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api#authentication">https://docs.beyondtrust.com/bt-docs/docs/secrets-api#authentication</a></p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apikey</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondtrustWorkloadCredentialsAuthSecretRef">
- BeyondtrustWorkloadCredentialsAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>APIKey configures API token authentication for BeyondTrust Workload Credentials.
- The token is retrieved from a Kubernetes secret and used as a Bearer token for API requests.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BeyondtrustWorkloadCredentialsAuthSecretRef">BeyondtrustWorkloadCredentialsAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.BeyondtrustWorkloadCredentialsAuth">BeyondtrustWorkloadCredentialsAuth</a>)
- </p>
- <p>
- <p>BeyondtrustWorkloadCredentialsAuthSecretRef defines a reference to a secret containing credentials for the BeyondTrust Workload Credentials provider.
- The nested structure supports multiple authentication methods (currently only API token is supported).
- For more information on authentication, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api#authentication">https://docs.beyondtrust.com/bt-docs/docs/secrets-api#authentication</a></p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>token</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Token references the Kubernetes secret containing the BeyondTrust Workload Credentials API token.
- The secret should contain the API key used to authenticate with BeyondTrust Workload Credentials.
- Create an API token in your BeyondTrust Workload Credentials console and store it in a Kubernetes secret.
- For details on creating API tokens, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api#authentication">https://docs.beyondtrust.com/bt-docs/docs/secrets-api#authentication</a></p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BeyondtrustWorkloadCredentialsProvider">BeyondtrustWorkloadCredentialsProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>,
- <a href="#generators.external-secrets.io/v1alpha1.BeyondtrustWorkloadCredentialsDynamicSecretSpec">BeyondtrustWorkloadCredentialsDynamicSecretSpec</a>)
- </p>
- <p>
- <p>BeyondtrustWorkloadCredentialsProvider configures a store to sync secrets using the BeyondTrust Workload Credentials provider.
- BeyondTrust Workload Credentials provides secure storage for static secrets and dynamic credential generation.
- This provider supports reading secrets and generating dynamic credentials (e.g., temporary AWS credentials).
- For complete documentation, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api">https://docs.beyondtrust.com/bt-docs/docs/secrets-api</a></p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondtrustWorkloadCredentialsAuth">
- BeyondtrustWorkloadCredentialsAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the Operator authenticates with the BeyondTrust Workload Credentials API.
- Currently supports API key authentication via Kubernetes secret reference.
- For authentication setup, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api#authentication">https://docs.beyondtrust.com/bt-docs/docs/secrets-api#authentication</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>server</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondtrustWorkloadCredentialsServer">
- BeyondtrustWorkloadCredentialsServer
- </a>
- </em>
- </td>
- <td>
- <p>Server configures the BeyondTrust Workload Credentials server connection details.
- Includes the API URL and Site ID for your BeyondTrust instance.
- For API reference, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api">https://docs.beyondtrust.com/bt-docs/docs/secrets-api</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>folderPath</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>FolderPath specifies the default folder path for secret retrieval.
- Secrets will be fetched from this folder unless overridden in the ExternalSecret spec.
- Example: “production/database” or “dev/api-keys”
- Leave empty to retrieve secrets from the root folder.
- For folder organization, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api#folders">https://docs.beyondtrust.com/bt-docs/docs/secrets-api#folders</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CABundle is a base64-encoded CA certificate used to validate the BeyondTrust Workload Credentials API TLS certificate.
- Use this when your BeyondTrust instance uses a self-signed certificate or internal CA.
- If not set, the system’s trusted root certificates are used.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CAProvider points to a Secret or ConfigMap containing a PEM-encoded CA certificate.
- This is used to validate the BeyondTrust Workload Credentials API TLS certificate.
- Use this as an alternative to CABundle when you want to reference an existing Kubernetes resource.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BeyondtrustWorkloadCredentialsServer">BeyondtrustWorkloadCredentialsServer
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.BeyondtrustWorkloadCredentialsProvider">BeyondtrustWorkloadCredentialsProvider</a>)
- </p>
- <p>
- <p>BeyondtrustWorkloadCredentialsServer defines connection configuration for BeyondTrust Workload Credentials.
- For API reference documentation, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api">https://docs.beyondtrust.com/bt-docs/docs/secrets-api</a></p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>APIURL is the base URL of your BeyondTrust Workload Credentials API server.
- This should be the full URL to your BeyondTrust instance.
- Example: <a href="https://api.beyondtrust.io/siie">https://api.beyondtrust.io/siie</a>
- For more information, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api#base-url">https://docs.beyondtrust.com/bt-docs/docs/secrets-api#base-url</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>siteId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>SiteID is your BeyondTrust Workload Credentials site identifier (UUID format).
- This identifier is unique to your BeyondTrust Workload Credentials instance.
- You can find your Site ID in the BeyondTrust Workload Credentials admin console.
- Example: a1b2c3d4-e5f6-4890-abcd-ef1234567890
- For more information, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api">https://docs.beyondtrust.com/bt-docs/docs/secrets-api</a></p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BitwardenSecretsManagerAuth">BitwardenSecretsManagerAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.BitwardenSecretsManagerProvider">BitwardenSecretsManagerProvider</a>)
- </p>
- <p>
- <p>BitwardenSecretsManagerAuth contains the ref to the secret that contains the machine account token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.BitwardenSecretsManagerSecretRef">
- BitwardenSecretsManagerSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BitwardenSecretsManagerProvider">BitwardenSecretsManagerProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>BitwardenSecretsManagerProvider configures a store to sync secrets with a Bitwarden Secrets Manager instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>identityURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>bitwardenServerSDKURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Base64 encoded certificate for the bitwarden server sdk. The sdk MUST run with HTTPS to make sure no MITM attack
- can be performed.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>organizationID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>OrganizationID determines which organization this secret store manages.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectID determines which project this secret store manages.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.BitwardenSecretsManagerAuth">
- BitwardenSecretsManagerAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with a bitwarden machine account instance.
- Make sure that the token being used has permissions on the given secret.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.BitwardenSecretsManagerSecretRef">BitwardenSecretsManagerSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.BitwardenSecretsManagerAuth">BitwardenSecretsManagerAuth</a>)
- </p>
- <p>
- <p>BitwardenSecretsManagerSecretRef contains the credential ref to the bitwarden instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>credentials</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>AccessToken used for the bitwarden instance.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ByID">ByID
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.FetchingPolicy">FetchingPolicy</a>)
- </p>
- <p>
- <p>ByID configures the provider to interpret the <code>data.secretKey.remoteRef.key</code> field in ExternalSecret as secret ID.</p>
- </p>
- <h3 id="external-secrets.io/v1.ByName">ByName
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.FetchingPolicy">FetchingPolicy</a>)
- </p>
- <p>
- <p>ByName configures the provider to interpret the <code>data.secretKey.remoteRef.key</code> field in ExternalSecret as secret name.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>folderID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The folder to fetch secrets from</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.CAProvider">CAProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AkeylessProvider">AkeylessProvider</a>,
- <a href="#external-secrets.io/v1.BeyondtrustWorkloadCredentialsProvider">BeyondtrustWorkloadCredentialsProvider</a>,
- <a href="#external-secrets.io/v1.BitwardenSecretsManagerProvider">BitwardenSecretsManagerProvider</a>,
- <a href="#external-secrets.io/v1.ConjurProvider">ConjurProvider</a>,
- <a href="#external-secrets.io/v1.GitlabProvider">GitlabProvider</a>,
- <a href="#external-secrets.io/v1.InfisicalProvider">InfisicalProvider</a>,
- <a href="#external-secrets.io/v1.KubernetesServer">KubernetesServer</a>,
- <a href="#external-secrets.io/v1.OpenBaoProvider">OpenBaoProvider</a>,
- <a href="#external-secrets.io/v1.OvhClientMTLS">OvhClientMTLS</a>,
- <a href="#external-secrets.io/v1.PassboltProvider">PassboltProvider</a>,
- <a href="#external-secrets.io/v1.SecretServerProvider">SecretServerProvider</a>,
- <a href="#external-secrets.io/v1.VaultProvider">VaultProvider</a>)
- </p>
- <p>
- <p>CAProvider provides a custom certificate authority for accessing the provider’s store.
- The CAProvider points to a Secret or ConfigMap resource that contains a PEM-encoded certificate.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1.CAProviderType">
- CAProviderType
- </a>
- </em>
- </td>
- <td>
- <p>The type of provider to use such as “Secret”, or “ConfigMap”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The name of the object located at the provider type.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The key where the CA certificate can be found in the Secret or ConfigMap.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The namespace the Provider type is in.
- Can only be defined when used in a ClusterSecretStore.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.CAProviderType">CAProviderType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.CAProvider">CAProvider</a>)
- </p>
- <p>
- <p>CAProviderType defines the type of provider for certificate authority.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ConfigMap"</p></td>
- <td><p>CAProviderTypeConfigMap indicates that the CA certificate is stored in a ConfigMap resource.</p>
- </td>
- </tr><tr><td><p>"Secret"</p></td>
- <td><p>CAProviderTypeSecret indicates that the CA certificate is stored in a Secret resource.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.CRDProvider">CRDProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>CRDProvider configures a store to fetch data from arbitrary Kubernetes
- resources, including both custom resources (CRDs) and core API resources
- (e.g. ConfigMap, addressed by setting resource.group to “”). Kubernetes
- Secrets are intentionally blocked; use the Kubernetes provider for those.</p>
- <h1>Authentication modes</h1>
- <p>In-cluster: set auth.serviceAccount and omit server. The server URL defaults
- to the in-cluster API (kubernetes.default) and the controller mints a
- short-lived token for the referenced ServiceAccount to read CRDs locally.</p>
- <p>Remote cluster: set server plus auth (serviceAccount, token, or cert) or
- authRef (a kubeconfig Secret), exactly like the Kubernetes provider.</p>
- <h1>Remote reference keys</h1>
- <ul>
- <li>SecretStore: the key is the object name only; ‘/’ is not allowed. The API
- namespace is always the store namespace, never part of the key.</li>
- <li>ClusterSecretStore: use “namespace/objectName” to read a namespaced CR;
- a key without ‘/’ addresses a cluster-scoped CR by object name. For
- dataFrom Find with a namespaced kind, listing spans all namespaces and
- result keys are “namespace/objectName”.</li>
- </ul>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>server</code></br>
- <em>
- <a href="#external-secrets.io/v1.KubernetesServer">
- KubernetesServer
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Server configures the Kubernetes API address and TLS trust, same as the
- Kubernetes provider. When omitted, the URL defaults to the in-cluster API.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.KubernetesAuth">
- KubernetesAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth configures authentication to the Kubernetes API, same as the
- Kubernetes provider. Required when Server.URL is set (unless using AuthRef).</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>authRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AuthRef references a Secret containing a kubeconfig. Same semantics as the
- Kubernetes provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>resource</code></br>
- <em>
- <a href="#external-secrets.io/v1.CRDProviderResource">
- CRDProviderResource
- </a>
- </em>
- </td>
- <td>
- <p>Resource identifies the CRD by its API group, version and kind.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>whitelist</code></br>
- <em>
- <a href="#external-secrets.io/v1.CRDProviderWhitelist">
- CRDProviderWhitelist
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Whitelist optionally restricts which object names and requested properties
- are allowed to be read.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.CRDProviderResource">CRDProviderResource
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.CRDProvider">CRDProvider</a>)
- </p>
- <p>
- <p>CRDProviderResource identifies a Kubernetes resource (CRD or core) by its
- full API coordinates: group, version and kind.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>group</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Group is the API group of the resource. Use “” (empty string) for core
- Kubernetes resources such as ConfigMap; use e.g. “config.example.io”
- for a CRD. The field is required to be present in the manifest — write
- <code>group: ""</code> explicitly for core resources so typos fail at admission
- time rather than later at discovery.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>version</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Version is the API version of the resource (e.g. “v1alpha1”).</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kind</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Kind is the Kubernetes resource kind (e.g. “MyCustomResource”).</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.CRDProviderWhitelist">CRDProviderWhitelist
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.CRDProvider">CRDProvider</a>)
- </p>
- <p>
- <p>CRDProviderWhitelist configures allow-list rules for CRD reads.
- If any rules are present, a request must satisfy ALL non-empty filters of at
- least one rule; requests that match no rule are denied.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>rules</code></br>
- <em>
- <a href="#external-secrets.io/v1.CRDProviderWhitelistRule">
- []CRDProviderWhitelistRule
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Rules is a list of allow rules. If rules are set, at least one rule must
- match for a request to be allowed.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.CRDProviderWhitelistRule">CRDProviderWhitelistRule
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.CRDProviderWhitelist">CRDProviderWhitelist</a>)
- </p>
- <p>
- <p>CRDProviderWhitelistRule defines a single allow rule for CRD reads.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Name is an optional regular expression matched against the bare object name.
- For both SecretStore and ClusterSecretStore this is always the object name
- without any namespace prefix (e.g. “my-db-spec”, not “prod/my-db-spec”).</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Namespace is an optional regular expression matched against the namespace of
- the object. Applies only when a ClusterSecretStore is used; it is ignored
- for SecretStore (where the namespace is fixed to the store namespace).</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>properties</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Properties is an optional list of regular expressions matched against
- requested property keys (for example: “spec.secretValue”).</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.CSMAuth">CSMAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.CloudruSMProvider">CloudruSMProvider</a>)
- </p>
- <p>
- <p>CSMAuth contains a secretRef for credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.CSMAuthSecretRef">
- CSMAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.CSMAuthSecretRef">CSMAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.CSMAuth">CSMAuth</a>)
- </p>
- <p>
- <p>CSMAuthSecretRef holds secret references for Cloud.ru credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessKeyIDSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessKeyID is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessKeySecretSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessKeySecret is used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.CacheConfig">CacheConfig
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OnePasswordSDKProvider">OnePasswordSDKProvider</a>)
- </p>
- <p>
- <p>CacheConfig configures client-side caching for read operations.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>ttl</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>TTL is the time-to-live for cached secrets.
- Format: duration string (e.g., “5m”, “1h”, “30s”)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>maxSize</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>MaxSize is the maximum number of secrets to cache.
- When the cache is full, least-recently-used entries are evicted.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.CertAuth">CertAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.KubernetesAuth">KubernetesAuth</a>)
- </p>
- <p>
- <p>CertAuth defines certificate-based authentication configuration for Kubernetes.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientCert</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientKey</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ChefAuth">ChefAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ChefProvider">ChefProvider</a>)
- </p>
- <p>
- <p>ChefAuth contains a secretRef for credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.ChefAuthSecretRef">
- ChefAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ChefAuthSecretRef">ChefAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ChefAuth">ChefAuth</a>)
- </p>
- <p>
- <p>ChefAuthSecretRef holds secret references for chef server login credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>privateKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>SecretKey is the Signing Key in PEM format, used for authentication.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ChefProvider">ChefProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>ChefProvider configures a store to sync secrets using basic chef server connection credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.ChefAuth">
- ChefAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against chef Server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>UserName should be the user ID on the chef server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serverUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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 “/”</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.CloudruSMProvider">CloudruSMProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>CloudruSMProvider configures a store to sync secrets using the Cloud.ru Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.CSMAuth">
- CSMAuth
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectID is the project, which the secrets are stored in.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ClusterExternalSecret">ClusterExternalSecret
- </h3>
- <p>
- <p>ClusterExternalSecret is the Schema for the clusterexternalsecrets API.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1.ClusterExternalSecretSpec">
- ClusterExternalSecretSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>externalSecretSpec</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretSpec">
- ExternalSecretSpec
- </a>
- </em>
- </td>
- <td>
- <p>The spec for the ExternalSecrets to be created</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalSecretName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The name of the external secrets to be created.
- Defaults to the name of the ClusterExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalSecretMetadata</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretMetadata">
- ExternalSecretMetadata
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The metadata of the external secrets to be created</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceSelector</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
- Kubernetes meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
- <p>Deprecated: Use NamespaceSelectors instead.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceSelectors</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#*k8s.io/apimachinery/pkg/apis/meta/v1.labelselector--">
- []*k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>A list of labels to select by to find the Namespaces to create the ExternalSecrets in. The selectors are ORed.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaces</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Choose namespaces by name. This field is ORed with anything that NamespaceSelectors ends up choosing.</p>
- <p>Deprecated: Use NamespaceSelectors instead.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshTime</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1.ClusterExternalSecretStatus">
- ClusterExternalSecretStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ClusterExternalSecretConditionType">ClusterExternalSecretConditionType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition</a>)
- </p>
- <p>
- <p>ClusterExternalSecretConditionType defines a value type for ClusterExternalSecret conditions.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Ready"</p></td>
- <td><p>ClusterExternalSecretReady is a ClusterExternalSecretConditionType set when the ClusterExternalSecret is ready.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ClusterExternalSecretNamespaceFailure">ClusterExternalSecretNamespaceFailure
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
- </p>
- <p>
- <p>ClusterExternalSecretNamespaceFailure represents a failed namespace deployment and it’s reason.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Namespace is the namespace that failed when trying to apply an ExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>reason</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Reason is why the ExternalSecret failed to apply to the namespace</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ClusterExternalSecretSpec">ClusterExternalSecretSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ClusterExternalSecret">ClusterExternalSecret</a>)
- </p>
- <p>
- <p>ClusterExternalSecretSpec defines the desired state of ClusterExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>externalSecretSpec</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretSpec">
- ExternalSecretSpec
- </a>
- </em>
- </td>
- <td>
- <p>The spec for the ExternalSecrets to be created</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalSecretName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The name of the external secrets to be created.
- Defaults to the name of the ClusterExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalSecretMetadata</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretMetadata">
- ExternalSecretMetadata
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The metadata of the external secrets to be created</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceSelector</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
- Kubernetes meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
- <p>Deprecated: Use NamespaceSelectors instead.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceSelectors</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#*k8s.io/apimachinery/pkg/apis/meta/v1.labelselector--">
- []*k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>A list of labels to select by to find the Namespaces to create the ExternalSecrets in. The selectors are ORed.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaces</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Choose namespaces by name. This field is ORed with anything that NamespaceSelectors ends up choosing.</p>
- <p>Deprecated: Use NamespaceSelectors instead.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshTime</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ClusterExternalSecretStatus">ClusterExternalSecretStatus
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ClusterExternalSecret">ClusterExternalSecret</a>)
- </p>
- <p>
- <p>ClusterExternalSecretStatus defines the observed state of ClusterExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>externalSecretName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ExternalSecretName is the name of the ExternalSecrets created by the ClusterExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>failedNamespaces</code></br>
- <em>
- <a href="#external-secrets.io/v1.ClusterExternalSecretNamespaceFailure">
- []ClusterExternalSecretNamespaceFailure
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Failed namespaces are the namespaces that failed to apply an ExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provisionedNamespaces</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ProvisionedNamespaces are the namespaces where the ClusterExternalSecret has secrets</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1.ClusterExternalSecretStatusCondition">
- []ClusterExternalSecretStatusCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
- </p>
- <p>
- <p>ClusterExternalSecretStatusCondition defines the observed state of a ClusterExternalSecret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1.ClusterExternalSecretConditionType">
- ClusterExternalSecretConditionType
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
- Kubernetes core/v1.ConditionStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>message</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ClusterSecretStore">ClusterSecretStore
- </h3>
- <p>
- <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreSpec">
- SecretStoreSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
- The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provider</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">
- SecretStoreProvider
- </a>
- </em>
- </td>
- <td>
- <p>Used to configure the provider. Only one provider may be set</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrySettings</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreRetrySettings">
- SecretStoreRetrySettings
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure HTTP retries on failures.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- k8s.io/apimachinery/pkg/util/intstr.IntOrString
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure store refresh interval. Accepts either an integer number
- of seconds (legacy) or a Go duration string such as “1h” or “5m”. Empty or
- 0 will default to the controller config.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1.ClusterSecretStoreCondition">
- []ClusterSecretStoreCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to constrain a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreStatus">
- SecretStoreStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ClusterSecretStoreCondition">ClusterSecretStoreCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreSpec">SecretStoreSpec</a>)
- </p>
- <p>
- <p>ClusterSecretStoreCondition describes a condition by which to choose namespaces to process ExternalSecrets in
- for a ClusterSecretStore instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>namespaceSelector</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
- Kubernetes meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Choose namespace using a labelSelector</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaces</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Choose namespaces by name</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceRegexes</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Choose namespaces by using regex matching</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ConfigMapReference">ConfigMapReference
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.GCPWorkloadIdentityFederation">GCPWorkloadIdentityFederation</a>)
- </p>
- <p>
- <p>ConfigMapReference holds the details of a configmap.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>name of the configmap.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>namespace in which the configmap exists. If empty, configmap will looked up in local namespace.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>key name holding the external account credential config.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ConjurAPIKey">ConjurAPIKey
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ConjurAuth">ConjurAuth</a>)
- </p>
- <p>
- <p>ConjurAPIKey contains references to a Secret resource that holds
- the Conjur username and API key.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>account</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Account is the Conjur organization account name.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>userRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>A reference to a specific ‘key’ containing the Conjur username
- within a Secret resource. In some instances, <code>key</code> is a required field.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>apiKeyRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>A reference to a specific ‘key’ containing the Conjur API key
- within a Secret resource. In some instances, <code>key</code> is a required field.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ConjurAuth">ConjurAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ConjurProvider">ConjurProvider</a>)
- </p>
- <p>
- <p>ConjurAuth is the way to provide authentication credentials to the ConjurProvider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apikey</code></br>
- <em>
- <a href="#external-secrets.io/v1.ConjurAPIKey">
- ConjurAPIKey
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Authenticates with Conjur using an API key.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="#external-secrets.io/v1.ConjurJWT">
- ConjurJWT
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Jwt enables JWT authentication using Kubernetes service account tokens.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>cert</code></br>
- <em>
- <a href="#external-secrets.io/v1.ConjurCert">
- ConjurCert
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Cert enables certificate-based authentication using a client certificate and key.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ConjurCert">ConjurCert
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ConjurAuth">ConjurAuth</a>)
- </p>
- <p>
- <p>ConjurCert defines the Cert authentication configuration for Conjur provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>account</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Account is the Conjur organization account name.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The conjur authn cert webservice id</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>hostId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional HostID for cert authentication (can be omitted when using ‘spiffe’ mode).</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientCertRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>ClientCertRef is a reference to a specific ‘key’ containing the client certificate
- within a Secret resource. The certificate must be PEM-encoded.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientKeyRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>ClientKeyRef is a reference to a specific ‘key’ containing the private RSA client key
- within a Secret resource. The key must be PEM-encoded.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ConjurJWT">ConjurJWT
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ConjurAuth">ConjurAuth</a>)
- </p>
- <p>
- <p>ConjurJWT defines the JWT authentication configuration for Conjur provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>account</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Account is the Conjur organization account name.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The conjur authn jwt webservice id</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>hostId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional HostID for JWT authentication. This may be used depending
- on how the Conjur JWT authenticator policy is configured.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
- authenticate with Conjur using the JWT authentication method.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional ServiceAccountRef specifies the Kubernetes service account for which to request
- a token for with the <code>TokenRequest</code> API.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ConjurProvider">ConjurProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>ConjurProvider provides access to a Conjur provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL is the endpoint of the Conjur instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CABundle is a PEM encoded CA bundle that will be used to validate the Conjur server certificate.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to provide custom certificate authority (CA) certificates
- for a secret store. The CAProvider points to a Secret or ConfigMap resource
- that contains a PEM-encoded certificate.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.ConjurAuth">
- ConjurAuth
- </a>
- </em>
- </td>
- <td>
- <p>Defines authentication settings for connecting to Conjur.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.DVLSAuth">DVLSAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.DVLSProvider">DVLSProvider</a>)
- </p>
- <p>
- <p>DVLSAuth defines the authentication method for the DVLS provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.DVLSAuthSecretRef">
- DVLSAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>SecretRef contains the Application ID and Application Secret for authentication.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.DVLSAuthSecretRef">DVLSAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.DVLSAuth">DVLSAuth</a>)
- </p>
- <p>
- <p>DVLSAuthSecretRef defines the secret references for DVLS authentication credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>appId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>AppID is the reference to the secret containing the Application ID.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>appSecret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>AppSecret is the reference to the secret containing the Application Secret.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.DVLSProvider">DVLSProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>DVLSProvider configures a store to sync secrets using Devolutions Server.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serverUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ServerURL is the DVLS instance URL (e.g., <a href="https://dvls.example.com">https://dvls.example.com</a>).</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vault</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Vault is the name or UUID of the vault to fetch secrets from.
- When omitted, the vault must be specified in the secret key using the legacy format “<vault-id>/<entry-id>”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>insecure</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Insecure allows connecting to DVLS over plain HTTP.
- This is NOT RECOMMENDED for production use.
- Set to true only if you understand the security implications.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.DVLSAuth">
- DVLSAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the authentication method to use.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.DelineaProvider">DelineaProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>DelineaProvider provides access to Delinea secrets vault Server.
- 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>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientId</code></br>
- <em>
- <a href="#external-secrets.io/v1.DelineaProviderSecretRef">
- DelineaProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>ClientID is the non-secret part of the credential.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientSecret</code></br>
- <em>
- <a href="#external-secrets.io/v1.DelineaProviderSecretRef">
- DelineaProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>ClientSecret is the secret part of the credential.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tenant</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Tenant is the chosen hostname / site name.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>urlTemplate</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>URLTemplate
- If unset, defaults to “https://%s.secretsvaultcloud.%s/v1/%s%s”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tld</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>TLD is based on the server location that was chosen during provisioning.
- If unset, defaults to “com”.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.DelineaProviderSecretRef">DelineaProviderSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.DelineaProvider">DelineaProvider</a>)
- </p>
- <p>
- <p>DelineaProviderSecretRef is a secret reference containing either a direct value or a reference to a secret key.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Value can be specified directly to set a value without using a secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef references a key in a secret that will be used as value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.DopplerAuth">DopplerAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.DopplerProvider">DopplerProvider</a>)
- </p>
- <p>
- <p>DopplerAuth configures authentication with the Doppler API.
- Exactly one of secretRef or oidcConfig must be specified.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.DopplerAuthSecretRef">
- DopplerAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef authenticates using a Doppler service token stored in a Kubernetes Secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>oidcConfig</code></br>
- <em>
- <a href="#external-secrets.io/v1.DopplerOIDCAuth">
- DopplerOIDCAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>OIDCConfig authenticates using Kubernetes ServiceAccount tokens via OIDC.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.DopplerAuthSecretRef">DopplerAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.DopplerAuth">DopplerAuth</a>)
- </p>
- <p>
- <p>DopplerAuthSecretRef contains the secret reference for accessing the Doppler API.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>dopplerToken</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The DopplerToken is used for authentication.
- See <a href="https://docs.doppler.com/reference/api#authentication">https://docs.doppler.com/reference/api#authentication</a> for auth token types.
- The Key attribute defaults to dopplerToken if not specified.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.DopplerOIDCAuth">DopplerOIDCAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.DopplerAuth">DopplerAuth</a>)
- </p>
- <p>
- <p>DopplerOIDCAuth configures OIDC authentication with Doppler using Kubernetes ServiceAccount tokens.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>identity</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Identity is the Doppler Service Account Identity ID configured for OIDC authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <p>ServiceAccountRef specifies the Kubernetes ServiceAccount to use for authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>expirationSeconds</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ExpirationSeconds sets the ServiceAccount token validity duration.
- Defaults to 10 minutes.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.DopplerProvider">DopplerProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>DopplerProvider configures a store to sync secrets using the Doppler provider.
- Project and Config are required if not using a Service Token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.DopplerAuth">
- DopplerAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the Operator authenticates with the Doppler API</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>project</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Doppler project (required if not using a Service Token)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>config</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Doppler config (required if not using a Service Token)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>nameTransformer</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Environment variable compatible name transforms that change secret names to a different format</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>format</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Format enables the downloading of secrets as a file (string)</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecret">ExternalSecret
- </h3>
- <p>
- <p>ExternalSecret is the Schema for the external-secrets API.
- It defines how to fetch data from external APIs and make it available as Kubernetes Secrets.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretSpec">
- ExternalSecretSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>secretStoreRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreRef">
- SecretStoreRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>target</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretTarget">
- ExternalSecretTarget
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretRefreshPolicy">
- ExternalSecretRefreshPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>RefreshPolicy determines how the ExternalSecret should be refreshed:
- - CreatedOnce: Creates the Secret only if it does not exist and does not update it thereafter
- - Periodic: Synchronizes the Secret from the external source at regular intervals specified by refreshInterval.
- No periodic updates occur if refreshInterval is 0.
- - OnChange: Only synchronizes the Secret when the ExternalSecret’s metadata or specification changes</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider,
- specified as Golang Duration strings.
- Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”
- Example values: “1h0m0s”, “2h30m0s”, “10m0s”
- May be set to “0s” to fetch and create it once. Defaults to 1h0m0s.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>syncWindows</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretSyncWindows">
- ExternalSecretSyncWindows
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SyncWindows optionally restricts when periodic refreshes may occur.
- Evaluated in UTC, only for Periodic refresh policy (or when refreshPolicy is unset).</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretData">
- []ExternalSecretData
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>dataFrom</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretDataFromRemoteRef">
- []ExternalSecretDataFromRemoteRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>DataFrom is used to fetch all properties from a specific Provider data
- If multiple entries are specified, the Secret keys are merged in the specified order</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretStatus">
- ExternalSecretStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretConditionType">ExternalSecretConditionType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
- </p>
- <p>
- <p>ExternalSecretConditionType defines a value type for ExternalSecret conditions.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Deleted"</p></td>
- <td><p>ExternalSecretDeleted indicates that the external secret has been deleted.</p>
- </td>
- </tr><tr><td><p>"Ready"</p></td>
- <td><p>ExternalSecretReady indicates that the external secret is ready and synced.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretConversionStrategy">ExternalSecretConversionStrategy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
- <a href="#external-secrets.io/v1.ExternalSecretFind">ExternalSecretFind</a>)
- </p>
- <p>
- <p>ExternalSecretConversionStrategy defines strategies for converting secret values.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Default"</p></td>
- <td><p>ExternalSecretConversionDefault specifies the default conversion strategy.</p>
- </td>
- </tr><tr><td><p>"Unicode"</p></td>
- <td><p>ExternalSecretConversionUnicode specifies that values should be treated as Unicode.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretTarget">ExternalSecretTarget</a>)
- </p>
- <p>
- <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"CreateOrMerge"</p></td>
- <td><p>CreatePolicyCreateOrMerge creates the Secret if it is missing and merges
- data fields into it if it exists, without an ownerReference. A deleted
- target is recreated while the ExternalSecret exists, and the Secret is
- retained when the ExternalSecret is deleted.</p>
- </td>
- </tr><tr><td><p>"Merge"</p></td>
- <td><p>CreatePolicyMerge does not create the Secret, but merges the data fields to the Secret.</p>
- </td>
- </tr><tr><td><p>"None"</p></td>
- <td><p>CreatePolicyNone does not create a Secret (future use with injector).</p>
- </td>
- </tr><tr><td><p>"Orphan"</p></td>
- <td><p>CreatePolicyOrphan creates the Secret and does not set the ownerReference.
- I.e. it will be orphaned after the deletion of the ExternalSecret.</p>
- </td>
- </tr><tr><td><p>"Owner"</p></td>
- <td><p>CreatePolicyOwner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretData">ExternalSecretData
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretSpec">ExternalSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretKey</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The key in the Kubernetes Secret to store the value.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>remoteRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretDataRemoteRef">
- ExternalSecretDataRemoteRef
- </a>
- </em>
- </td>
- <td>
- <p>RemoteRef points to the remote secret and defines
- which secret (version/property/..) to fetch.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sourceRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.StoreSourceRef">
- StoreSourceRef
- </a>
- </em>
- </td>
- <td>
- <p>SourceRef allows you to override the source
- from which the value will be pulled.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretSpec">ExternalSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretDataFromRemoteRef defines the connection between the Kubernetes Secret keys and the Provider data
- when using DataFrom to fetch multiple values from a Provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>extract</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretDataRemoteRef">
- ExternalSecretDataRemoteRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to extract multiple key/value pairs from one secret
- Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>find</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretFind">
- ExternalSecretFind
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to find secrets based on tags or regular expressions
- Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>rewrite</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretRewrite">
- []ExternalSecretRewrite
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to rewrite secret Keys after getting them from the secret Provider
- Multiple Rewrite operations can be provided. They are applied in a layered order (first to last)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sourceRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.StoreGeneratorSourceRef">
- StoreGeneratorSourceRef
- </a>
- </em>
- </td>
- <td>
- <p>SourceRef points to a store or generator
- which contains secret values ready to use.
- Use this in combination with Extract or Find pull values out of
- a specific SecretStore.
- When sourceRef points to a generator Extract or Find is not supported.
- The generator returns a static map of values</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretData">ExternalSecretData</a>,
- <a href="#external-secrets.io/v1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
- </p>
- <p>
- <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Key is the key used in the Provider, mandatory</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>metadataPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretMetadataPolicy">
- ExternalSecretMetadataPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>property</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select a specific property of the Provider value (if a map), if supported</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>version</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select a specific version of the Provider value, if supported</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conversionStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretConversionStrategy">
- ExternalSecretConversionStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a conversion Strategy. Defaults to Default when omitted.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>decodingStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretDecodingStrategy">
- ExternalSecretDecodingStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a decoding Strategy. Defaults to None when omitted.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>nullBytePolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretNullBytePolicy">
- ExternalSecretNullBytePolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Controls how ESO handles fetched secret data containing NUL bytes for this source.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretDecodingStrategy">ExternalSecretDecodingStrategy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
- <a href="#external-secrets.io/v1.ExternalSecretFind">ExternalSecretFind</a>,
- <a href="#external-secrets.io/v1.TemplateFrom">TemplateFrom</a>)
- </p>
- <p>
- <p>ExternalSecretDecodingStrategy defines strategies for decoding secret values.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Auto"</p></td>
- <td><p>ExternalSecretDecodeAuto specifies automatic detection of the decoding method.</p>
- </td>
- </tr><tr><td><p>"Base64"</p></td>
- <td><p>ExternalSecretDecodeBase64 specifies that values should be decoded using Base64.</p>
- </td>
- </tr><tr><td><p>"Base64URL"</p></td>
- <td><p>ExternalSecretDecodeBase64URL specifies that values should be decoded using Base64URL.</p>
- </td>
- </tr><tr><td><p>"None"</p></td>
- <td><p>ExternalSecretDecodeNone specifies that no decoding should be performed.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretDeletionPolicy">ExternalSecretDeletionPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretTarget">ExternalSecretTarget</a>)
- </p>
- <p>
- <p>ExternalSecretDeletionPolicy defines rules on how to delete the resulting Secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Delete"</p></td>
- <td><p>DeletionPolicyDelete deletes the secret if all provider secrets are deleted.
- If a secret gets deleted on the provider side and is not accessible
- anymore this is not considered an error and the ExternalSecret
- does not go into SecretSyncedError status.</p>
- </td>
- </tr><tr><td><p>"Merge"</p></td>
- <td><p>DeletionPolicyMerge removes keys in the secret, but not the secret itself.
- If a secret gets deleted on the provider side and is not accessible
- anymore this is not considered an error and the ExternalSecret
- does not go into SecretSyncedError status.</p>
- </td>
- </tr><tr><td><p>"Retain"</p></td>
- <td><p>DeletionPolicyRetain will retain the secret if all provider secrets have been deleted.
- If a provider secret does not exist the ExternalSecret gets into the
- SecretSyncedError status.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretFind">ExternalSecretFind
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
- </p>
- <p>
- <p>ExternalSecretFind defines configuration for finding secrets in the provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>A root path to start the find operations.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- <a href="#external-secrets.io/v1.FindName">
- FindName
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Finds secrets based on the name.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tags</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Find secrets based on tags.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conversionStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretConversionStrategy">
- ExternalSecretConversionStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a conversion Strategy. Defaults to Default when omitted.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>decodingStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretDecodingStrategy">
- ExternalSecretDecodingStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a decoding Strategy. Defaults to None when omitted.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>nullBytePolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretNullBytePolicy">
- ExternalSecretNullBytePolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Controls how ESO handles fetched secret data containing NUL bytes for this find source.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretMetadata">ExternalSecretMetadata
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretMetadata defines metadata fields for the ExternalSecret generated by the ClusterExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>annotations</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>labels</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretMetadataPolicy">ExternalSecretMetadataPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>)
- </p>
- <p>
- <p>ExternalSecretMetadataPolicy defines policies for fetching metadata from provider secrets.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Fetch"</p></td>
- <td><p>ExternalSecretMetadataPolicyFetch specifies that metadata should be fetched from the provider.</p>
- </td>
- </tr><tr><td><p>"None"</p></td>
- <td><p>ExternalSecretMetadataPolicyNone specifies that no metadata should be fetched from the provider.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretNullBytePolicy">ExternalSecretNullBytePolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
- <a href="#external-secrets.io/v1.ExternalSecretFind">ExternalSecretFind</a>)
- </p>
- <p>
- <p>ExternalSecretNullBytePolicy defines how fetched secret data containing NUL bytes should be handled.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Fail"</p></td>
- <td><p>ExternalSecretNullBytePolicyFail fails reconciliation if fetched secret data contains NUL bytes.</p>
- </td>
- </tr><tr><td><p>"Ignore"</p></td>
- <td><p>ExternalSecretNullBytePolicyIgnore allows fetched secret data to contain NUL bytes.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretRefreshPolicy">ExternalSecretRefreshPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretSpec">ExternalSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretRefreshPolicy defines how and when the ExternalSecret should be refreshed.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"CreatedOnce"</p></td>
- <td><p>RefreshPolicyCreatedOnce creates the Secret once and does not update it thereafter.</p>
- </td>
- </tr><tr><td><p>"OnChange"</p></td>
- <td><p>RefreshPolicyOnChange only synchronizes when the ExternalSecret’s metadata or spec changes.</p>
- </td>
- </tr><tr><td><p>"Periodic"</p></td>
- <td><p>RefreshPolicyPeriodic synchronizes the Secret from the provider at regular intervals.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretRewrite">ExternalSecretRewrite
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
- </p>
- <p>
- <p>ExternalSecretRewrite defines how to rewrite secret data values before they are written to the Secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>merge</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretRewriteMerge">
- ExternalSecretRewriteMerge
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to merge key/values in one single Secret
- The resulting key will contain all values from the specified secrets</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>regexp</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretRewriteRegexp">
- ExternalSecretRewriteRegexp
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to rewrite with regular expressions.
- The resulting key will be the output of a regexp.ReplaceAll operation.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>transform</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretRewriteTransform">
- ExternalSecretRewriteTransform
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to apply string transformation on the secrets.
- The resulting key will be the output of the template applied by the operation.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretRewriteMerge">ExternalSecretRewriteMerge
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
- </p>
- <p>
- <p>ExternalSecretRewriteMerge defines configuration for merging secret values.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>into</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define the target key of the merge operation.
- Required if strategy is JSON. Ignored otherwise.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>priority</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define key priority in conflict resolution.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>priorityPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretRewriteMergePriorityPolicy">
- ExternalSecretRewriteMergePriorityPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define the policy when a key in the priority list does not exist in the input.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conflictPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretRewriteMergeConflictPolicy">
- ExternalSecretRewriteMergeConflictPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define the policy to use in conflict resolution.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>strategy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretRewriteMergeStrategy">
- ExternalSecretRewriteMergeStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define the strategy to use in the merge operation.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretRewriteMergeConflictPolicy">ExternalSecretRewriteMergeConflictPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretRewriteMerge">ExternalSecretRewriteMerge</a>)
- </p>
- <p>
- <p>ExternalSecretRewriteMergeConflictPolicy defines the policy for resolving conflicts when merging secrets.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Error"</p></td>
- <td><p>ExternalSecretRewriteMergeConflictPolicyError returns an error when conflicts occur during merge.</p>
- </td>
- </tr><tr><td><p>"Ignore"</p></td>
- <td><p>ExternalSecretRewriteMergeConflictPolicyIgnore ignores conflicts when merging secret values.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretRewriteMergePriorityPolicy">ExternalSecretRewriteMergePriorityPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretRewriteMerge">ExternalSecretRewriteMerge</a>)
- </p>
- <p>
- <p>ExternalSecretRewriteMergePriorityPolicy defines the policy for handling missing keys in the priority
- list during merge operations.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"IgnoreNotFound"</p></td>
- <td></td>
- </tr><tr><td><p>"Strict"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretRewriteMergeStrategy">ExternalSecretRewriteMergeStrategy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretRewriteMerge">ExternalSecretRewriteMerge</a>)
- </p>
- <p>
- <p>ExternalSecretRewriteMergeStrategy defines the strategy for merging secrets.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Extract"</p></td>
- <td><p>ExternalSecretRewriteMergeStrategyExtract merges secrets by extracting values.</p>
- </td>
- </tr><tr><td><p>"JSON"</p></td>
- <td><p>ExternalSecretRewriteMergeStrategyJSON merges secrets using JSON merge strategy.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretRewriteRegexp">ExternalSecretRewriteRegexp
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretRewrite">ExternalSecretRewrite</a>,
- <a href="#external-secrets.io/v1alpha1.PushSecretRewrite">PushSecretRewrite</a>)
- </p>
- <p>
- <p>ExternalSecretRewriteRegexp defines configuration for rewriting secrets using regular expressions.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>source</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Used to define the regular expression of a re.Compiler.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>target</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Used to define the target pattern of a ReplaceAll operation.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretRewriteTransform">ExternalSecretRewriteTransform
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretRewrite">ExternalSecretRewrite</a>,
- <a href="#external-secrets.io/v1alpha1.PushSecretRewrite">PushSecretRewrite</a>)
- </p>
- <p>
- <p>ExternalSecretRewriteTransform defines configuration for transforming secrets using templates.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>template</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Used to define the template to apply on the secret name.
- <code>.value</code> will specify the secret name in the template.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretSpec">ExternalSecretSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>,
- <a href="#external-secrets.io/v1.ExternalSecret">ExternalSecret</a>)
- </p>
- <p>
- <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretStoreRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreRef">
- SecretStoreRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>target</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretTarget">
- ExternalSecretTarget
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretRefreshPolicy">
- ExternalSecretRefreshPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>RefreshPolicy determines how the ExternalSecret should be refreshed:
- - CreatedOnce: Creates the Secret only if it does not exist and does not update it thereafter
- - Periodic: Synchronizes the Secret from the external source at regular intervals specified by refreshInterval.
- No periodic updates occur if refreshInterval is 0.
- - OnChange: Only synchronizes the Secret when the ExternalSecret’s metadata or specification changes</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider,
- specified as Golang Duration strings.
- Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”
- Example values: “1h0m0s”, “2h30m0s”, “10m0s”
- May be set to “0s” to fetch and create it once. Defaults to 1h0m0s.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>syncWindows</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretSyncWindows">
- ExternalSecretSyncWindows
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SyncWindows optionally restricts when periodic refreshes may occur.
- Evaluated in UTC, only for Periodic refresh policy (or when refreshPolicy is unset).</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretData">
- []ExternalSecretData
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>dataFrom</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretDataFromRemoteRef">
- []ExternalSecretDataFromRemoteRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>DataFrom is used to fetch all properties from a specific Provider data
- If multiple entries are specified, the Secret keys are merged in the specified order</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretStatus">ExternalSecretStatus
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecret">ExternalSecret</a>)
- </p>
- <p>
- <p>ExternalSecretStatus defines the observed state of ExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>refreshTime</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <p>refreshTime is the time and date the external secret was fetched and
- the target secret updated</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>syncedResourceVersion</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>SyncedResourceVersion keeps track of the last synced version</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretStatusCondition">
- []ExternalSecretStatusCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>binding</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#localobjectreference-v1-core">
- Kubernetes core/v1.LocalObjectReference
- </a>
- </em>
- </td>
- <td>
- <p>Binding represents a servicebinding.io Provisioned Service reference to the secret</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretStatus">ExternalSecretStatus</a>)
- </p>
- <p>
- <p>ExternalSecretStatusCondition defines a status condition of an ExternalSecret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretConditionType">
- ExternalSecretConditionType
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
- Kubernetes core/v1.ConditionStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>reason</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>message</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>lastTransitionTime</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretSyncWindowEntry">ExternalSecretSyncWindowEntry
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretSyncWindows">ExternalSecretSyncWindows</a>)
- </p>
- <p>
- <p>ExternalSecretSyncWindowEntry defines a single cron-schedule + duration pair
- within a SyncWindows block.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>schedule</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Schedule is a standard 5-field cron expression evaluated in UTC, or a
- named shorthand such as @daily or @every 1h. It marks the start time of
- each window occurrence.
- Example: “0 22 * * 1-5” opens a window every weekday at 22:00 UTC.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>duration</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>Duration specifies how long the window stays open after each Schedule
- firing. Example: “8h”.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretSyncWindowKind">ExternalSecretSyncWindowKind
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretSyncWindows">ExternalSecretSyncWindows</a>)
- </p>
- <p>
- <p>ExternalSecretSyncWindowKind defines whether a SyncWindow permits or
- blocks periodic refreshes.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"allow"</p></td>
- <td><p>SyncWindowAllow allows periodic refreshes only while at least one window
- in the list is active. Refreshes are blocked at all other times.</p>
- </td>
- </tr><tr><td><p>"deny"</p></td>
- <td><p>SyncWindowDeny blocks periodic refreshes while any window in the list is
- active. Refreshes proceed normally at all other times.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretSyncWindows">ExternalSecretSyncWindows
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretSpec">ExternalSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretSyncWindows optionally restricts when periodic syncs may occur.
- All windows in the list share the same Kind.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>kind</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretSyncWindowKind">
- ExternalSecretSyncWindowKind
- </a>
- </em>
- </td>
- <td>
- <p>Kind applies to every window in the list.
- “allow” – syncs are permitted only while at least one window is active;
- all other times are blocked.
- “deny” – syncs are blocked while any window is active;
- all other times are permitted.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>windows</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretSyncWindowEntry">
- []ExternalSecretSyncWindowEntry
- </a>
- </em>
- </td>
- <td>
- <p>Windows is the list of schedule+duration pairs.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretTarget">ExternalSecretTarget
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretSpec">ExternalSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretTarget defines the Kubernetes Secret to be created,
- there can be only one target per ExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The name of the Secret resource to be managed.
- Defaults to the .metadata.name of the ExternalSecret resource</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>creationPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretCreationPolicy">
- ExternalSecretCreationPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CreationPolicy defines rules on how to create the resulting Secret.
- Defaults to “Owner”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>deletionPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretDeletionPolicy">
- ExternalSecretDeletionPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>DeletionPolicy defines rules on how to delete the resulting Secret.
- Defaults to “Retain”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>template</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretTemplate">
- ExternalSecretTemplate
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Template defines a blueprint for the created Secret resource.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>manifest</code></br>
- <em>
- <a href="#external-secrets.io/v1.ManifestReference">
- ManifestReference
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Manifest defines a custom Kubernetes resource to create instead of a Secret.
- When specified, ExternalSecret will create the resource type defined here
- (e.g., ConfigMap, Custom Resource) instead of a Secret.
- Warning: Using Generic target. Make sure access policies and encryption are properly configured.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>immutable</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Immutable defines if the final secret will be immutable</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretTemplate">ExternalSecretTemplate
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretTarget">ExternalSecretTarget</a>,
- <a href="#external-secrets.io/v1alpha1.PushSecretSpec">PushSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
- 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>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secrettype-v1-core">
- Kubernetes core/v1.SecretType
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>engineVersion</code></br>
- <em>
- <a href="#external-secrets.io/v1.TemplateEngineVersion">
- TemplateEngineVersion
- </a>
- </em>
- </td>
- <td>
- <p>EngineVersion specifies the template engine version
- that should be used to compile/execute the
- template specified in .data and .templateFrom[].</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretTemplateMetadata">
- ExternalSecretTemplateMetadata
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>mergePolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1.TemplateMergePolicy">
- TemplateMergePolicy
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>templateFrom</code></br>
- <em>
- <a href="#external-secrets.io/v1.TemplateFrom">
- []TemplateFrom
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
- </p>
- <p>
- <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>annotations</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>labels</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>finalizers</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ExternalSecretValidator">ExternalSecretValidator
- </h3>
- <p>
- <p>ExternalSecretValidator implements a validating webhook for ExternalSecrets.</p>
- </p>
- <h3 id="external-secrets.io/v1.FakeProvider">FakeProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>FakeProvider configures a fake provider that returns static values.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- <a href="#external-secrets.io/v1.FakeProviderData">
- []FakeProviderData
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>validationResult</code></br>
- <em>
- <a href="#external-secrets.io/v1.ValidationResult">
- ValidationResult
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.FakeProviderData">FakeProviderData
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.FakeProvider">FakeProvider</a>)
- </p>
- <p>
- <p>FakeProviderData defines a key-value pair with optional version for the fake provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>version</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.FetchingPolicy">FetchingPolicy
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>,
- <a href="#external-secrets.io/v1.YandexLockboxProvider">YandexLockboxProvider</a>)
- </p>
- <p>
- <p>FetchingPolicy configures how the provider interprets the <code>data.secretKey.remoteRef.key</code> field in ExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>byID</code></br>
- <em>
- <a href="#external-secrets.io/v1.ByID">
- ByID
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>byName</code></br>
- <em>
- <a href="#external-secrets.io/v1.ByName">
- ByName
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.FindName">FindName
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretFind">ExternalSecretFind</a>)
- </p>
- <p>
- <p>FindName defines criteria for finding secrets by name patterns.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>regexp</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Finds secrets base</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.FortanixProvider">FortanixProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>FortanixProvider provides access to Fortanix SDKMS API using the provided credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>APIURL is the URL of SDKMS API. Defaults to <code>sdkms.fortanix.com</code>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>apiKey</code></br>
- <em>
- <a href="#external-secrets.io/v1.FortanixProviderSecretRef">
- FortanixProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>APIKey is the API token to access SDKMS Applications.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.FortanixProviderSecretRef">FortanixProviderSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.FortanixProvider">FortanixProvider</a>)
- </p>
- <p>
- <p>FortanixProviderSecretRef is a secret reference containing the SDKMS API Key.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>SecretRef is a reference to a secret containing the SDKMS API Key.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.GCPSMAuth">GCPSMAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.GCPSMProvider">GCPSMProvider</a>)
- </p>
- <p>
- <p>GCPSMAuth defines the authentication methods for Google Cloud Platform Secret Manager.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.GCPSMAuthSecretRef">
- GCPSMAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>workloadIdentity</code></br>
- <em>
- <a href="#external-secrets.io/v1.GCPWorkloadIdentity">
- GCPWorkloadIdentity
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>workloadIdentityFederation</code></br>
- <em>
- <a href="#external-secrets.io/v1.GCPWorkloadIdentityFederation">
- GCPWorkloadIdentityFederation
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.GCPSMAuth">GCPSMAuth</a>,
- <a href="#external-secrets.io/v1.VaultGCPAuth">VaultGCPAuth</a>)
- </p>
- <p>
- <p>GCPSMAuthSecretRef contains the secret references for GCP Secret Manager authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretAccessKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The SecretAccessKey is used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.GCPSMProvider">GCPSMProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.GCPSMAuth">
- GCPSMAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth defines the information necessary to authenticate against GCP</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectID project where secret is located</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>location</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Location optionally defines a location for a secret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretVersionSelectionPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretVersionSelectionPolicy">
- SecretVersionSelectionPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretVersionSelectionPolicy specifies how the provider selects a secret version
- when “latest” is disabled or destroyed.
- Possible values are:
- - LatestOrFail: the provider always uses “latest”, or fails if that version is disabled/destroyed.
- - LatestOrFetch: the provider falls back to fetching the latest version if the version is DESTROYED or DISABLED</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.GCPWorkloadIdentity">GCPWorkloadIdentity
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.GCPSMAuth">GCPSMAuth</a>,
- <a href="#external-secrets.io/v1.VaultGCPAuth">VaultGCPAuth</a>)
- </p>
- <p>
- <p>GCPWorkloadIdentity defines configuration for workload identity authentication to GCP.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clusterLocation</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ClusterLocation is the location of the cluster
- If not specified, it fetches information from the metadata server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clusterName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ClusterName is the name of the cluster
- If not specified, it fetches information from the metadata server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clusterProjectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ClusterProjectID is the project ID of the cluster
- If not specified, it fetches information from the metadata server</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.GCPWorkloadIdentityFederation">GCPWorkloadIdentityFederation
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.GCPSMAuth">GCPSMAuth</a>,
- <a href="#generators.external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth</a>)
- </p>
- <p>
- <p>GCPWorkloadIdentityFederation holds the configurations required for generating federated access tokens.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>credConfig</code></br>
- <em>
- <a href="#external-secrets.io/v1.ConfigMapReference">
- ConfigMapReference
- </a>
- </em>
- </td>
- <td>
- <p>credConfig holds the configmap reference containing the GCP external account credential configuration in JSON format and the key name containing the json data.
- For using Kubernetes cluster as the identity provider, use serviceAccountRef instead. Operators mounted serviceaccount token cannot be used as the token source, instead
- serviceAccountRef must be used by providing operators service account details.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <p>serviceAccountRef is the reference to the kubernetes ServiceAccount to be used for obtaining the tokens,
- when Kubernetes is configured as provider in workload identity pool.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>awsSecurityCredentials</code></br>
- <em>
- <a href="#external-secrets.io/v1.AwsCredentialsConfig">
- AwsCredentialsConfig
- </a>
- </em>
- </td>
- <td>
- <p>awsSecurityCredentials is for configuring AWS region and credentials to use for obtaining the access token,
- when using the AWS metadata server is not an option.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>audience</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>audience is the Secure Token Service (STS) audience which contains the resource name for the workload identity pool and the provider identifier in that pool.
- If specified, Audience found in the external account credential config will be overridden with the configured value.
- audience must be provided when serviceAccountRef or awsSecurityCredentials is configured.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalTokenEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>externalTokenEndpoint is the endpoint explicitly set up to provide tokens, which will be matched against the
- credential_source.url in the provided credConfig. This field is merely to double-check the external token source
- URL is having the expected value.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>gcpServiceAccountEmail</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>GCPServiceAccountEmail is the email of the Google Cloud service account to impersonate
- after Workload Identity Federation. Use this to grant access through the service account’s
- IAM bindings (for example roles/secretmanager.secretAccessor). When set, it overrides
- service_account_impersonation_url in the external account JSON from credConfig;
- when serviceAccountRef is set, it also overrides the “iam.gke.io/gcp-service-account” annotation
- on that ServiceAccount.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.GcpIDTokenAuthCredentials">GcpIDTokenAuthCredentials
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.InfisicalAuth">InfisicalAuth</a>)
- </p>
- <p>
- <p>GcpIDTokenAuthCredentials represents the credentials for GCP ID token authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>identityId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.GcpIamAuthCredentials">GcpIamAuthCredentials
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.InfisicalAuth">InfisicalAuth</a>)
- </p>
- <p>
- <p>GcpIamAuthCredentials represents the credentials for GCP IAM authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>identityId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountKeyFilePath</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.GeneratorRef">GeneratorRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.StoreGeneratorSourceRef">StoreGeneratorSourceRef</a>,
- <a href="#external-secrets.io/v1.StoreSourceRef">StoreSourceRef</a>,
- <a href="#external-secrets.io/v1alpha1.PushSecretSelector">PushSecretSelector</a>)
- </p>
- <p>
- <p>GeneratorRef points to a generator custom resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiVersion</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Specify the apiVersion of the generator resource</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kind</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Specify the Kind of the generator resource</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Specify the name of the generator resource</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.GenericClusterStoreValidator">GenericClusterStoreValidator
- </h3>
- <p>
- <p>GenericClusterStoreValidator implements webhook validation for ClusterSecretStore resources.</p>
- </p>
- <h3 id="external-secrets.io/v1.GenericStore">GenericStore
- </h3>
- <p>
- <p>GenericStore is a common interface for interacting with ClusterSecretStore
- or a namespaced SecretStore.</p>
- </p>
- <h3 id="external-secrets.io/v1.GenericStoreValidator">GenericStoreValidator
- </h3>
- <p>
- <p>GenericStoreValidator implements webhook validation for SecretStore resources.</p>
- </p>
- <h3 id="external-secrets.io/v1.GithubAppAuth">GithubAppAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.GithubProvider">GithubProvider</a>)
- </p>
- <p>
- <p>GithubAppAuth defines authentication configuration using a GitHub App for accessing GitHub API.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>privateKey</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.GithubProvider">GithubProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>GithubProvider provides access and authentication to a GitHub instance .</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL configures the Github instance URL. Defaults to <a href="https://github.com/">https://github.com/</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>uploadURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Upload URL for enterprise instances. Default to URL.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.GithubAppAuth">
- GithubAppAuth
- </a>
- </em>
- </td>
- <td>
- <p>auth configures how secret-manager authenticates with a Github instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretType</code></br>
- <em>
- <a href="#external-secrets.io/v1.GithubSecretType">
- GithubSecretType
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>secretType specifies which GitHub secret service to use.
- Defaults to Actions for backwards compatibility.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>appID</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- <p>appID specifies the Github APP that will be used to authenticate the client</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>installationID</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- <p>installationID specifies the Github APP installation that will be used to authenticate the client</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>organization</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>organization will be used to fetch secrets from the Github organization</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>repository</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>repository will be used to fetch secrets from the Github repository within an organization</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>environment will be used to fetch secrets from a particular environment within a github repository</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>orgSecretVisibility</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>orgSecretVisibility controls the visibility of organization secrets pushed via PushSecret.
- Valid values are “all” or “private”.
- When unset, new secrets are created with visibility “all” and existing secrets preserve
- whatever visibility they already have in GitHub.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.GithubSecretType">GithubSecretType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.GithubProvider">GithubProvider</a>)
- </p>
- <p>
- <p>GithubSecretType specifies the GitHub secret service to use.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Actions"</p></td>
- <td><p>GithubSecretTypeActions selects GitHub Actions secrets.</p>
- </td>
- </tr><tr><td><p>"Dependabot"</p></td>
- <td><p>GithubSecretTypeDependabot selects GitHub Dependabot secrets.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.GitlabAuth">GitlabAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.GitlabProvider">GitlabProvider</a>)
- </p>
- <p>
- <p>GitlabAuth defines the authentication method for accessing GitLab API.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>SecretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.GitlabSecretRef">
- GitlabSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.GitlabProvider">GitlabProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>GitlabProvider configures a store to sync secrets with a GitLab instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.GitlabAuth">
- GitlabAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectID specifies a project where secrets are located.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>inheritFromGroups</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <p>InheritFromGroups specifies whether parent groups should be discovered and checked for secrets.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>groupIDs</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <p>GroupIDs specify, which gitlab groups to pull secrets from. Group secrets are read from left to right followed by the project variables.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Base64 encoded certificate for the GitLab server sdk. The sdk MUST run with HTTPS to make sure no MITM attack
- can be performed.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.GitlabSecretRef">GitlabSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.GitlabAuth">GitlabAuth</a>)
- </p>
- <p>
- <p>GitlabSecretRef contains the secret reference for GitLab authentication credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessToken</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>AccessToken is used for authentication.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.IBMAuth">IBMAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.IBMProvider">IBMProvider</a>)
- </p>
- <p>
- <p>IBMAuth defines authentication options for connecting to IBM Cloud Secrets Manager.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.IBMAuthSecretRef">
- IBMAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>containerAuth</code></br>
- <em>
- <a href="#external-secrets.io/v1.IBMAuthContainerAuth">
- IBMAuthContainerAuth
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.IBMAuthContainerAuth">IBMAuthContainerAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.IBMAuth">IBMAuth</a>)
- </p>
- <p>
- <p>IBMAuthContainerAuth defines container-based authentication with IAM Trusted Profile.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>profile</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>the IBM Trusted Profile</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tokenLocation</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Location the token is mounted on the pod</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>iamEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.IBMAuthSecretRef">IBMAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.IBMAuth">IBMAuth</a>)
- </p>
- <p>
- <p>IBMAuthSecretRef contains the secret reference for IBM Cloud API key authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretApiKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SecretAccessKey is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>iamEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The IAM endpoint used to obain a token</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.IBMProvider">IBMProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>IBMProvider configures a store to sync secrets using a IBM Cloud Secrets Manager
- backend.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.IBMAuth">
- IBMAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.InfisicalAuth">InfisicalAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.InfisicalProvider">InfisicalProvider</a>)
- </p>
- <p>
- <p>InfisicalAuth specifies the authentication configuration for Infisical.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>universalAuthCredentials</code></br>
- <em>
- <a href="#external-secrets.io/v1.UniversalAuthCredentials">
- UniversalAuthCredentials
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>azureAuthCredentials</code></br>
- <em>
- <a href="#external-secrets.io/v1.AzureAuthCredentials">
- AzureAuthCredentials
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>gcpIdTokenAuthCredentials</code></br>
- <em>
- <a href="#external-secrets.io/v1.GcpIDTokenAuthCredentials">
- GcpIDTokenAuthCredentials
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>gcpIamAuthCredentials</code></br>
- <em>
- <a href="#external-secrets.io/v1.GcpIamAuthCredentials">
- GcpIamAuthCredentials
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwtAuthCredentials</code></br>
- <em>
- <a href="#external-secrets.io/v1.JwtAuthCredentials">
- JwtAuthCredentials
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>ldapAuthCredentials</code></br>
- <em>
- <a href="#external-secrets.io/v1.LdapAuthCredentials">
- LdapAuthCredentials
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>ociAuthCredentials</code></br>
- <em>
- <a href="#external-secrets.io/v1.OciAuthCredentials">
- OciAuthCredentials
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetesAuthCredentials</code></br>
- <em>
- <a href="#external-secrets.io/v1.KubernetesAuthCredentials">
- KubernetesAuthCredentials
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>awsAuthCredentials</code></br>
- <em>
- <a href="#external-secrets.io/v1.AwsAuthCredentials">
- AwsAuthCredentials
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>tokenAuthCredentials</code></br>
- <em>
- <a href="#external-secrets.io/v1.TokenAuthCredentials">
- TokenAuthCredentials
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.InfisicalProvider">InfisicalProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>InfisicalProvider configures a store to sync secrets using the Infisical provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.InfisicalAuth">
- InfisicalAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the Operator authenticates with the Infisical API</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretsScope</code></br>
- <em>
- <a href="#external-secrets.io/v1.MachineIdentityScopeInWorkspace">
- MachineIdentityScopeInWorkspace
- </a>
- </em>
- </td>
- <td>
- <p>SecretsScope defines the scope of the secrets within the workspace</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>hostAPI</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>HostAPI specifies the base URL of the Infisical API. If not provided, it defaults to “<a href="https://app.infisical.com/api"">https://app.infisical.com/api”</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CABundle is a PEM-encoded CA certificate bundle used to validate
- the Infisical server’s TLS certificate. Mutually exclusive with CAProvider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CAProvider is a reference to a Secret or ConfigMap that contains a CA certificate.
- The certificate is used to validate the Infisical server’s TLS certificate.
- Mutually exclusive with CABundle.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.IntegrationInfo">IntegrationInfo
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OnePasswordSDKProvider">OnePasswordSDKProvider</a>)
- </p>
- <p>
- <p>IntegrationInfo specifies the name and version of the integration built using the 1Password Go SDK.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name defaults to “1Password SDK”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>version</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Version defaults to “v1.0.0”.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.JwtAuthCredentials">JwtAuthCredentials
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.InfisicalAuth">InfisicalAuth</a>)
- </p>
- <p>
- <p>JwtAuthCredentials represents the credentials for JWT authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>identityId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.KeeperSecurityProvider">KeeperSecurityProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>KeeperSecurityProvider Configures a store to sync secrets using Keeper Security.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>authRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>folderID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>getByTitleFallback</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.KubernetesAuth">KubernetesAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.CRDProvider">CRDProvider</a>,
- <a href="#external-secrets.io/v1.KubernetesProvider">KubernetesProvider</a>)
- </p>
- <p>
- <p>KubernetesAuth defines authentication options for connecting to a Kubernetes cluster.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>cert</code></br>
- <em>
- <a href="#external-secrets.io/v1.CertAuth">
- CertAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>has both clientCert and clientKey as secretKeySelector</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>token</code></br>
- <em>
- <a href="#external-secrets.io/v1.TokenAuth">
- TokenAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>use static token to authenticate with</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccount</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>points to a service account that should be used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.KubernetesAuthCredentials">KubernetesAuthCredentials
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.InfisicalAuth">InfisicalAuth</a>)
- </p>
- <p>
- <p>KubernetesAuthCredentials represents the credentials for Kubernetes authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>identityId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountTokenPath</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.KubernetesProvider">KubernetesProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>KubernetesProvider configures a store to sync secrets with a Kubernetes instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>server</code></br>
- <em>
- <a href="#external-secrets.io/v1.KubernetesServer">
- KubernetesServer
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>configures the Kubernetes server Address.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.KubernetesAuth">
- KubernetesAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth configures how secret-manager authenticates with a Kubernetes instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>authRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>A reference to a secret that contains the auth information.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>remoteNamespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Remote namespace to fetch the secrets from</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.KubernetesServer">KubernetesServer
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.CRDProvider">CRDProvider</a>,
- <a href="#external-secrets.io/v1.KubernetesProvider">KubernetesProvider</a>)
- </p>
- <p>
- <p>KubernetesServer defines configuration for connecting to a Kubernetes API server.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>configures the Kubernetes server Address.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CABundle is a base64-encoded CA certificate</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.LdapAuthCredentials">LdapAuthCredentials
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.InfisicalAuth">InfisicalAuth</a>)
- </p>
- <p>
- <p>LdapAuthCredentials represents the credentials for LDAP authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>identityId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>ldapPassword</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>ldapUsername</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.MachineIdentityScopeInWorkspace">MachineIdentityScopeInWorkspace
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.InfisicalProvider">InfisicalProvider</a>)
- </p>
- <p>
- <p>MachineIdentityScopeInWorkspace defines the scope for machine identity within a workspace.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretsPath</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretsPath specifies the path to the secrets within the workspace. Defaults to “/” if not provided.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>recursive</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Recursive indicates whether the secrets should be fetched recursively. Defaults to false if not provided.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environmentSlug</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>EnvironmentSlug is the required slug identifier for the environment.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectSlug</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectSlug is the required slug identifier for the project.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>organizationSlug</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>OrganizationSlug is the optional slug that identifies the organization that will be used
- during authentication. Useful for sub-organization setups</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>expandSecretReferences</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ExpandSecretReferences indicates whether secret references should be expanded. Defaults to true if not provided.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.MaintenanceStatus">MaintenanceStatus
- (<code>string</code> alias)</p></h3>
- <p>
- <p>MaintenanceStatus defines a type for different maintenance states of a provider schema.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Deprecated"</p></td>
- <td></td>
- </tr><tr><td><p>"Maintained"</p></td>
- <td></td>
- </tr><tr><td><p>"NotMaintained"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.ManifestReference">ManifestReference
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretTarget">ExternalSecretTarget</a>)
- </p>
- <p>
- <p>ManifestReference defines a custom Kubernetes resource type to be created
- instead of a Secret. This allows ExternalSecret to create ConfigMaps,
- Custom Resources, or any other Kubernetes resource type.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiVersion</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>APIVersion of the target resource (e.g., “v1” for ConfigMap, “argoproj.io/v1alpha1” for ArgoCD Application)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kind</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Kind of the target resource (e.g., “ConfigMap”, “Application”)</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.NTLMProtocol">NTLMProtocol
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AuthorizationProtocol">AuthorizationProtocol</a>)
- </p>
- <p>
- <p>NTLMProtocol contains the NTLM-specific configuration.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>usernameSecret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>passwordSecret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.NebiusAuth">NebiusAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.NebiusMysteryboxProvider">NebiusMysteryboxProvider</a>)
- </p>
- <p>
- <p>NebiusAuth defines the authentication method for the Nebius provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountCredsSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ServiceAccountCreds references a Kubernetes Secret key that contains a JSON
- document with service account credentials used to get an IAM token.</p>
- <p>Expected JSON structure:
- {
- “subject-credentials”: {
- “alg”: “RS256”,
- “private-key”: “—–BEGIN PRIVATE KEY—–\n<private-key>\n—–END PRIVATE KEY—–\n”,
- “kid”: “<public-key-id>”,
- “iss”: “<issuer-service-account-id>”,
- “sub”: “<subject-service-account-id>”
- }
- }</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Token authenticates with Nebius Mysterybox by presenting a token.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>workloadIdentity</code></br>
- <em>
- <a href="#external-secrets.io/v1.NebiusWorkloadIdentity">
- NebiusWorkloadIdentity
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>WorkloadIdentity defines configuration for workload identity authentication to Nebius IAM.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.NebiusCAProvider">NebiusCAProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.NebiusMysteryboxProvider">NebiusMysteryboxProvider</a>)
- </p>
- <p>
- <p>NebiusCAProvider The provider for the CA bundle to use to validate Nebius server certificate.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>certSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.NebiusMysteryboxProvider">NebiusMysteryboxProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>NebiusMysteryboxProvider Configures a store to sync secrets using the Nebius Mysterybox provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiDomain</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>NebiusMysterybox API endpoint</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.NebiusAuth">
- NebiusAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines parameters to authenticate in MysteryBox</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.NebiusCAProvider">
- NebiusCAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate NebiusMysterybox server certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.NebiusWorkloadIdentity">NebiusWorkloadIdentity
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.NebiusAuth">NebiusAuth</a>)
- </p>
- <p>
- <p>NebiusWorkloadIdentity defines configuration for workload identity authentication to Nebius IAM.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <p>ServiceAccountRef references a Kubernetes ServiceAccount used to request a
- temporary JWT via the TokenRequest API. The JWT is then exchanged for a
- Nebius IAM token using workload federation.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>iamServiceAccountID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>IAMServiceAccountID is the Nebius IAM service account identifier that the
- federated Kubernetes service account should impersonate during token exchange.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.NgrokAuth">NgrokAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.NgrokProvider">NgrokProvider</a>)
- </p>
- <p>
- <p>NgrokAuth configures the authentication method for the ngrok provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiKey</code></br>
- <em>
- <a href="#external-secrets.io/v1.NgrokProviderSecretRef">
- NgrokProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>APIKey is the API Key used to authenticate with ngrok. See <a href="https://ngrok.com/docs/api/#authentication">https://ngrok.com/docs/api/#authentication</a></p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.NgrokProvider">NgrokProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>NgrokProvider configures a store to sync secrets with a ngrok vault to use in traffic policies.
- See: <a href="https://ngrok.com/blog-post/secrets-for-traffic-policy">https://ngrok.com/blog-post/secrets-for-traffic-policy</a></p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>APIURL is the URL of the ngrok API.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.NgrokAuth">
- NgrokAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the ngrok provider authenticates with the ngrok API.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vault</code></br>
- <em>
- <a href="#external-secrets.io/v1.NgrokVault">
- NgrokVault
- </a>
- </em>
- </td>
- <td>
- <p>Vault configures the ngrok vault to sync secrets with.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.NgrokProviderSecretRef">NgrokProviderSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.NgrokAuth">NgrokAuth</a>)
- </p>
- <p>
- <p>NgrokProviderSecretRef contains the secret reference for the ngrok provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef is a reference to a secret containing the ngrok API key.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.NgrokVault">NgrokVault
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.NgrokProvider">NgrokProvider</a>)
- </p>
- <p>
- <p>NgrokVault configures the ngrok vault to sync secrets with.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name is the name of the ngrok vault to sync secrets with.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.NoSecretError">NoSecretError
- </h3>
- <p>
- <p>NoSecretError shall be returned when a GetSecret can not find the
- desired secret. This is used for deletionPolicy.</p>
- </p>
- <h3 id="external-secrets.io/v1.NotModifiedError">NotModifiedError
- </h3>
- <p>
- <p>NotModifiedError to signal that the webhook received no changes,
- and it should just return without doing anything.</p>
- </p>
- <h3 id="external-secrets.io/v1.OciAuthCredentials">OciAuthCredentials
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.InfisicalAuth">InfisicalAuth</a>)
- </p>
- <p>
- <p>OciAuthCredentials represents the credentials for OCI authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>identityId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>privateKey</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>privateKeyPassphrase</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>fingerprint</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>userId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>tenancyId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OnboardbaseAuthSecretRef">OnboardbaseAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OnboardbaseProvider">OnboardbaseProvider</a>)
- </p>
- <p>
- <p>OnboardbaseAuthSecretRef holds secret references for onboardbase API Key credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiKeyRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>OnboardbaseAPIKey is the APIKey generated by an admin account.
- It is used to recognize and authorize access to a project and environment within onboardbase</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>passcodeRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>OnboardbasePasscode is the passcode attached to the API Key</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OnboardbaseProvider">OnboardbaseProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>OnboardbaseProvider configures a store to sync secrets using the Onboardbase provider.
- Project and Config are required if not using a Service Token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.OnboardbaseAuthSecretRef">
- OnboardbaseAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the Operator authenticates with the Onboardbase API</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>apiHost</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>project</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Project is an onboardbase project that the secrets should be pulled from</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Environment is the name of an environmnent within a project to pull the secrets from</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OnePasswordAuth">OnePasswordAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OnePasswordProvider">OnePasswordProvider</a>)
- </p>
- <p>
- <p>OnePasswordAuth contains a secretRef for credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.OnePasswordAuthSecretRef">
- OnePasswordAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OnePasswordAuthSecretRef">OnePasswordAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OnePasswordAuth">OnePasswordAuth</a>)
- </p>
- <p>
- <p>OnePasswordAuthSecretRef holds secret references for 1Password credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>connectTokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The ConnectToken is used for authentication to a 1Password Connect Server.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OnePasswordProvider">OnePasswordProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>OnePasswordProvider configures a store to sync secrets using the 1Password Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.OnePasswordAuth">
- OnePasswordAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against OnePassword Connect Server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>connectHost</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ConnectHost defines the OnePassword Connect Server to connect to</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vaults</code></br>
- <em>
- map[string]int
- </em>
- </td>
- <td>
- <p>Vaults defines which OnePassword vaults to search in which order</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OnePasswordSDKAuth">OnePasswordSDKAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OnePasswordSDKProvider">OnePasswordSDKProvider</a>)
- </p>
- <p>
- <p>OnePasswordSDKAuth contains a secretRef for the service account token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>ServiceAccountSecretRef points to the secret containing the token to access 1Password vault.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OnePasswordSDKProvider">OnePasswordSDKProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>OnePasswordSDKProvider configures a store to sync secrets using the 1Password sdk.
- Exactly one of Vault or Environment must be set.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>vault</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Vault defines the vault’s name or uuid to access. Do NOT add op:// prefix. This will be done automatically.
- Mutually exclusive with Environment.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Environment defines the 1Password Environment ID to read variables from.
- Environments are read-only: PushSecret, DeleteSecret, and SecretExists return an error when set.
- Mutually exclusive with Vault.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>integrationInfo</code></br>
- <em>
- <a href="#external-secrets.io/v1.IntegrationInfo">
- IntegrationInfo
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>IntegrationInfo specifies the name and version of the integration built using the 1Password Go SDK.
- If you don’t know which name and version to use, use <code>DefaultIntegrationName</code> and <code>DefaultIntegrationVersion</code>, respectively.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.OnePasswordSDKAuth">
- OnePasswordSDKAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against OnePassword API.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>cache</code></br>
- <em>
- <a href="#external-secrets.io/v1.CacheConfig">
- CacheConfig
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Cache configures client-side caching for read operations (GetSecret, GetSecretMap).
- When enabled, secrets are cached with the specified TTL.
- Write operations (PushSecret, DeleteSecret) automatically invalidate relevant cache entries.
- If omitted, caching is disabled (default).
- cache: {} is a valid option to set.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OpenBaoAppRole">OpenBaoAppRole
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OpenBaoAuth">OpenBaoAuth</a>)
- </p>
- <p>
- <p>OpenBaoAppRole authenticates with OpenBao using the <a href="https://openbao.org/docs/auth/approle/">App Role auth
- mechanism</a>, with the role and secret stored in a Kubernetes Secret resource.
- The role ID has to be specified either inline via <code>roleId</code> or by referencing
- a secret via <code>roleRef</code>.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the App Role authentication backend is mounted
- in OpenBao, e.g: “approle”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>roleId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>RoleID configured in the App Role authentication backend when setting
- up the authentication backend in OpenBao.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>roleRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Reference to a key in a Secret that contains the App Role ID used
- to authenticate with OpenBao.
- The <code>key</code> field must be specified and denotes which entry within the Secret
- resource is used as the app role id.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Reference to a key in a Secret that contains the App Role secret used
- to authenticate with OpenBao.
- The <code>key</code> field must be specified and denotes which entry within the Secret
- resource is used as the app role secret.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OpenBaoAuth">OpenBaoAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OpenBaoProvider">OpenBaoProvider</a>)
- </p>
- <p>
- <p>OpenBaoAuth is the configuration used to authenticate with an OpenBao server.
- Currently the following authentication methods are supported: <a href="https://openbao.org/docs/auth/approle/">AppRole</a>,
- <a href="https://openbao.org/docs/auth/kubernetes/">Kubernetes</a>, <a href="https://openbao.org/docs/auth/token/">Token</a> and <a href="https://openbao.org/docs/auth/userpass/">UserPass</a></p>
- <p>Additional authentication methods are planned for future releases.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>appRole</code></br>
- <em>
- <a href="#external-secrets.io/v1.OpenBaoAppRole">
- OpenBaoAppRole
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AppRole authenticates with OpenBao using the <a href="https://openbao.org/docs/auth/approle/">App Role auth mechanism</a>,
- with the role and secret stored in a Kubernetes Secret resource.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetes</code></br>
- <em>
- <a href="#external-secrets.io/v1.OpenBaoKubernetesAuth">
- OpenBaoKubernetesAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kubernetes authenticates with OpenBao by passing a ServiceAccount
- token to the <a href="https://openbao.org/docs/auth/kubernetes/">Kubernetes auth mechanism</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Name of the <a href="https://openbao.org/docs/concepts/namespaces/">OpenBao Namespace</a> to authenticate to. This can be different
- than the namespace your secret is in. Namespaces is a set of features
- within OpenBao that allows OpenBao environments to support secure
- multi-tenancy. e.g: “ns1”. This will default to OpenBao.Namespace field
- if set, or empty otherwise</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>TokenSecretRef authenticates with OpenBao by presenting a token.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>userPass</code></br>
- <em>
- <a href="#external-secrets.io/v1.OpenBaoUserPassAuth">
- OpenBaoUserPassAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>UserPass authenticates with OpenBao by passing a username/password pair</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OpenBaoKVStoreVersion">OpenBaoKVStoreVersion
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OpenBaoProvider">OpenBaoProvider</a>)
- </p>
- <p>
- <p>OpenBaoKVStoreVersion represents the version of the OpenBao KV secret engine.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"v1"</p></td>
- <td></td>
- </tr><tr><td><p>"v2"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.OpenBaoKubernetesAuth">OpenBaoKubernetesAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OpenBaoAuth">OpenBaoAuth</a>)
- </p>
- <p>
- <p>OpenBaoKubernetesAuth authenticates with OpenBao using the <a href="https://openbao.org/docs/auth/kubernetes/">Kubernetes
- auth mechanism</a> with a ServiceAccount token. The ServiceAccount token can be
- sourced from a ServiceAccount via <code>ServiceAccountRef</code> or from a secret
- via <code>SecretRef</code>.
- Using the controller pod’s ServiceAccount token is not supported.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the Kubernetes authentication backend is mounted in OpenBao, e.g:
- “kubernetes”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional service account field containing the name of a Kubernetes ServiceAccount.
- If the service account is specified, a token will be requested from the Kubernetes
- TokenRequest API for authenticating with OpenBao.
- Any configured audiences will be passed to the TokenRequest as-is.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
- for authenticating with OpenBao. If a name is specified without a key,
- <code>token</code> is the default.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>A required field containing the OpenBao Role to assume. A Role binds a
- Kubernetes ServiceAccount with a set of OpenBao policies.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OpenBaoProvider">OpenBaoProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>OpenBaoProvider configures a store to sync secrets using an OpenBao KV backend.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.OpenBaoAuth">
- OpenBaoAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth configures how secret-manager authenticates with the OpenBao server.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM encoded CA bundle used to validate the OpenBao server certificate. If
- this and <code>caProvider</code> are not set the system root certificates are used
- to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate OpenBao server
- certificate. If this and <code>caBundle</code> are not set the system root
- certificates are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Name of the <a href="https://openbao.org/docs/concepts/namespaces/">OpenBao Namespace</a>. Namespaces is a set of features within
- OpenBao that allows OpenBao environments to support secure multi-tenancy.
- e.g: “ns1”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>server</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Server is the connection address for the OpenBao server, e.g: <code>https://openbao.example.com:8200</code>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Path is the mount path of the OpenBao KV backend endpoint, e.g:
- “secret”. The v2 KV secret engine version specific “/data” path suffix
- for fetching secrets from OpenBao is optional and will be appended
- if not present in specified path.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>version</code></br>
- <em>
- <a href="#external-secrets.io/v1.OpenBaoKVStoreVersion">
- OpenBaoKVStoreVersion
- </a>
- </em>
- </td>
- <td>
- <p>Version is the OpenBao KV secret engine version. This can be either “v1” or
- “v2”. Version defaults to “v2”.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OpenBaoUserPassAuth">OpenBaoUserPassAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OpenBaoAuth">OpenBaoAuth</a>)
- </p>
- <p>
- <p>OpenBaoUserPassAuth authenticates with OpenBao using <a href="https://openbao.org/docs/auth/userpass/">UserPass authentication
- method</a>, with the username and password stored in a Kubernetes Secret
- resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the UserPassword authentication backend is mounted
- in OpenBao, e.g: “userpass”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Username is a username used to authenticate using the <a href="https://openbao.org/docs/auth/userpass/">UserPass
- authentication method</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>SecretRef to a key in a Secret resource containing password for the user
- used to authenticate with OpenBao using the <a href="https://openbao.org/docs/auth/userpass/">UserPass authentication
- method</a></p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OracleAuth">OracleAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OracleProvider">OracleProvider</a>)
- </p>
- <p>
- <p>OracleAuth defines the authentication method for the Oracle Vault provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>tenancy</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Tenancy is the tenancy OCID where user is located.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>user</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>User is an access OCID specific to the account.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.OracleSecretRef">
- OracleSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>SecretRef to pass through sensitive information.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OraclePrincipalType">OraclePrincipalType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OracleProvider">OracleProvider</a>)
- </p>
- <p>
- <p>OraclePrincipalType defines the type of principal used for authentication with Oracle Vault.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"InstancePrincipal"</p></td>
- <td><p>InstancePrincipal represents a instance principal.</p>
- </td>
- </tr><tr><td><p>"UserPrincipal"</p></td>
- <td><p>UserPrincipal represents a user principal.</p>
- </td>
- </tr><tr><td><p>"Workload"</p></td>
- <td><p>WorkloadPrincipal represents a workload principal.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.OracleProvider">OracleProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>OracleProvider configures a store to sync secrets using an Oracle Vault
- backend.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Region is the region where vault is located.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vault</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Vault is the vault’s OCID of the specific vault where secret is located.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>compartment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Compartment is the vault compartment OCID.
- Required for PushSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>encryptionKey</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>EncryptionKey is the OCID of the encryption key within the vault.
- Required for PushSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>principalType</code></br>
- <em>
- <a href="#external-secrets.io/v1.OraclePrincipalType">
- OraclePrincipalType
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The type of principal to use for authentication. If left blank, the Auth struct will
- determine the principal type. This optional field must be specified if using
- workload identity.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.OracleAuth">
- OracleAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth configures how secret-manager authenticates with the Oracle Vault.
- If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ServiceAccountRef specified the service account
- that should be used when authenticating with WorkloadIdentity.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OracleSecretRef">OracleSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OracleAuth">OracleAuth</a>)
- </p>
- <p>
- <p>OracleSecretRef contains the secret reference for Oracle Vault authentication credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>privatekey</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>PrivateKey is the user’s API Signing Key in PEM format, used for authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>fingerprint</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Fingerprint is the fingerprint of the API private key.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OvhAuth">OvhAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OvhProvider">OvhProvider</a>)
- </p>
- <p>
- <p>OvhAuth tells the controller how to authenticate to OVHcloud’s Secret Manager, either using mTLS or a token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>mtls</code></br>
- <em>
- <a href="#external-secrets.io/v1.OvhClientMTLS">
- OvhClientMTLS
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>token</code></br>
- <em>
- <a href="#external-secrets.io/v1.OvhClientToken">
- OvhClientToken
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OvhClientMTLS">OvhClientMTLS
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OvhAuth">OvhAuth</a>)
- </p>
- <p>
- <p>OvhClientMTLS defines the configuration required to authenticate to OVHcloud’s Secret Manager using mTLS.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>certSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>keySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OvhClientToken">OvhClientToken
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.OvhAuth">OvhAuth</a>)
- </p>
- <p>
- <p>OvhClientToken defines the configuration required to authenticate to OVHcloud’s Secret Manager using a token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>tokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.OvhProvider">OvhProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>OvhProvider holds the configuration to synchronize secrets with OVHcloud’s Secret Manager.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>server</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>specifies the OKMS server endpoint.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>okmsid</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>specifies the OKMS ID.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>casRequired</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Enables or disables check-and-set (CAS) (default: false).</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>okmsTimeout</code></br>
- <em>
- uint32
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Setup a timeout in seconds when requests to the KMS are made (default: 30).</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.OvhAuth">
- OvhAuth
- </a>
- </em>
- </td>
- <td>
- <p>Authentication method (mtls or token).</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.PassboltAuth">PassboltAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.PassboltProvider">PassboltProvider</a>)
- </p>
- <p>
- <p>PassboltAuth contains a secretRef for the passbolt credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>passwordSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>privateKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.PassboltProvider">PassboltProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>PassboltProvider provides access to Passbolt secrets manager.
- See: <a href="https://www.passbolt.com">https://www.passbolt.com</a>.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.PassboltAuth">
- PassboltAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against Passbolt Server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>host</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Host defines the Passbolt Server to connect to</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM encoded CA bundle used to validate Passbolt server certificate. Only used
- if the Host URL is using HTTPS protocol. If not set the system root certificates
- are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Passbolt server certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.PasswordDepotAuth">PasswordDepotAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.PasswordDepotProvider">PasswordDepotProvider</a>)
- </p>
- <p>
- <p>PasswordDepotAuth defines the authentication method for the Password Depot provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.PasswordDepotSecretRef">
- PasswordDepotSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.PasswordDepotProvider">PasswordDepotProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>PasswordDepotProvider configures a store to sync secrets with a Password Depot instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>host</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL configures the Password Depot instance URL.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>database</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Database to use as source</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.PasswordDepotAuth">
- PasswordDepotAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with a Password Depot instance.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.PasswordDepotSecretRef">PasswordDepotSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.PasswordDepotAuth">PasswordDepotAuth</a>)
- </p>
- <p>
- <p>PasswordDepotSecretRef contains the secret reference for Password Depot authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>credentials</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Username / Password is used for authentication.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.PreviderAuth">PreviderAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.PreviderProvider">PreviderProvider</a>)
- </p>
- <p>
- <p>PreviderAuth contains a secretRef for credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.PreviderAuthSecretRef">
- PreviderAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.PreviderAuthSecretRef">PreviderAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.PreviderAuth">PreviderAuth</a>)
- </p>
- <p>
- <p>PreviderAuthSecretRef holds secret references for Previder Vault credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessToken</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessToken is used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.PreviderProvider">PreviderProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>PreviderProvider configures a store to sync secrets using the Previder Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.PreviderAuth">
- PreviderAuth
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>baseUri</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.Provider">Provider
- </h3>
- <p>
- <p>Provider is a common interface for interacting with secret backends.</p>
- </p>
- <h3 id="external-secrets.io/v1.PulumiAuth">PulumiAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.PulumiProvider">PulumiProvider</a>)
- </p>
- <p>
- <p>PulumiAuth configures authentication with the Pulumi API.
- Exactly one of accessToken or oidcConfig must be specified.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessToken</code></br>
- <em>
- <a href="#external-secrets.io/v1.PulumiProviderSecretRef">
- PulumiProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AccessToken authenticates using a Pulumi access token stored in a Kubernetes Secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>oidcConfig</code></br>
- <em>
- <a href="#external-secrets.io/v1.PulumiOIDCAuth">
- PulumiOIDCAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>OIDCConfig authenticates using Kubernetes ServiceAccount tokens via OIDC.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.PulumiOIDCAuth">PulumiOIDCAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.PulumiAuth">PulumiAuth</a>)
- </p>
- <p>
- <p>PulumiOIDCAuth configures OIDC authentication with Pulumi using Kubernetes ServiceAccount tokens.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>organization</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Organization is the name of the Pulumi organization configured for OIDC authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <p>ServiceAccountRef specifies the Kubernetes ServiceAccount to use for authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>expirationSeconds</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ExpirationSeconds sets the token validity duration for service account and OIDC token.
- Defaults to 10 minutes.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.PulumiProvider">PulumiProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>PulumiProvider defines configuration for accessing secrets from Pulumi ESC.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>APIURL is the URL of the Pulumi API.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.PulumiAuth">
- PulumiAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth configures how the Operator authenticates with the Pulumi API.
- Either auth or the deprecated accessToken field must be specified.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>organization</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Organization are a space to collaborate on shared projects and stacks.
- To create a new organization, visit <a href="https://app.pulumi.com/">https://app.pulumi.com/</a> and click “New Organization”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>project</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Project is the name of the Pulumi ESC project the environment belongs to.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Environment are YAML documents composed of static key-value pairs, programmatic expressions,
- dynamically retrieved values from supported providers including all major clouds,
- and other Pulumi ESC environments.
- 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>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessToken</code></br>
- <em>
- <a href="#external-secrets.io/v1.PulumiProviderSecretRef">
- PulumiProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AccessToken is the access tokens to sign in to the Pulumi Cloud Console.</p>
- <p>Deprecated: Use auth.accessToken instead.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.PulumiProviderSecretRef">PulumiProviderSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.PulumiAuth">PulumiAuth</a>,
- <a href="#external-secrets.io/v1.PulumiProvider">PulumiProvider</a>)
- </p>
- <p>
- <p>PulumiProviderSecretRef contains the secret reference for Pulumi authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>SecretRef is a reference to a secret containing the Pulumi API token.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.PushSecretData">PushSecretData
- </h3>
- <p>
- <p>PushSecretData is an interface to allow using v1alpha1.PushSecretData content in Provider registered in v1.</p>
- </p>
- <h3 id="external-secrets.io/v1.PushSecretRemoteRef">PushSecretRemoteRef
- </h3>
- <p>
- <p>PushSecretRemoteRef is an interface to allow using v1alpha1.PushSecretRemoteRef in Provider registered in v1.</p>
- </p>
- <h3 id="external-secrets.io/v1.ScalewayProvider">ScalewayProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>ScalewayProvider defines the configuration for the Scaleway Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>APIURL is the url of the api to use. Defaults to <a href="https://api.scaleway.com">https://api.scaleway.com</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessKey</code></br>
- <em>
- <a href="#external-secrets.io/v1.ScalewayProviderSecretRef">
- ScalewayProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>AccessKey is the non-secret part of the api key.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretKey</code></br>
- <em>
- <a href="#external-secrets.io/v1.ScalewayProviderSecretRef">
- ScalewayProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>SecretKey is the non-secret part of the api key.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ScalewayProviderSecretRef">ScalewayProviderSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ScalewayProvider">ScalewayProvider</a>)
- </p>
- <p>
- <p>ScalewayProviderSecretRef defines the configuration for Scaleway secret references.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Value can be specified directly to set a value without using a secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef references a key in a secret that will be used as value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretReference">SecretReference
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AwsCredentialsConfig">AwsCredentialsConfig</a>)
- </p>
- <p>
- <p>SecretReference holds the details of a secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>name of the secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>namespace in which the secret exists. If empty, secret will looked up in local namespace.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretServerProvider">SecretServerProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>SecretServerProvider provides access to authenticate to a secrets provider server.
- 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>.
- Authentication requires either Token, or both Username and Password. If Token is
- set it takes precedence and Username/Password are ignored.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretServerProviderRef">
- SecretServerProviderRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Username is the secret server account username.
- Required unless Token is set.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>password</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretServerProviderRef">
- SecretServerProviderRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Password is the secret server account password.
- Required unless Token is set.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>token</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretServerProviderRef">
- SecretServerProviderRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Token is an access token used to authenticate to the secret server,
- as an alternative to Username and Password. When set, Username and
- Password are not required and are ignored.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>domain</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Domain is the secret server domain.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serverURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ServerURL
- URL to your secret server installation</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>siteId</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SiteID is the ID of the Secret Server site for new secrets.
- PushSecret metadata can override this value for one secret.
- The provider uses 1 if this field is not set.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>disableSiteIDValidation</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>DisableSiteIDValidation permits a missing site ID for new secrets.
- The provider sends 0 if no site ID is set.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM/base64 encoded CA bundle used to validate Secret ServerURL. Only used
- if the ServerURL URL is using HTTPS protocol. If not set the system root certificates
- are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Secret ServerURL certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretServerProviderRef">SecretServerProviderRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretServerProvider">SecretServerProvider</a>)
- </p>
- <p>
- <p>SecretServerProviderRef references a value that can be specified directly or via a secret
- for a SecretServerProvider. Exactly one of Value or SecretRef must be set.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Value can be specified directly to set a value without using a secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef references a key in a secret that will be used as value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretStore">SecretStore
- </h3>
- <p>
- <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreSpec">
- SecretStoreSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
- The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provider</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">
- SecretStoreProvider
- </a>
- </em>
- </td>
- <td>
- <p>Used to configure the provider. Only one provider may be set</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrySettings</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreRetrySettings">
- SecretStoreRetrySettings
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure HTTP retries on failures.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- k8s.io/apimachinery/pkg/util/intstr.IntOrString
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure store refresh interval. Accepts either an integer number
- of seconds (legacy) or a Go duration string such as “1h” or “5m”. Empty or
- 0 will default to the controller config.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1.ClusterSecretStoreCondition">
- []ClusterSecretStoreCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to constrain a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreStatus">
- SecretStoreStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretStoreCapabilities">SecretStoreCapabilities
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreStatus">SecretStoreStatus</a>)
- </p>
- <p>
- <p>SecretStoreCapabilities defines the possible operations a SecretStore can do.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ReadOnly"</p></td>
- <td><p>SecretStoreReadOnly indicates that the store can only read secrets.</p>
- </td>
- </tr><tr><td><p>"ReadWrite"</p></td>
- <td><p>SecretStoreReadWrite indicates that the store can both read and write secrets.</p>
- </td>
- </tr><tr><td><p>"WriteOnly"</p></td>
- <td><p>SecretStoreWriteOnly indicates that the store can only write secrets.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretStoreConditionType">SecretStoreConditionType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
- </p>
- <p>
- <p>SecretStoreConditionType represents the condition of the SecretStore.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Ready"</p></td>
- <td><p>SecretStoreReady indicates that the store is ready and able to serve requests.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreSpec">SecretStoreSpec</a>)
- </p>
- <p>
- <p>SecretStoreProvider contains the provider-specific configuration.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>aws</code></br>
- <em>
- <a href="#external-secrets.io/v1.AWSProvider">
- AWSProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>azurekv</code></br>
- <em>
- <a href="#external-secrets.io/v1.AzureKVProvider">
- AzureKVProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>akeyless</code></br>
- <em>
- <a href="#external-secrets.io/v1.AkeylessProvider">
- AkeylessProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>bitwardensecretsmanager</code></br>
- <em>
- <a href="#external-secrets.io/v1.BitwardenSecretsManagerProvider">
- BitwardenSecretsManagerProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>BitwardenSecretsManager configures this store to sync secrets using BitwardenSecretsManager provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vault</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultProvider">
- VaultProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Vault configures this store to sync secrets using the HashiCorp Vault provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>ovh</code></br>
- <em>
- <a href="#external-secrets.io/v1.OvhProvider">
- OvhProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>OVHcloud configures this store to sync secrets using the OVHcloud provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>gcpsm</code></br>
- <em>
- <a href="#external-secrets.io/v1.GCPSMProvider">
- GCPSMProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>oracle</code></br>
- <em>
- <a href="#external-secrets.io/v1.OracleProvider">
- OracleProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>ibm</code></br>
- <em>
- <a href="#external-secrets.io/v1.IBMProvider">
- IBMProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>yandexcertificatemanager</code></br>
- <em>
- <a href="#external-secrets.io/v1.YandexCertificateManagerProvider">
- YandexCertificateManagerProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>YandexCertificateManager configures this store to sync secrets using Yandex Certificate Manager provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>yandexlockbox</code></br>
- <em>
- <a href="#external-secrets.io/v1.YandexLockboxProvider">
- YandexLockboxProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>github</code></br>
- <em>
- <a href="#external-secrets.io/v1.GithubProvider">
- GithubProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Github configures this store to push GitHub Actions or Dependabot secrets using the GitHub API provider.
- Note: This provider only supports write operations (PushSecret) and cannot fetch secrets from GitHub</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>gitlab</code></br>
- <em>
- <a href="#external-secrets.io/v1.GitlabProvider">
- GitlabProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>GitLab configures this store to sync secrets using GitLab Variables provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>onepassword</code></br>
- <em>
- <a href="#external-secrets.io/v1.OnePasswordProvider">
- OnePasswordProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>OnePassword configures this store to sync secrets using the 1Password Cloud provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>onepasswordSDK</code></br>
- <em>
- <a href="#external-secrets.io/v1.OnePasswordSDKProvider">
- OnePasswordSDKProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>OnePasswordSDK configures this store to use 1Password’s new Go SDK to sync secrets.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>webhook</code></br>
- <em>
- <a href="#external-secrets.io/v1.WebhookProvider">
- WebhookProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Webhook configures this store to sync secrets using a generic templated webhook</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetes</code></br>
- <em>
- <a href="#external-secrets.io/v1.KubernetesProvider">
- KubernetesProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kubernetes configures this store to sync secrets using a Kubernetes cluster provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>crd</code></br>
- <em>
- <a href="#external-secrets.io/v1.CRDProvider">
- CRDProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CRD configures this store to sync secrets from arbitrary Kubernetes resources,
- including both custom resources (CRDs) and core API resources. Resources are
- selected by API group, version and kind, where group can be “” (empty string)
- for core resources such as ConfigMap. Reading the core v1 Secret is
- intentionally blocked — use the Kubernetes provider for that.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>fake</code></br>
- <em>
- <a href="#external-secrets.io/v1.FakeProvider">
- FakeProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Fake configures a store with static key/value pairs</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>senhasegura</code></br>
- <em>
- <a href="#external-secrets.io/v1.SenhaseguraProvider">
- SenhaseguraProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Senhasegura configures this store to sync secrets using senhasegura provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>scaleway</code></br>
- <em>
- <a href="#external-secrets.io/v1.ScalewayProvider">
- ScalewayProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Scaleway configures this store to sync secrets using the Scaleway provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>doppler</code></br>
- <em>
- <a href="#external-secrets.io/v1.DopplerProvider">
- DopplerProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Doppler configures this store to sync secrets using the Doppler provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>previder</code></br>
- <em>
- <a href="#external-secrets.io/v1.PreviderProvider">
- PreviderProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Previder configures this store to sync secrets using the Previder provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>onboardbase</code></br>
- <em>
- <a href="#external-secrets.io/v1.OnboardbaseProvider">
- OnboardbaseProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Onboardbase configures this store to sync secrets using the Onboardbase provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>keepersecurity</code></br>
- <em>
- <a href="#external-secrets.io/v1.KeeperSecurityProvider">
- KeeperSecurityProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>KeeperSecurity configures this store to sync secrets using the KeeperSecurity provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conjur</code></br>
- <em>
- <a href="#external-secrets.io/v1.ConjurProvider">
- ConjurProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Conjur configures this store to sync secrets using conjur provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>delinea</code></br>
- <em>
- <a href="#external-secrets.io/v1.DelineaProvider">
- DelineaProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Delinea DevOps Secrets Vault
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretserver</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretServerProvider">
- SecretServerProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretServer configures this store to sync secrets using SecretServer provider
- <a href="https://docs.delinea.com/online-help/secret-server/start.htm">https://docs.delinea.com/online-help/secret-server/start.htm</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>chef</code></br>
- <em>
- <a href="#external-secrets.io/v1.ChefProvider">
- ChefProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Chef configures this store to sync secrets with chef server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>pulumi</code></br>
- <em>
- <a href="#external-secrets.io/v1.PulumiProvider">
- PulumiProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Pulumi configures this store to sync secrets using the Pulumi provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>fortanix</code></br>
- <em>
- <a href="#external-secrets.io/v1.FortanixProvider">
- FortanixProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Fortanix configures this store to sync secrets using the Fortanix provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>passworddepot</code></br>
- <em>
- <a href="#external-secrets.io/v1.PasswordDepotProvider">
- PasswordDepotProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>passbolt</code></br>
- <em>
- <a href="#external-secrets.io/v1.PassboltProvider">
- PassboltProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>dvls</code></br>
- <em>
- <a href="#external-secrets.io/v1.DVLSProvider">
- DVLSProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>DVLS configures this store to sync secrets using Devolutions Server provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>infisical</code></br>
- <em>
- <a href="#external-secrets.io/v1.InfisicalProvider">
- InfisicalProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Infisical configures this store to sync secrets using the Infisical provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>beyondtrust</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondtrustProvider">
- BeyondtrustProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Beyondtrust configures this store to sync secrets using Password Safe provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>beyondtrustworkloadcredentials</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondtrustWorkloadCredentialsProvider">
- BeyondtrustWorkloadCredentialsProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>BeyondtrustWorkloadCredentials configures this store to sync secrets using the BeyondTrust Workload Credentials provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>cloudrusm</code></br>
- <em>
- <a href="#external-secrets.io/v1.CloudruSMProvider">
- CloudruSMProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CloudruSM configures this store to sync secrets using the Cloud.ru Secret Manager provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>volcengine</code></br>
- <em>
- <a href="#external-secrets.io/v1.VolcengineProvider">
- VolcengineProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Volcengine configures this store to sync secrets using the Volcengine provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>ngrok</code></br>
- <em>
- <a href="#external-secrets.io/v1.NgrokProvider">
- NgrokProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Ngrok configures this store to sync secrets using the ngrok provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>barbican</code></br>
- <em>
- <a href="#external-secrets.io/v1.BarbicanProvider">
- BarbicanProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Barbican configures this store to sync secrets using the OpenStack Barbican provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>nebiusmysterybox</code></br>
- <em>
- <a href="#external-secrets.io/v1.NebiusMysteryboxProvider">
- NebiusMysteryboxProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>NebiusMysterybox configures this store to sync secrets using NebiusMysterybox provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>openBao</code></br>
- <em>
- <a href="#external-secrets.io/v1.OpenBaoProvider">
- OpenBaoProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>OpenBao configures this store to sync secrets using the OpenBao provider.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretStoreRef">SecretStoreRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretSpec">ExternalSecretSpec</a>,
- <a href="#external-secrets.io/v1.StoreGeneratorSourceRef">StoreGeneratorSourceRef</a>,
- <a href="#external-secrets.io/v1.StoreSourceRef">StoreSourceRef</a>)
- </p>
- <p>
- <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name of the SecretStore resource</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kind</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
- Defaults to <code>SecretStore</code></p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretStoreRetrySettings">SecretStoreRetrySettings
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreSpec">SecretStoreSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.BeyondtrustWorkloadCredentialsDynamicSecretSpec">BeyondtrustWorkloadCredentialsDynamicSecretSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.VaultDynamicSecretSpec">VaultDynamicSecretSpec</a>)
- </p>
- <p>
- <p>SecretStoreRetrySettings defines the retry settings for accessing external secrets manager stores.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>maxRetries</code></br>
- <em>
- int32
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>retryInterval</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretStoreSpec">SecretStoreSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ClusterSecretStore">ClusterSecretStore</a>,
- <a href="#external-secrets.io/v1.SecretStore">SecretStore</a>)
- </p>
- <p>
- <p>SecretStoreSpec defines the desired state of SecretStore.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
- The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provider</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">
- SecretStoreProvider
- </a>
- </em>
- </td>
- <td>
- <p>Used to configure the provider. Only one provider may be set</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrySettings</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreRetrySettings">
- SecretStoreRetrySettings
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure HTTP retries on failures.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- k8s.io/apimachinery/pkg/util/intstr.IntOrString
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure store refresh interval. Accepts either an integer number
- of seconds (legacy) or a Go duration string such as “1h” or “5m”. Empty or
- 0 will default to the controller config.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1.ClusterSecretStoreCondition">
- []ClusterSecretStoreCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to constrain a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretStoreStatus">SecretStoreStatus
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ClusterSecretStore">ClusterSecretStore</a>,
- <a href="#external-secrets.io/v1.SecretStore">SecretStore</a>)
- </p>
- <p>
- <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreStatusCondition">
- []SecretStoreStatusCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>capabilities</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreCapabilities">
- SecretStoreCapabilities
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretStoreStatusCondition">SecretStoreStatusCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreStatus">SecretStoreStatus</a>)
- </p>
- <p>
- <p>SecretStoreStatusCondition contains condition information for a SecretStore.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreConditionType">
- SecretStoreConditionType
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
- Kubernetes core/v1.ConditionStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>reason</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>message</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>lastTransitionTime</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretVersionSelectionPolicy">SecretVersionSelectionPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.GCPSMProvider">GCPSMProvider</a>)
- </p>
- <p>
- <p>SecretVersionSelectionPolicy defines the policy for selecting secret versions in GCP Secret Manager.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"LatestOrFail"</p></td>
- <td><p>SecretVersionSelectionPolicyLatestOrFail means the provider always uses “latest”, or fails if that version is disabled/destroyed.</p>
- </td>
- </tr><tr><td><p>"LatestOrFetch"</p></td>
- <td><p>SecretVersionSelectionPolicyLatestOrFetch behaves like SecretVersionSelectionPolicyLatestOrFail but falls back to fetching the latest version if the version is DESTROYED or DISABLED.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.SecretsClient">SecretsClient
- </h3>
- <p>
- <p>SecretsClient provides access to secrets.</p>
- </p>
- <h3 id="external-secrets.io/v1.SecretsManager">SecretsManager
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AWSProvider">AWSProvider</a>)
- </p>
- <p>
- <p>SecretsManager defines how the provider behaves when interacting with AWS
- SecretsManager. Some of these settings are only applicable to controlling how
- secrets are deleted, and hence only apply to PushSecret (and only when
- deletionPolicy is set to Delete).</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>forceDeleteWithoutRecovery</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Specifies whether to delete the secret without any recovery window. You
- can’t use both this parameter and RecoveryWindowInDays in the same call.
- If you don’t use either, then by default Secrets Manager uses a 30 day
- recovery window.
- 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>
- </td>
- </tr>
- <tr>
- <td>
- <code>recoveryWindowInDays</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The number of days from 7 to 30 that Secrets Manager waits before
- permanently deleting the secret. You can’t use both this parameter and
- ForceDeleteWithoutRecovery in the same call. If you don’t use either,
- then by default Secrets Manager uses a 30-day recovery window.
- 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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SenhaseguraAuth">SenhaseguraAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SenhaseguraProvider">SenhaseguraProvider</a>)
- </p>
- <p>
- <p>SenhaseguraAuth tells the controller how to do auth in senhasegura.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientSecretSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SenhaseguraModuleType">SenhaseguraModuleType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SenhaseguraProvider">SenhaseguraProvider</a>)
- </p>
- <p>
- <p>SenhaseguraModuleType enum defines senhasegura target module to fetch secrets</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"DSM"</p></td>
- <td><pre><code> SenhaseguraModuleDSM is the senhasegura DevOps Secrets Management module
- see: https://senhasegura.com/devops
- </code></pre>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.SenhaseguraProvider">SenhaseguraProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>SenhaseguraProvider setup a store to sync secrets with senhasegura.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL of senhasegura</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>module</code></br>
- <em>
- <a href="#external-secrets.io/v1.SenhaseguraModuleType">
- SenhaseguraModuleType
- </a>
- </em>
- </td>
- <td>
- <p>Module defines which senhasegura module should be used to get secrets</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.SenhaseguraAuth">
- SenhaseguraAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines parameters to authenticate in senhasegura</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>ignoreSslCertificate</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <p>IgnoreSslCertificate defines if SSL certificate must be ignored</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.SessionTagsPolicy">SessionTagsPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.AWSProvider">AWSProvider</a>)
- </p>
- <p>
- <p>SessionTagsPolicy defines how STS session tags are handled.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Custom"</p></td>
- <td><p>SessionTagsPolicyCustom adds the tags defined in CustomSessionTags in addition to
- the esoNamespace, esoStoreName, and esoStoreKind tags.</p>
- </td>
- </tr><tr><td><p>"None"</p></td>
- <td><p>SessionTagsPolicyNone is the default behavior - no session tags are added.</p>
- </td>
- </tr><tr><td><p>"Simple"</p></td>
- <td><p>SessionTagsPolicySimple automatically adds esoNamespace, esoStoreName, and esoStoreKind
- session tags.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.StoreGeneratorSourceRef">StoreGeneratorSourceRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
- </p>
- <p>
- <p>StoreGeneratorSourceRef allows you to override the source
- from which the secret will be pulled from.
- You can define at maximum one property.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>storeRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreRef">
- SecretStoreRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>generatorRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.GeneratorRef">
- GeneratorRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>GeneratorRef points to a generator custom resource.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.StoreSourceRef">StoreSourceRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretData">ExternalSecretData</a>)
- </p>
- <p>
- <p>StoreSourceRef allows you to override the SecretStore source
- from which the secret will be pulled from.
- You can define at maximum one property.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>storeRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreRef">
- SecretStoreRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>generatorRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.GeneratorRef">
- GeneratorRef
- </a>
- </em>
- </td>
- <td>
- <p>GeneratorRef points to a generator custom resource.</p>
- <p>Deprecated: The generatorRef is not implemented in .data[].
- this will be removed with v1.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.Tag">Tag
- </h3>
- <p>
- <p>Tag is a key-value pair that can be attached to an AWS resource.
- see: <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html</a></p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.TemplateEngineVersion">TemplateEngineVersion
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
- </p>
- <p>
- <p>TemplateEngineVersion specifies the template engine version that should be used to
- compile/execute the template.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"v2"</p></td>
- <td><p>TemplateEngineV2 is the currently supported template engine version.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.TemplateFrom">TemplateFrom
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
- </p>
- <p>
- <p>TemplateFrom specifies a source for templates.
- Each item in the list can either reference a ConfigMap or a Secret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>configMap</code></br>
- <em>
- <a href="#external-secrets.io/v1.TemplateRef">
- TemplateRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>secret</code></br>
- <em>
- <a href="#external-secrets.io/v1.TemplateRef">
- TemplateRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>target</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Target specifies where to place the template result.
- For Secret resources the accepted values are empty, “Data”, “Annotations” and “Labels”;
- any other value is rejected because it would allow writes to privileged Secret fields.
- For custom resources (when spec.target.manifest is set), this supports
- nested paths like “spec.database.config” or “data”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>literal</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>valuesDecodingStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretDecodingStrategy">
- ExternalSecretDecodingStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a decoding Strategy for the rendered template values.
- Defaults to None when omitted.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.TemplateMergePolicy">TemplateMergePolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
- </p>
- <p>
- <p>TemplateMergePolicy defines how the rendered template should be merged with the existing Secret data.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Merge"</p></td>
- <td></td>
- </tr><tr><td><p>"Replace"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.TemplateRef">TemplateRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.TemplateFrom">TemplateFrom</a>)
- </p>
- <p>
- <p>TemplateRef specifies a reference to either a ConfigMap or a Secret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The name of the ConfigMap/Secret resource</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>items</code></br>
- <em>
- <a href="#external-secrets.io/v1.TemplateRefItem">
- []TemplateRefItem
- </a>
- </em>
- </td>
- <td>
- <p>A list of keys in the ConfigMap/Secret to use as templates for Secret data</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.TemplateRefItem">TemplateRefItem
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.TemplateRef">TemplateRef</a>)
- </p>
- <p>
- <p>TemplateRefItem specifies a key in the ConfigMap/Secret to use as a template for Secret data.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>A key in the ConfigMap/Secret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>templateAs</code></br>
- <em>
- <a href="#external-secrets.io/v1.TemplateScope">
- TemplateScope
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.TemplateScope">TemplateScope
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.TemplateRefItem">TemplateRefItem</a>)
- </p>
- <p>
- <p>TemplateScope specifies how the template keys should be interpreted.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"KeysAndValues"</p></td>
- <td></td>
- </tr><tr><td><p>"Values"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.TokenAuth">TokenAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.KubernetesAuth">KubernetesAuth</a>)
- </p>
- <p>
- <p>TokenAuth defines token-based authentication configuration for Kubernetes.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>bearerToken</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.TokenAuthCredentials">TokenAuthCredentials
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.InfisicalAuth">InfisicalAuth</a>)
- </p>
- <p>
- <p>TokenAuthCredentials represents the credentials for access token-based authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessToken</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.UniversalAuthCredentials">UniversalAuthCredentials
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.InfisicalAuth">InfisicalAuth</a>)
- </p>
- <p>
- <p>UniversalAuthCredentials represents the client credentials for universal authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientSecret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.ValidationResult">ValidationResult
- (<code>byte</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.FakeProvider">FakeProvider</a>)
- </p>
- <p>
- <p>ValidationResult is defined type for the number of validation results.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>2</p></td>
- <td><p>ValidationResultError indicates that there is a misconfiguration.</p>
- </td>
- </tr><tr><td><p>0</p></td>
- <td><p>ValidationResultReady indicates that the client is configured correctly
- and can be used.</p>
- </td>
- </tr><tr><td><p>1</p></td>
- <td><p>ValidationResultUnknown indicates that the client can be used
- but information is missing, and it can not be validated.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultAppRole">VaultAppRole
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
- with the role and secret stored in a Kubernetes Secret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the App Role authentication backend is mounted
- in Vault, e.g: “approle”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>roleId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>RoleID configured in the App Role authentication backend when setting
- up the authentication backend in Vault.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>roleRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Reference to a key in a Secret that contains the App Role ID used
- to authenticate with Vault.
- The <code>key</code> field must be specified and denotes which entry within the Secret
- resource is used as the app role id.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Reference to a key in a Secret that contains the App Role secret used
- to authenticate with Vault.
- The <code>key</code> field must be specified and denotes which entry within the Secret
- resource is used as the app role secret.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultAuth">VaultAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultProvider">VaultProvider</a>)
- </p>
- <p>
- <p>VaultAuth is the configuration used to authenticate with a Vault server.
- Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>userPass</code>, <code>jwt</code>, <code>cert</code>, <code>iam</code> or <code>gcp</code>
- can be specified. A namespace to authenticate against can optionally be specified.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Name of the vault namespace to authenticate to. This can be different than the namespace your secret is in.
- Namespaces is a set of features within Vault Enterprise that allows
- Vault environments to support Secure Multi-tenancy. e.g: “ns1”.
- More about namespaces can be found here <a href="https://www.vaultproject.io/docs/enterprise/namespaces">https://www.vaultproject.io/docs/enterprise/namespaces</a>
- This will default to Vault.Namespace field if set, or empty otherwise</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>appRole</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultAppRole">
- VaultAppRole
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AppRole authenticates with Vault using the App Role auth mechanism,
- with the role and secret stored in a Kubernetes Secret resource.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetes</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultKubernetesAuth">
- VaultKubernetesAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kubernetes authenticates with Vault by passing the ServiceAccount
- token stored in the named Secret resource to the Vault server.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>ldap</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultLdapAuth">
- VaultLdapAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Ldap authenticates with Vault by passing username/password pair using
- the LDAP authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultJwtAuth">
- VaultJwtAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Jwt authenticates with Vault by passing role and JWT token using the
- JWT/OIDC authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>cert</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultCertAuth">
- VaultCertAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
- Cert authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>iam</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultIamAuth">
- VaultIamAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Iam authenticates with vault by passing a special AWS request signed with AWS IAM credentials
- AWS IAM authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>userPass</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultUserPassAuth">
- VaultUserPassAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>UserPass authenticates with Vault by passing username/password pair</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>gcp</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultGCPAuth">
- VaultGCPAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Gcp authenticates with Vault using Google Cloud Platform authentication method
- GCP authentication method</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultAwsAuth">VaultAwsAuth
- </h3>
- <p>
- <p>VaultAwsAuth tells the controller how to do authentication with aws.
- Only one of secretRef or jwt can be specified.
- if none is specified the controller will try to load credentials from its own service account assuming it is IRSA enabled.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultAwsAuthSecretRef">
- VaultAwsAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultAwsJWTAuth">
- VaultAwsJWTAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultAwsAuthSecretRef">VaultAwsAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultAwsAuth">VaultAwsAuth</a>,
- <a href="#external-secrets.io/v1.VaultIamAuth">VaultIamAuth</a>)
- </p>
- <p>
- <p>VaultAwsAuthSecretRef holds secret references for AWS credentials
- both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessKeyIDSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The AccessKeyID is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretAccessKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The SecretAccessKey is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sessionTokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The SessionToken used for authentication
- This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
- 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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultAwsJWTAuth">VaultAwsJWTAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultAwsAuth">VaultAwsAuth</a>,
- <a href="#external-secrets.io/v1.VaultIamAuth">VaultIamAuth</a>)
- </p>
- <p>
- <p>VaultAwsJWTAuth Authenticate against AWS using service account tokens.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultCertAuth">VaultCertAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultCertAuth authenticates with Vault using the JWT/OIDC authentication
- method, with the role name and token stored in a Kubernetes Secret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Path where the Certificate authentication backend is mounted
- in Vault, e.g: “cert”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vaultRole</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>VaultRole specifies the Vault role to use for TLS certificate authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientCert</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ClientCert is a certificate to authenticate using the Cert Vault
- authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef to a key in a Secret resource containing client private key to
- authenticate with Vault using the Cert authentication method</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultCheckAndSet">VaultCheckAndSet
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultProvider">VaultProvider</a>)
- </p>
- <p>
- <p>VaultCheckAndSet defines the Check-And-Set (CAS) settings for Vault KV v2 PushSecret operations.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>required</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Required when true, all write operations must include a check-and-set parameter.
- This helps prevent unintentional overwrites of secrets.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultClientTLS">VaultClientTLS
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultProvider">VaultProvider</a>)
- </p>
- <p>
- <p>VaultClientTLS is the configuration used for client side related TLS communication,
- when the Vault server requires mutual authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>certSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CertSecretRef is a certificate added to the transport layer
- when communicating with the Vault server.
- If no key for the Secret is specified, external-secret will default to ‘tls.crt’.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>keySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>KeySecretRef to a key in a Secret resource containing client private key
- added to the transport layer when communicating with the Vault server.
- If no key for the Secret is specified, external-secret will default to ‘tls.key’.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultGCPAuth">VaultGCPAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultGCPAuth authenticates with Vault using Google Cloud Platform authentication method.
- Refer: <a href="https://developer.hashicorp.com/vault/docs/auth/gcp">https://developer.hashicorp.com/vault/docs/auth/gcp</a></p>
- <p>When ServiceAccountRef, SecretRef and WorkloadIdentity are not specified, the provider will use the controller pod’s
- identity to authenticate with GCP. This supports both GKE Workload Identity and service account keys.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Path where the GCP auth method is enabled in Vault, e.g: “gcp”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Vault Role. In Vault, a role describes an identity with a set of permissions, groups, or policies you want to attach to a user of the secrets engine.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Project ID of the Google Cloud Platform project</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>location</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Location optionally defines a location/region for the secret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.GCPSMAuthSecretRef">
- GCPSMAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Specify credentials in a Secret object</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>workloadIdentity</code></br>
- <em>
- <a href="#external-secrets.io/v1.GCPWorkloadIdentity">
- GCPWorkloadIdentity
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Specify a service account with Workload Identity</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ServiceAccountRef to a service account for impersonation</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultIamAuth">VaultIamAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultIamAuth authenticates with Vault using the Vault’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>
- <p>When JWTAuth and SecretRef are not specified, the provider will use the controller pod’s
- identity to authenticate with AWS. This supports both IRSA and EKS Pod Identity.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Path where the AWS auth method is enabled in Vault, e.g: “aws”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AWS region</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>This is the AWS role to be assumed before talking to vault</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vaultRole</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>AWS External ID set on assumed IAM roles</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vaultAwsIamServerID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultAwsAuthSecretRef">
- VaultAwsAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Specify credentials in a Secret object</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultAwsJWTAuth">
- VaultAwsJWTAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Specify a service account with IRSA enabled</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultJwtAuth">VaultJwtAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
- method, with the role name and a token stored in a Kubernetes Secret resource or
- a Kubernetes service account token retrieved via <code>TokenRequest</code>.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the JWT authentication backend is mounted
- in Vault, e.g: “jwt”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
- authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
- authenticate with Vault using the JWT/OIDC authentication method.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetesServiceAccountToken</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultKubernetesServiceAccountTokenAuth">
- VaultKubernetesServiceAccountTokenAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional ServiceAccountToken specifies the Kubernetes service account for which to request
- a token for with the <code>TokenRequest</code> API.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultKVStoreVersion">VaultKVStoreVersion
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultProvider">VaultProvider</a>)
- </p>
- <p>
- <p>VaultKVStoreVersion represents the version of the Vault KV secret engine.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"v1"</p></td>
- <td></td>
- </tr><tr><td><p>"v2"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultKubernetesAuth">VaultKubernetesAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultKubernetesAuth authenticates against Vault using a Kubernetes ServiceAccount token stored in
- a Secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>mountPath</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
- “kubernetes”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional service account field containing the name of a kubernetes ServiceAccount.
- If the service account is specified, the service account secret token JWT will be used
- for authenticating with Vault. If the service account selector is not supplied,
- the secretRef will be used instead.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
- for authenticating with Vault. If a name is specified without a key,
- <code>token</code> is the default. If one is not specified, the one bound to
- the controller will be used.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>A required field containing the Vault Role to assume. A Role binds a
- Kubernetes ServiceAccount with a set of Vault policies.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultKubernetesServiceAccountTokenAuth">VaultKubernetesServiceAccountTokenAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultJwtAuth">VaultJwtAuth</a>)
- </p>
- <p>
- <p>VaultKubernetesServiceAccountTokenAuth authenticates with Vault using a temporary
- Kubernetes service account token retrieved by the <code>TokenRequest</code> API.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <p>Service account field containing the name of a kubernetes ServiceAccount.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>audiences</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional audiences field that will be used to request a temporary Kubernetes service
- account token for the service account referenced by <code>serviceAccountRef</code>.
- Defaults to a single audience <code>vault</code> it not specified.</p>
- <p>Deprecated: use serviceAccountRef.Audiences instead</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>expirationSeconds</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional expiration time in seconds that will be used to request a temporary
- Kubernetes service account token for the service account referenced by
- <code>serviceAccountRef</code>.</p>
- <p>Deprecated: this will be removed in the future.
- Defaults to 10 minutes.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultLdapAuth">VaultLdapAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
- with the username and password stored in a Kubernetes Secret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the LDAP authentication backend is mounted
- in Vault, e.g: “ldap”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Username is an LDAP username used to authenticate using the LDAP Vault
- authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef to a key in a Secret resource containing password for the LDAP
- user used to authenticate with Vault using the LDAP authentication
- method</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultProvider">VaultProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>,
- <a href="#generators.external-secrets.io/v1alpha1.VaultDynamicSecretSpec">VaultDynamicSecretSpec</a>)
- </p>
- <p>
- <p>VaultProvider configures a store to sync secrets using a Hashicorp Vault KV backend.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultAuth">
- VaultAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with the Vault server.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>server</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Server is the connection address for the Vault server, e.g: “<a href="https://vault.example.com:8200"">https://vault.example.com:8200”</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Path is the mount path of the Vault KV backend endpoint, e.g:
- “secret”. The v2 KV secret engine version specific “/data” path suffix
- for fetching secrets from Vault is optional and will be appended
- if not present in specified path.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>version</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultKVStoreVersion">
- VaultKVStoreVersion
- </a>
- </em>
- </td>
- <td>
- <p>Version is the Vault KV secret engine version. This can be either “v1” or
- “v2”. Version defaults to “v2”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
- Vault environments to support Secure Multi-tenancy. e.g: “ns1”.
- 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>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
- if the Server URL is using HTTPS protocol. This parameter is ignored for
- plain HTTP protocol connection. If not set the system root certificates
- are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tls</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultClientTLS">
- VaultClientTLS
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The configuration used for client side related TLS communication, when the Vault server
- requires mutual authentication. Only used if the Server URL is using HTTPS protocol.
- This parameter is ignored for plain HTTP protocol connection.
- It’s worth noting this configuration is different from the “TLS certificates auth method”,
- which is available under the <code>auth.cert</code> section.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>readYourWrites</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ReadYourWrites ensures isolated read-after-write semantics by
- providing discovered cluster replication states in each request.
- More information about eventual consistency in Vault can be found here
- <a href="https://www.vaultproject.io/docs/enterprise/consistency">https://www.vaultproject.io/docs/enterprise/consistency</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>forwardInconsistent</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
- leader instead of simply retrying within a loop. This can increase performance if
- the option is enabled serverside.
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>headers</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Headers to be added in Vault request</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>checkAndSet</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultCheckAndSet">
- VaultCheckAndSet
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CheckAndSet defines the Check-And-Set (CAS) settings for PushSecret operations.
- Only applies to Vault KV v2 stores. When enabled, write operations must include
- the current version of the secret to prevent unintentional overwrites.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VaultUserPassAuth">VaultUserPassAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultUserPassAuth authenticates with Vault using UserPass authentication method,
- with the username and password stored in a Kubernetes Secret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the UserPassword authentication backend is mounted
- in Vault, e.g: “userpass”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Username is a username used to authenticate using the UserPass Vault
- authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef to a key in a Secret resource containing password for the
- user used to authenticate with Vault using the UserPass authentication
- method</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VolcengineAuth">VolcengineAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VolcengineProvider">VolcengineProvider</a>)
- </p>
- <p>
- <p>VolcengineAuth defines the authentication method for the Volcengine provider.
- Only one of the fields should be set.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.VolcengineAuthSecretRef">
- VolcengineAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef defines the static credentials to use for authentication.
- If not set, IRSA is used.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VolcengineAuthSecretRef">VolcengineAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.VolcengineAuth">VolcengineAuth</a>)
- </p>
- <p>
- <p>VolcengineAuthSecretRef defines the secret reference for static credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessKeyID</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>AccessKeyID is the reference to the secret containing the Access Key ID.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretAccessKey</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>SecretAccessKey is the reference to the secret containing the Secret Access Key.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>token</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Token is the reference to the secret containing the STS(Security Token Service) Token.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.VolcengineProvider">VolcengineProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>VolcengineProvider defines the configuration for the Volcengine provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Region specifies the Volcengine region to connect to.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.VolcengineAuth">
- VolcengineAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth defines the authentication method to use.
- If not specified, the provider will try to use IRSA (IAM Role for Service Account).</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.WebhookCAProvider">WebhookCAProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.WebhookProvider">WebhookProvider</a>)
- </p>
- <p>
- <p>WebhookCAProvider defines a location to fetch the cert for the webhook provider from.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1.WebhookCAProviderType">
- WebhookCAProviderType
- </a>
- </em>
- </td>
- <td>
- <p>The type of provider to use such as “Secret”, or “ConfigMap”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The name of the object located at the provider type.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The key where the CA certificate can be found in the Secret or ConfigMap.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The namespace the Provider type is in.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.WebhookCAProviderType">WebhookCAProviderType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.WebhookCAProvider">WebhookCAProvider</a>)
- </p>
- <p>
- <p>WebhookCAProviderType defines the type of provider for certificate authority in webhook connections.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ConfigMap"</p></td>
- <td><p>WebhookCAProviderTypeConfigMap indicates that the CA certificate is stored in a ConfigMap resource.</p>
- </td>
- </tr><tr><td><p>"Secret"</p></td>
- <td><p>WebhookCAProviderTypeSecret indicates that the CA certificate is stored in a Secret resource.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1.WebhookProvider">WebhookProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>WebhookProvider configures a store to sync secrets from simple web APIs.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>method</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Webhook Method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Webhook url to call</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>headers</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Headers</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.AuthorizationProtocol">
- AuthorizationProtocol
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth specifies a authorization protocol. Only one protocol may be set.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>body</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Body</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>timeout</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Timeout</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>result</code></br>
- <em>
- <a href="#external-secrets.io/v1.WebhookResult">
- WebhookResult
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Result formatting</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secrets</code></br>
- <em>
- <a href="#external-secrets.io/v1.WebhookSecret">
- []WebhookSecret
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Secrets to fill in templates
- These secrets will be passed to the templating function as key value pairs under the given name</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
- if the Server URL is using HTTPS protocol. This parameter is ignored for
- plain HTTP protocol connection. If not set the system root certificates
- are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.WebhookCAProvider">
- WebhookCAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.WebhookResult">WebhookResult
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.WebhookProvider">WebhookProvider</a>)
- </p>
- <p>
- <p>WebhookResult defines how to process and extract secrets from the webhook response.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>jsonPath</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Json path of return value</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.WebhookSecret">WebhookSecret
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.WebhookProvider">WebhookProvider</a>)
- </p>
- <p>
- <p>WebhookSecret defines a secret that will be passed to the webhook request.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name of this secret in templates</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Secret ref to fill in credentials</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.YandexAuth">YandexAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>,
- <a href="#external-secrets.io/v1.YandexLockboxProvider">YandexLockboxProvider</a>)
- </p>
- <p>
- <p>YandexAuth defines the authentication method for the Yandex provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>authorizedKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The authorized key used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.YandexCAProvider">YandexCAProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>,
- <a href="#external-secrets.io/v1.YandexLockboxProvider">YandexLockboxProvider</a>)
- </p>
- <p>
- <p>YandexCAProvider defines the configuration for Yandex custom certificate authority.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>certSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.YandexCertificateManagerProvider">YandexCertificateManagerProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>YandexCertificateManagerProvider Configures a store to sync secrets using the Yandex Certificate Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Yandex.Cloud API endpoint (e.g. ‘api.cloud.yandex.net:443’)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.YandexAuth">
- YandexAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against Yandex.Cloud</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.YandexCAProvider">
- YandexCAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>fetching</code></br>
- <em>
- <a href="#external-secrets.io/v1.FetchingPolicy">
- FetchingPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>FetchingPolicy configures the provider to interpret the <code>data.secretKey.remoteRef.key</code> field in ExternalSecret as certificate ID or certificate name</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1.YandexLockboxProvider">YandexLockboxProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Yandex.Cloud API endpoint (e.g. ‘api.cloud.yandex.net:443’)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1.YandexAuth">
- YandexAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against Yandex.Cloud</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1.YandexCAProvider">
- YandexCAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>fetching</code></br>
- <em>
- <a href="#external-secrets.io/v1.FetchingPolicy">
- FetchingPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>FetchingPolicy configures the provider to interpret the <code>data.secretKey.remoteRef.key</code> field in ExternalSecret as secret ID or secret name</p>
- </td>
- </tr>
- </tbody>
- </table>
- <hr/>
- <h2 id="external-secrets.io/v1alpha1">external-secrets.io/v1alpha1</h2>
- <p>
- <p>Package v1alpha1 contains resources for external-secrets</p>
- </p>
- <p>Resource Types:</p>
- <ul></ul>
- <h3 id="external-secrets.io/v1alpha1.ClusterPushSecret">ClusterPushSecret
- </h3>
- <p>
- <p>ClusterPushSecret is the Schema for the ClusterPushSecrets API that enables cluster-wide management of pushing Kubernetes secrets to external providers.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.ClusterPushSecretSpec">
- ClusterPushSecretSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>pushSecretSpec</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretSpec">
- PushSecretSpec
- </a>
- </em>
- </td>
- <td>
- <p>PushSecretSpec defines what to do with the secrets.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshTime</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>pushSecretName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The name of the push secrets to be created.
- Defaults to the name of the ClusterPushSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>pushSecretMetadata</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretMetadata">
- PushSecretMetadata
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The metadata of the external secrets to be created</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceSelectors</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#*k8s.io/apimachinery/pkg/apis/meta/v1.labelselector--">
- []*k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>A list of labels to select by to find the Namespaces to create the ExternalSecrets in. The selectors are ORed.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.ClusterPushSecretStatus">
- ClusterPushSecretStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.ClusterPushSecretCondition">ClusterPushSecretCondition
- </h3>
- <p>
- <p>ClusterPushSecretCondition used to refine PushSecrets to specific namespaces and names.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>namespaceSelector</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
- Kubernetes meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Choose namespace using a labelSelector</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaces</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Choose namespaces by name</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.ClusterPushSecretNamespaceFailure">ClusterPushSecretNamespaceFailure
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.ClusterPushSecretStatus">ClusterPushSecretStatus</a>)
- </p>
- <p>
- <p>ClusterPushSecretNamespaceFailure represents a failed namespace deployment and it’s reason.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Namespace is the namespace that failed when trying to apply an PushSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>reason</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Reason is why the PushSecret failed to apply to the namespace</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.ClusterPushSecretSpec">ClusterPushSecretSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.ClusterPushSecret">ClusterPushSecret</a>)
- </p>
- <p>
- <p>ClusterPushSecretSpec defines the configuration for a ClusterPushSecret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>pushSecretSpec</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretSpec">
- PushSecretSpec
- </a>
- </em>
- </td>
- <td>
- <p>PushSecretSpec defines what to do with the secrets.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshTime</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>pushSecretName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The name of the push secrets to be created.
- Defaults to the name of the ClusterPushSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>pushSecretMetadata</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretMetadata">
- PushSecretMetadata
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The metadata of the external secrets to be created</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceSelectors</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#*k8s.io/apimachinery/pkg/apis/meta/v1.labelselector--">
- []*k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>A list of labels to select by to find the Namespaces to create the ExternalSecrets in. The selectors are ORed.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.ClusterPushSecretStatus">ClusterPushSecretStatus
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.ClusterPushSecret">ClusterPushSecret</a>)
- </p>
- <p>
- <p>ClusterPushSecretStatus contains the status information for the ClusterPushSecret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>failedNamespaces</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.ClusterPushSecretNamespaceFailure">
- []ClusterPushSecretNamespaceFailure
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Failed namespaces are the namespaces that failed to apply an PushSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provisionedNamespaces</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ProvisionedNamespaces are the namespaces where the ClusterPushSecret has secrets</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>pushSecretName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretStatusCondition">
- []PushSecretStatusCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecret">PushSecret
- </h3>
- <p>
- <p>PushSecret is the Schema for the PushSecrets API that enables pushing Kubernetes secrets to external secret providers.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretSpec">
- PushSecretSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>The Interval to which External Secrets will try to push a secret definition</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretStoreRefs</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretStoreRef">
- []PushSecretStoreRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>updatePolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretUpdatePolicy">
- PushSecretUpdatePolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>UpdatePolicy to handle Secrets in the provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>deletionPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretDeletionPolicy">
- PushSecretDeletionPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Deletion Policy to handle Secrets in the provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>selector</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretSelector">
- PushSecretSelector
- </a>
- </em>
- </td>
- <td>
- <p>The Secret Selector (k8s source) for the Push Secret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretData">
- []PushSecretData
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Secret Data that should be pushed to providers</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>dataTo</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretDataTo">
- []PushSecretDataTo
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>DataTo defines bulk push rules that expand source Secret keys into provider entries.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>template</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretTemplate">
- ExternalSecretTemplate
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Template defines a blueprint for the created Secret resource.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretStatus">
- PushSecretStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretConditionType">PushSecretConditionType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretStatusCondition">PushSecretStatusCondition</a>)
- </p>
- <p>
- <p>PushSecretConditionType indicates the condition of the PushSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Ready"</p></td>
- <td><p>PushSecretReady indicates the PushSecret resource is ready.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretConversionStrategy">PushSecretConversionStrategy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretData">PushSecretData</a>,
- <a href="#external-secrets.io/v1alpha1.PushSecretDataTo">PushSecretDataTo</a>)
- </p>
- <p>
- <p>PushSecretConversionStrategy defines how secret values are converted when pushed to providers.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"None"</p></td>
- <td><p>PushSecretConversionNone indicates no conversion will be performed on the secret value.</p>
- </td>
- </tr><tr><td><p>"ReverseUnicode"</p></td>
- <td><p>PushSecretConversionReverseUnicode indicates that unicode escape sequences will be reversed.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretData">PushSecretData
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretSpec">PushSecretSpec</a>)
- </p>
- <p>
- <p>PushSecretData defines data to be pushed to the provider and associated metadata.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>match</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretMatch">
- PushSecretMatch
- </a>
- </em>
- </td>
- <td>
- <p>Match a given Secret Key to be pushed to the provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Metadata is metadata attached to the secret.
- The structure of metadata is provider specific, please look it up in the provider documentation.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conversionStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretConversionStrategy">
- PushSecretConversionStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a conversion Strategy for the secret keys</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretDataTo">PushSecretDataTo
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretSpec">PushSecretSpec</a>)
- </p>
- <p>
- <p>PushSecretDataTo defines how to bulk-push secrets to providers without explicit per-key mappings.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>storeRef</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretStoreRef">
- PushSecretStoreRef
- </a>
- </em>
- </td>
- <td>
- <p>StoreRef specifies which SecretStore to push to. Required.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>remoteKey</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>RemoteKey is the name of the single provider secret that will receive ALL
- matched keys bundled as a JSON object (e.g. {“DB_HOST”:“…”,“DB_USER”:“…”}).
- When set, per-key expansion is skipped and a single push is performed.
- The provider’s store prefix (if any) is still prepended to this value.
- When not set, each matched key is pushed as its own individual provider secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>match</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretDataToMatch">
- PushSecretDataToMatch
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Match pattern for selecting keys from the source Secret.
- If not specified, all keys are selected.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>rewrite</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretRewrite">
- []PushSecretRewrite
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Rewrite operations to transform keys before pushing to the provider.
- Operations are applied sequentially.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Metadata is metadata attached to the secret.
- The structure of metadata is provider specific, please look it up in the provider documentation.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conversionStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretConversionStrategy">
- PushSecretConversionStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a conversion Strategy for the secret keys</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretDataToMatch">PushSecretDataToMatch
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretDataTo">PushSecretDataTo</a>)
- </p>
- <p>
- <p>PushSecretDataToMatch defines pattern matching for key selection.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>regexp</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Regexp matches keys by regular expression.
- If not specified, all keys are matched.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretDeletionPolicy">PushSecretDeletionPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretSpec">PushSecretSpec</a>)
- </p>
- <p>
- <p>PushSecretDeletionPolicy defines how push secrets are deleted in the provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Delete"</p></td>
- <td><p>PushSecretDeletionPolicyDelete deletes secrets from the provider when the PushSecret is deleted.</p>
- </td>
- </tr><tr><td><p>"None"</p></td>
- <td><p>PushSecretDeletionPolicyNone keeps secrets in the provider when the PushSecret is deleted.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretMatch">PushSecretMatch
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretData">PushSecretData</a>)
- </p>
- <p>
- <p>PushSecretMatch defines how a source Secret key maps to a destination in the provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretKey</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Secret Key to be pushed</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>remoteRef</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretRemoteRef">
- PushSecretRemoteRef
- </a>
- </em>
- </td>
- <td>
- <p>Remote Refs to push to providers.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretMetadata">PushSecretMetadata
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.ClusterPushSecretSpec">ClusterPushSecretSpec</a>)
- </p>
- <p>
- <p>PushSecretMetadata defines metadata fields for the PushSecret generated by the ClusterPushSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>annotations</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>labels</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretRemoteRef">PushSecretRemoteRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretMatch">PushSecretMatch</a>)
- </p>
- <p>
- <p>PushSecretRemoteRef defines the location of the secret in the provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>remoteKey</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name of the resulting provider secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>property</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Name of the property in the resulting secret</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretRewrite">PushSecretRewrite
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretDataTo">PushSecretDataTo</a>)
- </p>
- <p>
- <p>PushSecretRewrite defines how to transform secret keys before pushing.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>regexp</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretRewriteRegexp">
- ExternalSecretRewriteRegexp
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to rewrite with regular expressions.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>transform</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretRewriteTransform">
- ExternalSecretRewriteTransform
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to apply string transformation on the secrets.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretSecret">PushSecretSecret
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretSelector">PushSecretSelector</a>)
- </p>
- <p>
- <p>PushSecretSecret defines a Secret that will be used as a source for pushing to providers.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Name of the Secret.
- The Secret must exist in the same namespace as the PushSecret manifest.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>selector</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
- Kubernetes meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Selector chooses secrets using a labelSelector.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretSelector">PushSecretSelector
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretSpec">PushSecretSpec</a>)
- </p>
- <p>
- <p>PushSecretSelector defines criteria for selecting the source Secret for pushing to providers.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secret</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretSecret">
- PushSecretSecret
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Select a Secret to Push.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>generatorRef</code></br>
- <em>
- <a href="#external-secrets.io/v1.GeneratorRef">
- GeneratorRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Point to a generator to create a Secret.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretSpec">PushSecretSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.ClusterPushSecretSpec">ClusterPushSecretSpec</a>,
- <a href="#external-secrets.io/v1alpha1.PushSecret">PushSecret</a>)
- </p>
- <p>
- <p>PushSecretSpec configures the behavior of the PushSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>The Interval to which External Secrets will try to push a secret definition</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretStoreRefs</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretStoreRef">
- []PushSecretStoreRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>updatePolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretUpdatePolicy">
- PushSecretUpdatePolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>UpdatePolicy to handle Secrets in the provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>deletionPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretDeletionPolicy">
- PushSecretDeletionPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Deletion Policy to handle Secrets in the provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>selector</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretSelector">
- PushSecretSelector
- </a>
- </em>
- </td>
- <td>
- <p>The Secret Selector (k8s source) for the Push Secret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretData">
- []PushSecretData
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Secret Data that should be pushed to providers</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>dataTo</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretDataTo">
- []PushSecretDataTo
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>DataTo defines bulk push rules that expand source Secret keys into provider entries.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>template</code></br>
- <em>
- <a href="#external-secrets.io/v1.ExternalSecretTemplate">
- ExternalSecretTemplate
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Template defines a blueprint for the created Secret resource.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretStatus">PushSecretStatus
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecret">PushSecret</a>)
- </p>
- <p>
- <p>PushSecretStatus indicates the history of the status of PushSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>refreshTime</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <p>refreshTime is the time and date the external secret was fetched and
- the target secret updated</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>syncedResourceVersion</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>SyncedResourceVersion keeps track of the last synced version.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>syncedPushSecrets</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.SyncedPushSecretsMap">
- SyncedPushSecretsMap
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Synced PushSecrets, including secrets that already exist in provider.
- Matches secret stores to PushSecretData that was stored to that secret store.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretStatusCondition">
- []PushSecretStatusCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretStatusCondition">PushSecretStatusCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.ClusterPushSecretStatus">ClusterPushSecretStatus</a>,
- <a href="#external-secrets.io/v1alpha1.PushSecretStatus">PushSecretStatus</a>)
- </p>
- <p>
- <p>PushSecretStatusCondition indicates the status of the PushSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1alpha1.PushSecretConditionType">
- PushSecretConditionType
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
- Kubernetes core/v1.ConditionStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>reason</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>message</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>lastTransitionTime</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretStoreRef">PushSecretStoreRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretDataTo">PushSecretDataTo</a>,
- <a href="#external-secrets.io/v1alpha1.PushSecretSpec">PushSecretSpec</a>)
- </p>
- <p>
- <p>PushSecretStoreRef contains a reference on how to sync to a SecretStore.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optionally, sync to the SecretStore of the given name</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>labelSelector</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
- Kubernetes meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optionally, sync to secret stores with label selector</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kind</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.PushSecretUpdatePolicy">PushSecretUpdatePolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretSpec">PushSecretSpec</a>)
- </p>
- <p>
- <p>PushSecretUpdatePolicy defines how push secrets are updated in the provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"IfNotExists"</p></td>
- <td><p>PushSecretUpdatePolicyIfNotExists only creates secrets that don’t exist in the provider.</p>
- </td>
- </tr><tr><td><p>"Replace"</p></td>
- <td><p>PushSecretUpdatePolicyReplace replaces existing secrets in the provider.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1alpha1.SyncedPushSecretsMap">SyncedPushSecretsMap
- (<code>map[string]map[string]github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1.PushSecretData</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1alpha1.PushSecretStatus">PushSecretStatus</a>)
- </p>
- <p>
- <p>SyncedPushSecretsMap is a map that tracks which PushSecretData was stored to which secret store.
- The outer map’s key is the secret store name, and the inner map’s key is the remote key name.</p>
- </p>
- <hr/>
- <h2 id="external-secrets.io/v1beta1">external-secrets.io/v1beta1</h2>
- <p>
- <p>Package v1beta1 contains resources for external-secrets</p>
- </p>
- <p>Resource Types:</p>
- <ul></ul>
- <h3 id="external-secrets.io/v1beta1.AWSAuth">AWSAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
- </p>
- <p>
- <p>AWSAuth tells the controller how to do authentication with aws.
- Only one of secretRef or jwt can be specified.
- if none is specified the controller will load credentials using the aws sdk defaults.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AWSAuthSecretRef">
- AWSAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AWSJWTAuth">
- AWSJWTAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AWSAuthSecretRef">AWSAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
- </p>
- <p>
- <p>AWSAuthSecretRef holds secret references for AWS credentials
- both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessKeyIDSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessKeyID is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretAccessKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SecretAccessKey is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sessionTokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SessionToken used for authentication
- This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
- 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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AWSJWTAuth">AWSJWTAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
- </p>
- <p>
- <p>AWSJWTAuth authenticates against AWS using service account tokens from the Kubernetes cluster.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AWSProvider">AWSProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>AWSProvider configures a store to sync secrets with AWS.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>service</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AWSServiceType">
- AWSServiceType
- </a>
- </em>
- </td>
- <td>
- <p>Service defines which service should be used to fetch the secrets</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AWSAuth">
- AWSAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth defines the information necessary to authenticate against AWS
- if not set aws sdk will infer credentials from your environment
- 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>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Role is a Role ARN which the provider will assume</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>AWS Region to be used for the provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>additionalRoles</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AdditionalRoles is a chained list of Role ARNs which the provider will sequentially assume before assuming the Role</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>AWS External ID set on assumed IAM roles</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sessionTags</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.*github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1.Tag">
- []*github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1.Tag
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AWS STS assume role session tags</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretsManager</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretsManager">
- SecretsManager
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretsManager defines how the provider behaves when interacting with AWS SecretsManager</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>transitiveTagKeys</code></br>
- <em>
- []*string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AWS STS assume role transitive session tags. Required when multiple rules are used with the provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>prefix</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Prefix adds a prefix to all retrieved values.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AWSServiceType">AWSServiceType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
- </p>
- <p>
- <p>AWSServiceType is an enum that defines the service/API that is used to fetch the secrets.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ParameterStore"</p></td>
- <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore service.
- 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>
- </td>
- </tr><tr><td><p>"SecretsManager"</p></td>
- <td><p>AWSServiceSecretsManager is the AWS SecretsManager service.
- 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>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>)
- </p>
- <p>
- <p>AkeylessAuth defines methods of authentication with Akeyless Vault.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AkeylessAuthSecretRef">
- AkeylessAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Reference to a Secret that contains the details
- to authenticate with Akeyless.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetesAuth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AkeylessKubernetesAuth">
- AkeylessKubernetesAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kubernetes authenticates with Akeyless by passing the ServiceAccount
- token stored in the named Secret resource.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
- </p>
- <p>
- <p>AkeylessAuthSecretRef defines how to authenticate using a secret reference.
- AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessID</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SecretAccessID is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessType</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessTypeParam</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AkeylessKubernetesAuth">AkeylessKubernetesAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
- </p>
- <p>
- <p>AkeylessKubernetesAuth authenticates with Akeyless using a Kubernetes ServiceAccount token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>the Akeyless Kubernetes auth-method access-id</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>k8sConfName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Kubernetes-auth configuration name in Akeyless-Gateway</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional service account field containing the name of a kubernetes ServiceAccount.
- If the service account is specified, the service account secret token JWT will be used
- for authenticating with Akeyless. If the service account selector is not supplied,
- the secretRef will be used instead.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
- for authenticating with Akeyless. If a name is specified without a key,
- <code>token</code> is the default. If one is not specified, the one bound to
- the controller will be used.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>akeylessGWApiURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>authSecretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AkeylessAuth">
- AkeylessAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the operator authenticates with Akeyless.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM/base64 encoded CA bundle used to validate Akeyless Gateway certificate. Only used
- if the AkeylessGWApiURL URL is using HTTPS protocol. If not set the system root certificates
- are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Akeyless Gateway certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider</a>)
- </p>
- <p>
- <p>AlibabaAuth contains a secretRef for credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AlibabaAuthSecretRef">
- AlibabaAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>rrsa</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AlibabaRRSAAuth">
- AlibabaRRSAAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
- </p>
- <p>
- <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessKeyIDSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessKeyID is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessKeySecretSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessKeySecret is used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AlibabaAuth">
- AlibabaAuth
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>regionID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Alibaba Region to be used for the provider</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AlibabaRRSAAuth">AlibabaRRSAAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
- </p>
- <p>
- <p>AlibabaRRSAAuth authenticates against Alibaba using RRSA (Resource-oriented RAM-based Service Authentication).</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>oidcProviderArn</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>oidcTokenFilePath</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>roleArn</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>sessionName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AuthorizationProtocol">AuthorizationProtocol
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
- </p>
- <p>
- <p>AuthorizationProtocol contains the protocol-specific configuration</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>ntlm</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.NTLMProtocol">
- NTLMProtocol
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>NTLMProtocol configures the store to use NTLM for auth</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AzureAuthType">AzureAuthType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
- </p>
- <p>
- <p>AzureAuthType describes how to authenticate to the Azure Keyvault.
- Only one of the following auth types may be specified.
- If none of the following auth type is specified, the default one
- is ServicePrincipal.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ManagedIdentity"</p></td>
- <td><p>AzureManagedIdentity uses Managed Identity to authenticate. Used with aad-pod-identity installed in the cluster.</p>
- </td>
- </tr><tr><td><p>"ServicePrincipal"</p></td>
- <td><p>AzureServicePrincipal uses service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.</p>
- </td>
- </tr><tr><td><p>"WorkloadIdentity"</p></td>
- <td><p>AzureWorkloadIdentity uses Workload Identity service accounts to authenticate.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AzureEnvironmentType">AzureEnvironmentType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
- </p>
- <p>
- <p>AzureEnvironmentType specifies the Azure cloud environment endpoints to use for
- connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
- 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>
- PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ChinaCloud"</p></td>
- <td><p>AzureEnvironmentChinaCloud represents the Azure China cloud environment.</p>
- </td>
- </tr><tr><td><p>"GermanCloud"</p></td>
- <td><p>AzureEnvironmentGermanCloud represents the Azure German cloud environment.</p>
- </td>
- </tr><tr><td><p>"PublicCloud"</p></td>
- <td><p>AzureEnvironmentPublicCloud represents the Azure public cloud environment.</p>
- </td>
- </tr><tr><td><p>"USGovernmentCloud"</p></td>
- <td><p>AzureEnvironmentUSGovernmentCloud represents the Azure US government cloud environment.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AzureKVAuth">AzureKVAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
- </p>
- <p>
- <p>AzureKVAuth defines configuration for authentication with Azure Key Vault.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The Azure clientId of the service principle or managed identity used for authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tenantId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The Azure tenantId of the managed identity used for authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientSecret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The Azure ClientSecret of the service principle used for authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientCertificate</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The Azure ClientCertificate of the service principle used for authentication.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>AzureKVProvider configures a store to sync secrets using Azure Key Vault.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>authType</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AzureAuthType">
- AzureAuthType
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth type defines how to authenticate to the keyvault service.
- Valid values are:
- - “ServicePrincipal” (default): Using a service principal (tenantId, clientId, clientSecret)
- - “ManagedIdentity”: Using Managed Identity assigned to the pod (see aad-pod-identity)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vaultUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Vault Url from which the secrets to be fetched from.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tenantId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type. Optional for WorkloadIdentity.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environmentType</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AzureEnvironmentType">
- AzureEnvironmentType
- </a>
- </em>
- </td>
- <td>
- <p>EnvironmentType specifies the Azure cloud environment endpoints to use for
- connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
- 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>
- PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>authSecretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AzureKVAuth">
- AzureKVAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type. Optional for WorkloadIdentity.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ServiceAccountRef specified the service account
- that should be used when authenticating with WorkloadIdentity.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>identityId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">BeyondTrustProviderSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.BeyondtrustAuth">BeyondtrustAuth</a>)
- </p>
- <p>
- <p>BeyondTrustProviderSecretRef defines a reference to a secret containing credentials for the BeyondTrust provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Value can be specified directly to set a value without using a secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef references a key in a secret that will be used as value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.BeyondtrustAuth">BeyondtrustAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.BeyondtrustProvider">BeyondtrustProvider</a>)
- </p>
- <p>
- <p>BeyondtrustAuth configures authentication for BeyondTrust Password Safe.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiKey</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
- BeyondTrustProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>APIKey If not provided then ClientID/ClientSecret become required.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientId</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
- BeyondTrustProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>ClientID is the API OAuth Client ID.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientSecret</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
- BeyondTrustProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>ClientSecret is the API OAuth Client Secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>certificate</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
- BeyondTrustProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>Certificate (cert.pem) for use when authenticating with an OAuth client Id using a Client Certificate.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>certificateKey</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
- BeyondTrustProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>Certificate private key (key.pem). For use when authenticating with an OAuth client Id</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.BeyondtrustProvider">BeyondtrustProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>BeyondtrustProvider defines configuration for the BeyondTrust Password Safe provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.BeyondtrustAuth">
- BeyondtrustAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the operator authenticates with Beyondtrust.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>server</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.BeyondtrustServer">
- BeyondtrustServer
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how API server works.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.BeyondtrustServer">BeyondtrustServer
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.BeyondtrustProvider">BeyondtrustProvider</a>)
- </p>
- <p>
- <p>BeyondtrustServer defines configuration for connecting to BeyondTrust Password Safe server.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>apiVersion</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrievalType</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The secret retrieval type. SECRET = Secrets Safe (credential, text, file). MANAGED_ACCOUNT = Password Safe account associated with a system.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>separator</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>A character that separates the folder names.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>decrypt</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>When true, the response includes the decrypted password. When false, the password field is omitted. This option only applies to the SECRET retrieval type. Default: true.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>verifyCA</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientTimeOutSeconds</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.BitwardenSecretsManagerAuth">BitwardenSecretsManagerAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerProvider">BitwardenSecretsManagerProvider</a>)
- </p>
- <p>
- <p>BitwardenSecretsManagerAuth contains the ref to the secret that contains the machine account token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerSecretRef">
- BitwardenSecretsManagerSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.BitwardenSecretsManagerProvider">BitwardenSecretsManagerProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>BitwardenSecretsManagerProvider configures a store to sync secrets with a Bitwarden Secrets Manager instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>identityURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>bitwardenServerSDKURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Base64 encoded certificate for the bitwarden server sdk. The sdk MUST run with HTTPS to make sure no MITM attack
- can be performed.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>organizationID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>OrganizationID determines which organization this secret store manages.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectID determines which project this secret store manages.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerAuth">
- BitwardenSecretsManagerAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with a bitwarden machine account instance.
- Make sure that the token being used has permissions on the given secret.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.BitwardenSecretsManagerSecretRef">BitwardenSecretsManagerSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerAuth">BitwardenSecretsManagerAuth</a>)
- </p>
- <p>
- <p>BitwardenSecretsManagerSecretRef contains the credential ref to the bitwarden instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>credentials</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>AccessToken used for the bitwarden instance.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.CAProvider">CAProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>,
- <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerProvider">BitwardenSecretsManagerProvider</a>,
- <a href="#external-secrets.io/v1beta1.ConjurProvider">ConjurProvider</a>,
- <a href="#external-secrets.io/v1beta1.GitlabProvider">GitlabProvider</a>,
- <a href="#external-secrets.io/v1beta1.KubernetesServer">KubernetesServer</a>,
- <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
- </p>
- <p>
- <p>CAProvider provides custom certificate authority (CA) certificates
- for a secret store. The CAProvider points to a Secret or ConfigMap resource
- that contains a PEM-encoded certificate.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CAProviderType">
- CAProviderType
- </a>
- </em>
- </td>
- <td>
- <p>The type of provider to use such as “Secret”, or “ConfigMap”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The name of the object located at the provider type.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The key where the CA certificate can be found in the Secret or ConfigMap.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The namespace the Provider type is in.
- Can only be defined when used in a ClusterSecretStore.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.CAProviderType">CAProviderType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.CAProvider">CAProvider</a>)
- </p>
- <p>
- <p>CAProviderType defines the type of provider to use for CA certificates.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ConfigMap"</p></td>
- <td><p>CAProviderTypeConfigMap indicates that the CA certificate is stored in a ConfigMap.</p>
- </td>
- </tr><tr><td><p>"Secret"</p></td>
- <td><p>CAProviderTypeSecret indicates that the CA certificate is stored in a Secret.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.CSMAuth">CSMAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.CloudruSMProvider">CloudruSMProvider</a>)
- </p>
- <p>
- <p>CSMAuth contains a secretRef for credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CSMAuthSecretRef">
- CSMAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.CSMAuthSecretRef">CSMAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.CSMAuth">CSMAuth</a>)
- </p>
- <p>
- <p>CSMAuthSecretRef holds secret references for Cloud.ru credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessKeyIDSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessKeyID is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessKeySecretSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessKeySecret is used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.CertAuth">CertAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
- </p>
- <p>
- <p>CertAuth defines certificate-based authentication for the Kubernetes provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientCert</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientKey</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ChefAuth">ChefAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ChefProvider">ChefProvider</a>)
- </p>
- <p>
- <p>ChefAuth contains a secretRef for credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ChefAuthSecretRef">
- ChefAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ChefAuthSecretRef">ChefAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ChefAuth">ChefAuth</a>)
- </p>
- <p>
- <p>ChefAuthSecretRef holds secret references for chef server login credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>privateKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>SecretKey is the Signing Key in PEM format, used for authentication.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ChefProvider">ChefProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>ChefProvider configures a store to sync secrets using basic chef server connection credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ChefAuth">
- ChefAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against chef Server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>UserName should be the user ID on the chef server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serverUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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 “/”</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.CloudruSMProvider">CloudruSMProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>CloudruSMProvider configures a store to sync secrets using the Cloud.ru Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CSMAuth">
- CSMAuth
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectID is the project, which the secrets are stored in.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret
- </h3>
- <p>
- <p>ClusterExternalSecret is the schema for the clusterexternalsecrets API.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">
- ClusterExternalSecretSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>externalSecretSpec</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
- ExternalSecretSpec
- </a>
- </em>
- </td>
- <td>
- <p>The spec for the ExternalSecrets to be created</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalSecretName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The name of the external secrets to be created.
- Defaults to the name of the ClusterExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalSecretMetadata</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretMetadata">
- ExternalSecretMetadata
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The metadata of the external secrets to be created</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceSelector</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
- Kubernetes meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <p>The labels to select by to find the Namespaces to create the ExternalSecrets in</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceSelectors</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#*k8s.io/apimachinery/pkg/apis/meta/v1.labelselector--">
- []*k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>A list of labels to select by to find the Namespaces to create the ExternalSecrets in. The selectors are ORed.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaces</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Choose namespaces by name. This field is ORed with anything that NamespaceSelectors ends up choosing.</p>
- <p>Deprecated: Use NamespaceSelectors instead.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshTime</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">
- ClusterExternalSecretStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretConditionType">ClusterExternalSecretConditionType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition</a>)
- </p>
- <p>
- <p>ClusterExternalSecretConditionType indicates the condition of the ClusterExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Ready"</p></td>
- <td><p>ClusterExternalSecretReady indicates the ClusterExternalSecret resource is ready.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">ClusterExternalSecretNamespaceFailure
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
- </p>
- <p>
- <p>ClusterExternalSecretNamespaceFailure represents a failed namespace deployment and it’s reason.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Namespace is the namespace that failed when trying to apply an ExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>reason</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Reason is why the ExternalSecret failed to apply to the namespace</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
- </p>
- <p>
- <p>ClusterExternalSecretSpec defines the desired state of ClusterExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>externalSecretSpec</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
- ExternalSecretSpec
- </a>
- </em>
- </td>
- <td>
- <p>The spec for the ExternalSecrets to be created</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalSecretName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The name of the external secrets to be created.
- Defaults to the name of the ClusterExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalSecretMetadata</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretMetadata">
- ExternalSecretMetadata
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The metadata of the external secrets to be created</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceSelector</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
- Kubernetes meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <p>The labels to select by to find the Namespaces to create the ExternalSecrets in</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceSelectors</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#*k8s.io/apimachinery/pkg/apis/meta/v1.labelselector--">
- []*k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>A list of labels to select by to find the Namespaces to create the ExternalSecrets in. The selectors are ORed.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaces</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Choose namespaces by name. This field is ORed with anything that NamespaceSelectors ends up choosing.</p>
- <p>Deprecated: Use NamespaceSelectors instead.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshTime</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
- </p>
- <p>
- <p>ClusterExternalSecretStatus defines the observed state of ClusterExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>externalSecretName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ExternalSecretName is the name of the ExternalSecrets created by the ClusterExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>failedNamespaces</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">
- []ClusterExternalSecretNamespaceFailure
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Failed namespaces are the namespaces that failed to apply an ExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provisionedNamespaces</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ProvisionedNamespaces are the namespaces where the ClusterExternalSecret has secrets</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">
- []ClusterExternalSecretStatusCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
- </p>
- <p>
- <p>ClusterExternalSecretStatusCondition indicates the status of the ClusterExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretConditionType">
- ClusterExternalSecretConditionType
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
- Kubernetes core/v1.ConditionStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>message</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore
- </h3>
- <p>
- <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
- SecretStoreSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
- The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
- SecretStoreProvider
- </a>
- </em>
- </td>
- <td>
- <p>Used to configure the provider. Only one provider may be set</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrySettings</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
- SecretStoreRetrySettings
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure HTTP retries on failures.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
- []ClusterSecretStoreCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to constrain a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
- SecretStoreStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterSecretStoreCondition">ClusterSecretStoreCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
- </p>
- <p>
- <p>ClusterSecretStoreCondition describes a condition by which to choose namespaces to process ExternalSecrets in
- for a ClusterSecretStore instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>namespaceSelector</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
- Kubernetes meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Choose namespace using a labelSelector</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaces</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Choose namespaces by name</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceRegexes</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Choose namespaces by using regex matching</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ConjurAPIKey">ConjurAPIKey
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ConjurAuth">ConjurAuth</a>)
- </p>
- <p>
- <p>ConjurAPIKey defines authentication using a Conjur API key.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>account</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Account is the Conjur organization account name.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>userRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>A reference to a specific ‘key’ containing the Conjur username
- within a Secret resource. In some instances, <code>key</code> is a required field.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>apiKeyRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>A reference to a specific ‘key’ containing the Conjur API key
- within a Secret resource. In some instances, <code>key</code> is a required field.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ConjurAuth">ConjurAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ConjurProvider">ConjurProvider</a>)
- </p>
- <p>
- <p>ConjurAuth defines the methods of authentication with Conjur.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apikey</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ConjurAPIKey">
- ConjurAPIKey
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Authenticates with Conjur using an API key.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ConjurJWT">
- ConjurJWT
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Jwt enables JWT authentication using Kubernetes service account tokens.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ConjurJWT">ConjurJWT
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ConjurAuth">ConjurAuth</a>)
- </p>
- <p>
- <p>ConjurJWT defines authentication using a JWT service account token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>account</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Account is the Conjur organization account name.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The conjur authn jwt webservice id</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>hostId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional HostID for JWT authentication. This may be used depending
- on how the Conjur JWT authenticator policy is configured.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
- authenticate with Conjur using the JWT authentication method.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional ServiceAccountRef specifies the Kubernetes service account for which to request
- a token for with the <code>TokenRequest</code> API.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ConjurProvider">ConjurProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>ConjurProvider defines configuration for the CyberArk Conjur provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL is the endpoint of the Conjur instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CABundle is a PEM encoded CA bundle that will be used to validate the Conjur server certificate.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to provide custom certificate authority (CA) certificates
- for a secret store. The CAProvider points to a Secret or ConfigMap resource
- that contains a PEM-encoded certificate.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ConjurAuth">
- ConjurAuth
- </a>
- </em>
- </td>
- <td>
- <p>Defines authentication settings for connecting to Conjur.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.DelineaProvider">DelineaProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>DelineaProvider defines configuration for the Delinea DevOps Secrets Vault provider.
- 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>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientId</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.DelineaProviderSecretRef">
- DelineaProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>ClientID is the non-secret part of the credential.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientSecret</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.DelineaProviderSecretRef">
- DelineaProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>ClientSecret is the secret part of the credential.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tenant</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Tenant is the chosen hostname / site name.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>urlTemplate</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>URLTemplate
- If unset, defaults to “https://%s.secretsvaultcloud.%s/v1/%s%s”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tld</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>TLD is based on the server location that was chosen during provisioning.
- If unset, defaults to “com”.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.DelineaProviderSecretRef">DelineaProviderSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.DelineaProvider">DelineaProvider</a>)
- </p>
- <p>
- <p>DelineaProviderSecretRef defines a reference to a secret containing credentials for the Delinea provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Value can be specified directly to set a value without using a secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef references a key in a secret that will be used as value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.Device42Auth">Device42Auth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.Device42Provider">Device42Provider</a>)
- </p>
- <p>
- <p>Device42Auth defines the authentication method for the Device42 provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.Device42SecretRef">
- Device42SecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.Device42Provider">Device42Provider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>Device42Provider configures a store to sync secrets with a Device42 instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>host</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL configures the Device42 instance URL.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.Device42Auth">
- Device42Auth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with a Device42 instance.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.Device42SecretRef">Device42SecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.Device42Auth">Device42Auth</a>)
- </p>
- <p>
- <p>Device42SecretRef defines a reference to a secret containing credentials for the Device42 provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>credentials</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Username / Password is used for authentication.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.DopplerAuth">DopplerAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.DopplerProvider">DopplerProvider</a>)
- </p>
- <p>
- <p>DopplerAuth defines the authentication method for the Doppler provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.DopplerAuthSecretRef">
- DopplerAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.DopplerAuthSecretRef">DopplerAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.DopplerAuth">DopplerAuth</a>)
- </p>
- <p>
- <p>DopplerAuthSecretRef defines a reference to a secret containing credentials for the Doppler provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>dopplerToken</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The DopplerToken is used for authentication.
- See <a href="https://docs.doppler.com/reference/api#authentication">https://docs.doppler.com/reference/api#authentication</a> for auth token types.
- The Key attribute defaults to dopplerToken if not specified.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.DopplerProvider">DopplerProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>DopplerProvider configures a store to sync secrets using the Doppler provider.
- Project and Config are required if not using a Service Token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.DopplerAuth">
- DopplerAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the Operator authenticates with the Doppler API</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>project</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Doppler project (required if not using a Service Token)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>config</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Doppler config (required if not using a Service Token)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>nameTransformer</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Environment variable compatible name transforms that change secret names to a different format</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>format</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Format enables the downloading of secrets as a file (string)</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecret">ExternalSecret
- </h3>
- <p>
- <p>ExternalSecret is the schema for the external-secrets API.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
- ExternalSecretSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>secretStoreRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreRef">
- SecretStoreRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>target</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
- ExternalSecretTarget
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretRefreshPolicy">
- ExternalSecretRefreshPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>RefreshPolicy determines how the ExternalSecret should be refreshed:
- - CreatedOnce: Creates the Secret only if it does not exist and does not update it thereafter
- - Periodic: Synchronizes the Secret from the external source at regular intervals specified by refreshInterval.
- No periodic updates occur if refreshInterval is 0.
- - OnChange: Only synchronizes the Secret when the ExternalSecret’s metadata or specification changes</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider,
- specified as Golang Duration strings.
- Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”
- Example values: “1h0m0s”, “2h30m0s”, “10m0s”
- May be set to “0s” to fetch and create it once. Defaults to 1h0m0s.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretData">
- []ExternalSecretData
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>dataFrom</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
- []ExternalSecretDataFromRemoteRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>DataFrom is used to fetch all properties from a specific Provider data
- If multiple entries are specified, the Secret keys are merged in the specified order</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">
- ExternalSecretStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretConditionType">ExternalSecretConditionType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
- </p>
- <p>
- <p>ExternalSecretConditionType defines the condition type for an ExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Deleted"</p></td>
- <td><p>ExternalSecretDeleted indicates the ExternalSecret has been deleted.</p>
- </td>
- </tr><tr><td><p>"Ready"</p></td>
- <td><p>ExternalSecretReady indicates the ExternalSecret has been successfully reconciled.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretConversionStrategy">ExternalSecretConversionStrategy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
- <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
- </p>
- <p>
- <p>ExternalSecretConversionStrategy defines how secret values are converted.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Default"</p></td>
- <td><p>ExternalSecretConversionDefault indicates the default conversion strategy.</p>
- </td>
- </tr><tr><td><p>"Unicode"</p></td>
- <td><p>ExternalSecretConversionUnicode indicates that unicode conversion will be performed.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
- </p>
- <p>
- <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Merge"</p></td>
- <td><p>CreatePolicyMerge does not create the Secret, but merges the data fields to the Secret.</p>
- </td>
- </tr><tr><td><p>"None"</p></td>
- <td><p>CreatePolicyNone does not create a Secret (future use with injector).</p>
- </td>
- </tr><tr><td><p>"Orphan"</p></td>
- <td><p>CreatePolicyOrphan creates the Secret and does not set the ownerReference.
- I.e. it will be orphaned after the deletion of the ExternalSecret.</p>
- </td>
- </tr><tr><td><p>"Owner"</p></td>
- <td><p>CreatePolicyOwner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretKey</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The key in the Kubernetes Secret to store the value.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>remoteRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
- ExternalSecretDataRemoteRef
- </a>
- </em>
- </td>
- <td>
- <p>RemoteRef points to the remote secret and defines
- which secret (version/property/..) to fetch.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sourceRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.StoreSourceRef">
- StoreSourceRef
- </a>
- </em>
- </td>
- <td>
- <p>SourceRef allows you to override the source
- from which the value will be pulled.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretDataFromRemoteRef defines a reference to multiple secrets in the provider to be fetched using options.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>extract</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
- ExternalSecretDataRemoteRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to extract multiple key/value pairs from one secret
- Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>find</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretFind">
- ExternalSecretFind
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to find secrets based on tags or regular expressions
- Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>rewrite</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">
- []ExternalSecretRewrite
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to rewrite secret Keys after getting them from the secret Provider
- Multiple Rewrite operations can be provided. They are applied in a layered order (first to last)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sourceRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">
- StoreGeneratorSourceRef
- </a>
- </em>
- </td>
- <td>
- <p>SourceRef points to a store or generator
- which contains secret values ready to use.
- Use this in combination with Extract or Find pull values out of
- a specific SecretStore.
- When sourceRef points to a generator Extract or Find is not supported.
- The generator returns a static map of values</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>,
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
- </p>
- <p>
- <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Key is the key used in the Provider, mandatory</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>metadataPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">
- ExternalSecretMetadataPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>property</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select a specific property of the Provider value (if a map), if supported</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>version</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select a specific version of the Provider value, if supported</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conversionStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
- ExternalSecretConversionStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a conversion Strategy</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>decodingStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
- ExternalSecretDecodingStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a decoding Strategy</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">ExternalSecretDecodingStrategy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
- <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
- </p>
- <p>
- <p>ExternalSecretDecodingStrategy defines how secret values are decoded.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Auto"</p></td>
- <td><p>ExternalSecretDecodeAuto indicates that the decoding strategy will be automatically determined.</p>
- </td>
- </tr><tr><td><p>"Base64"</p></td>
- <td><p>ExternalSecretDecodeBase64 indicates that base64 decoding will be used.</p>
- </td>
- </tr><tr><td><p>"Base64URL"</p></td>
- <td><p>ExternalSecretDecodeBase64URL indicates that base64url decoding will be used.</p>
- </td>
- </tr><tr><td><p>"None"</p></td>
- <td><p>ExternalSecretDecodeNone indicates that no decoding will be performed.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">ExternalSecretDeletionPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
- </p>
- <p>
- <p>ExternalSecretDeletionPolicy defines rules on how to delete the resulting Secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Delete"</p></td>
- <td><p>DeletionPolicyDelete deletes the secret if all provider secrets are deleted.
- If a secret gets deleted on the provider side and is not accessible
- anymore this is not considered an error and the ExternalSecret
- does not go into SecretSyncedError status.</p>
- </td>
- </tr><tr><td><p>"Merge"</p></td>
- <td><p>DeletionPolicyMerge removes keys in the secret, but not the secret itself.
- If a secret gets deleted on the provider side and is not accessible
- anymore this is not considered an error and the ExternalSecret
- does not go into SecretSyncedError status.</p>
- </td>
- </tr><tr><td><p>"Retain"</p></td>
- <td><p>DeletionPolicyRetain will retain the secret if all provider secrets have been deleted.
- If a provider secret does not exist the ExternalSecret gets into the
- SecretSyncedError status.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
- </p>
- <p>
- <p>ExternalSecretFind defines criteria for finding secrets in the provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>A root path to start the find operations.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.FindName">
- FindName
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Finds secrets based on the name.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tags</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Find secrets based on tags.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conversionStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
- ExternalSecretConversionStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a conversion Strategy</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>decodingStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
- ExternalSecretDecodingStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a decoding Strategy</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadata">ExternalSecretMetadata
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretMetadata defines metadata fields for the ExternalSecret generated by the ClusterExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>annotations</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>labels</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">ExternalSecretMetadataPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>)
- </p>
- <p>
- <p>ExternalSecretMetadataPolicy defines the policy for fetching tags/labels from provider secrets.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Fetch"</p></td>
- <td><p>ExternalSecretMetadataPolicyFetch indicates that metadata will be fetched from the provider.</p>
- </td>
- </tr><tr><td><p>"None"</p></td>
- <td><p>ExternalSecretMetadataPolicyNone indicates that no metadata will be fetched.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretRefreshPolicy">ExternalSecretRefreshPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretRefreshPolicy defines how and when the ExternalSecret should be refreshed.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"CreatedOnce"</p></td>
- <td><p>RefreshPolicyCreatedOnce creates the Secret only if it does not exist and does not update it thereafter.</p>
- </td>
- </tr><tr><td><p>"OnChange"</p></td>
- <td><p>RefreshPolicyOnChange only synchronizes the Secret when the ExternalSecret’s metadata or specification changes.</p>
- </td>
- </tr><tr><td><p>"Periodic"</p></td>
- <td><p>RefreshPolicyPeriodic synchronizes the Secret from the external source at regular intervals.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
- </p>
- <p>
- <p>ExternalSecretRewrite defines rules on how to rewrite secret keys.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>regexp</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">
- ExternalSecretRewriteRegexp
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to rewrite with regular expressions.
- The resulting key will be the output of a regexp.ReplaceAll operation.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>transform</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretRewriteTransform">
- ExternalSecretRewriteTransform
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to apply string transformation on the secrets.
- The resulting key will be the output of the template applied by the operation.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">ExternalSecretRewriteRegexp
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
- </p>
- <p>
- <p>ExternalSecretRewriteRegexp defines how to use regular expressions for rewriting secret keys.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>source</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Used to define the regular expression of a re.Compiler.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>target</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Used to define the target pattern of a ReplaceAll operation.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretRewriteTransform">ExternalSecretRewriteTransform
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
- </p>
- <p>
- <p>ExternalSecretRewriteTransform defines how to use string templates for transforming secret keys.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>template</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Used to define the template to apply on the secret name.
- <code>.value</code> will specify the secret name in the template.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>,
- <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
- </p>
- <p>
- <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretStoreRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreRef">
- SecretStoreRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>target</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
- ExternalSecretTarget
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretRefreshPolicy">
- ExternalSecretRefreshPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>RefreshPolicy determines how the ExternalSecret should be refreshed:
- - CreatedOnce: Creates the Secret only if it does not exist and does not update it thereafter
- - Periodic: Synchronizes the Secret from the external source at regular intervals specified by refreshInterval.
- No periodic updates occur if refreshInterval is 0.
- - OnChange: Only synchronizes the Secret when the ExternalSecret’s metadata or specification changes</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider,
- specified as Golang Duration strings.
- Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”
- Example values: “1h0m0s”, “2h30m0s”, “10m0s”
- May be set to “0s” to fetch and create it once. Defaults to 1h0m0s.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretData">
- []ExternalSecretData
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>dataFrom</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
- []ExternalSecretDataFromRemoteRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>DataFrom is used to fetch all properties from a specific Provider data
- If multiple entries are specified, the Secret keys are merged in the specified order</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
- </p>
- <p>
- <p>ExternalSecretStatus defines the observed state of ExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>refreshTime</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <p>refreshTime is the time and date the external secret was fetched and
- the target secret updated</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>syncedResourceVersion</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>SyncedResourceVersion keeps track of the last synced version</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">
- []ExternalSecretStatusCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>binding</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#localobjectreference-v1-core">
- Kubernetes core/v1.LocalObjectReference
- </a>
- </em>
- </td>
- <td>
- <p>Binding represents a servicebinding.io Provisioned Service reference to the secret</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus</a>)
- </p>
- <p>
- <p>ExternalSecretStatusCondition contains condition information for an ExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretConditionType">
- ExternalSecretConditionType
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
- Kubernetes core/v1.ConditionStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>reason</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>message</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>lastTransitionTime</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretTarget defines the Kubernetes Secret to be created
- There can be only one target per ExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The name of the Secret resource to be managed.
- Defaults to the .metadata.name of the ExternalSecret resource</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>creationPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretCreationPolicy">
- ExternalSecretCreationPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CreationPolicy defines rules on how to create the resulting Secret.
- Defaults to “Owner”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>deletionPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">
- ExternalSecretDeletionPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>DeletionPolicy defines rules on how to delete the resulting Secret.
- Defaults to “Retain”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>template</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">
- ExternalSecretTemplate
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Template defines a blueprint for the created Secret resource.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>immutable</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Immutable defines if the final secret will be immutable</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
- </p>
- <p>
- <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
- 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>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secrettype-v1-core">
- Kubernetes core/v1.SecretType
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>engineVersion</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateEngineVersion">
- TemplateEngineVersion
- </a>
- </em>
- </td>
- <td>
- <p>EngineVersion specifies the template engine version
- that should be used to compile/execute the
- template specified in .data and .templateFrom[].</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">
- ExternalSecretTemplateMetadata
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>mergePolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateMergePolicy">
- TemplateMergePolicy
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>templateFrom</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateFrom">
- []TemplateFrom
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
- </p>
- <p>
- <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>annotations</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>labels</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretValidator">ExternalSecretValidator
- </h3>
- <p>
- <p>ExternalSecretValidator implements a validating webhook for ExternalSecrets.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.FakeProvider">FakeProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>FakeProvider configures a fake provider that returns static values.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.FakeProviderData">
- []FakeProviderData
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.FakeProviderData">FakeProviderData
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.FakeProvider">FakeProvider</a>)
- </p>
- <p>
- <p>FakeProviderData defines a key-value pair for the fake provider used in testing.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>version</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.FindName">FindName
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
- </p>
- <p>
- <p>FindName defines name matching criteria for finding secrets.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>regexp</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Finds secrets base</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.FortanixProvider">FortanixProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>FortanixProvider configures a store to sync secrets using the Fortanix SDKMS provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>APIURL is the URL of SDKMS API. Defaults to <code>sdkms.fortanix.com</code>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>apiKey</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.FortanixProviderSecretRef">
- FortanixProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>APIKey is the API token to access SDKMS Applications.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.FortanixProviderSecretRef">FortanixProviderSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.FortanixProvider">FortanixProvider</a>)
- </p>
- <p>
- <p>FortanixProviderSecretRef defines a reference to a secret containing credentials for the Fortanix provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>SecretRef is a reference to a secret containing the SDKMS API Key.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider</a>)
- </p>
- <p>
- <p>GCPSMAuth defines the authentication methods for the GCP Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GCPSMAuthSecretRef">
- GCPSMAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>workloadIdentity</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GCPWorkloadIdentity">
- GCPWorkloadIdentity
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
- </p>
- <p>
- <p>GCPSMAuthSecretRef defines a reference to a secret containing credentials for the GCP Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretAccessKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The SecretAccessKey is used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GCPSMAuth">
- GCPSMAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth defines the information necessary to authenticate against GCP</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectID project where secret is located</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>location</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Location optionally defines a location for a secret</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GCPWorkloadIdentity">GCPWorkloadIdentity
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
- </p>
- <p>
- <p>GCPWorkloadIdentity defines configuration for using GCP Workload Identity authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clusterLocation</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ClusterLocation is the location of the cluster
- If not specified, it fetches information from the metadata server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clusterName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ClusterName is the name of the cluster
- If not specified, it fetches information from the metadata server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clusterProjectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ClusterProjectID is the project ID of the cluster
- If not specified, it fetches information from the metadata server</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GeneratorRef">GeneratorRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef</a>,
- <a href="#external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef</a>)
- </p>
- <p>
- <p>GeneratorRef points to a generator custom resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiVersion</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Specify the apiVersion of the generator resource</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kind</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Specify the Kind of the generator resource</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Specify the name of the generator resource</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GenericClusterStoreValidator">GenericClusterStoreValidator
- </h3>
- <p>
- <p>GenericClusterStoreValidator provides validation for ClusterSecretStore resources.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.GenericStore">GenericStore
- </h3>
- <p>
- <p>GenericStore is a common interface for interacting with ClusterSecretStore
- or a namespaced SecretStore.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.GenericStoreValidator">GenericStoreValidator
- </h3>
- <p>
- <p>GenericStoreValidator provides validation for SecretStore resources.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.GithubAppAuth">GithubAppAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.GithubProvider">GithubProvider</a>)
- </p>
- <p>
- <p>GithubAppAuth defines the GitHub App authentication mechanism for the GitHub provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>privateKey</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GithubProvider">GithubProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>GithubProvider configures a store to push secrets to Github Actions.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL configures the Github instance URL. Defaults to <a href="https://github.com/">https://github.com/</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>uploadURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Upload URL for enterprise instances. Default to URL.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GithubAppAuth">
- GithubAppAuth
- </a>
- </em>
- </td>
- <td>
- <p>auth configures how secret-manager authenticates with a Github instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>appID</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- <p>appID specifies the Github APP that will be used to authenticate the client</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>installationID</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- <p>installationID specifies the Github APP installation that will be used to authenticate the client</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>organization</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>organization will be used to fetch secrets from the Github organization</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>repository</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>repository will be used to fetch secrets from the Github repository within an organization</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>environment will be used to fetch secrets from a particular environment within a github repository</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GitlabAuth">GitlabAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.GitlabProvider">GitlabProvider</a>)
- </p>
- <p>
- <p>GitlabAuth defines the authentication method for the GitLab provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>SecretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GitlabSecretRef">
- GitlabSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GitlabProvider">GitlabProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>GitlabProvider configures a store to sync secrets with a GitLab instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GitlabAuth">
- GitlabAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectID specifies a project where secrets are located.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>inheritFromGroups</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <p>InheritFromGroups specifies whether parent groups should be discovered and checked for secrets.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>groupIDs</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <p>GroupIDs specify, which gitlab groups to pull secrets from. Group secrets are read from left to right followed by the project variables.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Base64 encoded certificate for the GitLab server sdk. The sdk MUST run with HTTPS to make sure no MITM attack
- can be performed.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GitlabSecretRef">GitlabSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.GitlabAuth">GitlabAuth</a>)
- </p>
- <p>
- <p>GitlabSecretRef defines a reference to a secret containing credentials for the GitLab provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessToken</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>AccessToken is used for authentication.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.IBMAuth">IBMAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.IBMProvider">IBMProvider</a>)
- </p>
- <p>
- <p>IBMAuth defines the authentication methods for the IBM Cloud Secrets Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.IBMAuthSecretRef">
- IBMAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>containerAuth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.IBMAuthContainerAuth">
- IBMAuthContainerAuth
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.IBMAuthContainerAuth">IBMAuthContainerAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
- </p>
- <p>
- <p>IBMAuthContainerAuth defines authentication using IBM Container-based auth with IAM Trusted Profile.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>profile</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>the IBM Trusted Profile</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tokenLocation</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Location the token is mounted on the pod</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>iamEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.IBMAuthSecretRef">IBMAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
- </p>
- <p>
- <p>IBMAuthSecretRef defines a reference to a secret containing credentials for the IBM provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretApiKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SecretAccessKey is used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.IBMProvider">IBMProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>IBMProvider configures a store to sync secrets using a IBM Cloud Secrets Manager backend.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.IBMAuth">
- IBMAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.InfisicalAuth">InfisicalAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.InfisicalProvider">InfisicalProvider</a>)
- </p>
- <p>
- <p>InfisicalAuth defines the authentication methods for the Infisical provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>universalAuthCredentials</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.UniversalAuthCredentials">
- UniversalAuthCredentials
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.InfisicalProvider">InfisicalProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>InfisicalProvider configures a store to sync secrets using the Infisical provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.InfisicalAuth">
- InfisicalAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the Operator authenticates with the Infisical API</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretsScope</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.MachineIdentityScopeInWorkspace">
- MachineIdentityScopeInWorkspace
- </a>
- </em>
- </td>
- <td>
- <p>SecretsScope defines the scope of the secrets within the workspace</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>hostAPI</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>HostAPI specifies the base URL of the Infisical API. If not provided, it defaults to “<a href="https://app.infisical.com/api"">https://app.infisical.com/api”</a>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.KeeperSecurityProvider">KeeperSecurityProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>KeeperSecurityProvider Configures a store to sync secrets using Keeper Security.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>authRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>folderID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
- </p>
- <p>
- <p>KubernetesAuth defines authentication methods for the Kubernetes provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>cert</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CertAuth">
- CertAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>has both clientCert and clientKey as secretKeySelector</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>token</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TokenAuth">
- TokenAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>use static token to authenticate with</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccount</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>points to a service account that should be used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>KubernetesProvider configures a store to sync secrets with a Kubernetes instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>server</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.KubernetesServer">
- KubernetesServer
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>configures the Kubernetes server Address.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.KubernetesAuth">
- KubernetesAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth configures how secret-manager authenticates with a Kubernetes instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>authRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>A reference to a secret that contains the auth information.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>remoteNamespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Remote namespace to fetch the secrets from</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.KubernetesServer">KubernetesServer
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
- </p>
- <p>
- <p>KubernetesServer defines the Kubernetes server connection configuration.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>configures the Kubernetes server Address.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CABundle is a base64-encoded CA certificate</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.MachineIdentityScopeInWorkspace">MachineIdentityScopeInWorkspace
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.InfisicalProvider">InfisicalProvider</a>)
- </p>
- <p>
- <p>MachineIdentityScopeInWorkspace defines the scope of a machine identity in an Infisical workspace.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretsPath</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretsPath specifies the path to the secrets within the workspace. Defaults to “/” if not provided.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>recursive</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Recursive indicates whether the secrets should be fetched recursively. Defaults to false if not provided.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environmentSlug</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>EnvironmentSlug is the required slug identifier for the environment.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectSlug</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectSlug is the required slug identifier for the project.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>expandSecretReferences</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ExpandSecretReferences indicates whether secret references should be expanded. Defaults to true if not provided.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.NTLMProtocol">NTLMProtocol
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AuthorizationProtocol">AuthorizationProtocol</a>)
- </p>
- <p>
- <p>NTLMProtocol contains the NTLM-specific configuration.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>usernameSecret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>passwordSecret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.NoSecretError">NoSecretError
- </h3>
- <p>
- <p>NoSecretError shall be returned when a GetSecret can not find the
- desired secret. This is used for deletionPolicy.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.NotModifiedError">NotModifiedError
- </h3>
- <p>
- <p>NotModifiedError to signal that the webhook received no changes,
- and it should just return without doing anything.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.OnboardbaseAuthSecretRef">OnboardbaseAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.OnboardbaseProvider">OnboardbaseProvider</a>)
- </p>
- <p>
- <p>OnboardbaseAuthSecretRef holds secret references for onboardbase API Key credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiKeyRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>OnboardbaseAPIKey is the APIKey generated by an admin account.
- It is used to recognize and authorize access to a project and environment within onboardbase</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>passcodeRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>OnboardbasePasscode is the passcode attached to the API Key</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.OnboardbaseProvider">OnboardbaseProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>OnboardbaseProvider configures a store to sync secrets using the Onboardbase provider.
- Project and Config are required if not using a Service Token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OnboardbaseAuthSecretRef">
- OnboardbaseAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the Operator authenticates with the Onboardbase API</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>apiHost</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>project</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Project is an onboardbase project that the secrets should be pulled from</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Environment is the name of an environmnent within a project to pull the secrets from</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider</a>)
- </p>
- <p>
- <p>OnePasswordAuth contains a secretRef for credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OnePasswordAuthSecretRef">
- OnePasswordAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.OnePasswordAuthSecretRef">OnePasswordAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth</a>)
- </p>
- <p>
- <p>OnePasswordAuthSecretRef holds secret references for 1Password credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>connectTokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The ConnectToken is used for authentication to a 1Password Connect Server.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>OnePasswordProvider configures a store to sync secrets using the 1Password Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OnePasswordAuth">
- OnePasswordAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against OnePassword Connect Server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>connectHost</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ConnectHost defines the OnePassword Connect Server to connect to</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vaults</code></br>
- <em>
- map[string]int
- </em>
- </td>
- <td>
- <p>Vaults defines which OnePassword vaults to search in which order</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.OracleAuth">OracleAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
- </p>
- <p>
- <p>OracleAuth defines authentication configuration for the Oracle Vault provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>tenancy</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Tenancy is the tenancy OCID where user is located.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>user</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>User is an access OCID specific to the account.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OracleSecretRef">
- OracleSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>SecretRef to pass through sensitive information.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.OraclePrincipalType">OraclePrincipalType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
- </p>
- <p>
- <p>OraclePrincipalType defines the type of principal used for authentication to Oracle Vault.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"InstancePrincipal"</p></td>
- <td><p>InstancePrincipal represents a instance principal.</p>
- </td>
- </tr><tr><td><p>"UserPrincipal"</p></td>
- <td><p>UserPrincipal represents a user principal.</p>
- </td>
- </tr><tr><td><p>"Workload"</p></td>
- <td><p>WorkloadPrincipal represents a workload principal.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.OracleProvider">OracleProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>OracleProvider configures a store to sync secrets using an Oracle Vault backend.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Region is the region where vault is located.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vault</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Vault is the vault’s OCID of the specific vault where secret is located.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>compartment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Compartment is the vault compartment OCID.
- Required for PushSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>encryptionKey</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>EncryptionKey is the OCID of the encryption key within the vault.
- Required for PushSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>principalType</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OraclePrincipalType">
- OraclePrincipalType
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The type of principal to use for authentication. If left blank, the Auth struct will
- determine the principal type. This optional field must be specified if using
- workload identity.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OracleAuth">
- OracleAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth configures how secret-manager authenticates with the Oracle Vault.
- If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ServiceAccountRef specified the service account
- that should be used when authenticating with WorkloadIdentity.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.OracleSecretRef">OracleSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.OracleAuth">OracleAuth</a>)
- </p>
- <p>
- <p>OracleSecretRef defines references to secrets containing Oracle credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>privatekey</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>PrivateKey is the user’s API Signing Key in PEM format, used for authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>fingerprint</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Fingerprint is the fingerprint of the API private key.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.PassboltAuth">PassboltAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.PassboltProvider">PassboltProvider</a>)
- </p>
- <p>
- <p>PassboltAuth contains credentials and configuration for authenticating with the Passbolt server.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>passwordSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>PasswordSecretRef is a reference to the secret containing the Passbolt password</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>privateKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>PrivateKeySecretRef is a reference to the secret containing the Passbolt private key</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.PassboltProvider">PassboltProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>PassboltProvider defines configuration for the Passbolt provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.PassboltAuth">
- PassboltAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against Passbolt Server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>host</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Host defines the Passbolt Server to connect to</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.PasswordDepotAuth">PasswordDepotAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.PasswordDepotProvider">PasswordDepotProvider</a>)
- </p>
- <p>
- <p>PasswordDepotAuth defines the authentication method for the Password Depot provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.PasswordDepotSecretRef">
- PasswordDepotSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.PasswordDepotProvider">PasswordDepotProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>PasswordDepotProvider configures a store to sync secrets with a Password Depot instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>host</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL configures the Password Depot instance URL.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>database</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Database to use as source</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.PasswordDepotAuth">
- PasswordDepotAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with a Password Depot instance.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.PasswordDepotSecretRef">PasswordDepotSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.PasswordDepotAuth">PasswordDepotAuth</a>)
- </p>
- <p>
- <p>PasswordDepotSecretRef defines a reference to a secret containing credentials for the Password Depot provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>credentials</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Username / Password is used for authentication.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.PreviderAuth">PreviderAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.PreviderProvider">PreviderProvider</a>)
- </p>
- <p>
- <p>PreviderAuth contains a secretRef for credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.PreviderAuthSecretRef">
- PreviderAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.PreviderAuthSecretRef">PreviderAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.PreviderAuth">PreviderAuth</a>)
- </p>
- <p>
- <p>PreviderAuthSecretRef holds secret references for Previder Vault credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessToken</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessToken is used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.PreviderProvider">PreviderProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>PreviderProvider configures a store to sync secrets using the Previder Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.PreviderAuth">
- PreviderAuth
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>baseUri</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.Provider">Provider
- </h3>
- <p>
- <p>Provider is a common interface for interacting with secret backends.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.PulumiProvider">PulumiProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>PulumiProvider defines configuration for the Pulumi provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>APIURL is the URL of the Pulumi API.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessToken</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.PulumiProviderSecretRef">
- PulumiProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>AccessToken is the access tokens to sign in to the Pulumi Cloud Console.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>organization</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Organization are a space to collaborate on shared projects and stacks.
- To create a new organization, visit <a href="https://app.pulumi.com/">https://app.pulumi.com/</a> and click “New Organization”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>project</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Project is the name of the Pulumi ESC project the environment belongs to.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Environment are YAML documents composed of static key-value pairs, programmatic expressions,
- dynamically retrieved values from supported providers including all major clouds,
- and other Pulumi ESC environments.
- 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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.PulumiProviderSecretRef">PulumiProviderSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.PulumiProvider">PulumiProvider</a>)
- </p>
- <p>
- <p>PulumiProviderSecretRef defines a reference to a secret containing credentials for the Pulumi provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>SecretRef is a reference to a secret containing the Pulumi API token.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.PushSecretData">PushSecretData
- </h3>
- <p>
- <p>PushSecretData is an interface to allow using v1alpha1.PushSecretData content in Provider registered in v1beta1.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.PushSecretRemoteRef">PushSecretRemoteRef
- </h3>
- <p>
- <p>PushSecretRemoteRef is an interface to allow using v1alpha1.PushSecretRemoteRef in Provider registered in v1beta1.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.ScalewayProvider">ScalewayProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>ScalewayProvider defines configuration for the Scaleway provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>APIURL is the url of the api to use. Defaults to <a href="https://api.scaleway.com">https://api.scaleway.com</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessKey</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ScalewayProviderSecretRef">
- ScalewayProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>AccessKey is the non-secret part of the api key.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretKey</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ScalewayProviderSecretRef">
- ScalewayProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>SecretKey is the non-secret part of the api key.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ScalewayProviderSecretRef">ScalewayProviderSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ScalewayProvider">ScalewayProvider</a>)
- </p>
- <p>
- <p>ScalewayProviderSecretRef defines a reference to a secret containing credentials for the Scaleway provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Value can be specified directly to set a value without using a secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef references a key in a secret that will be used as value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretServerProvider">SecretServerProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>SecretServerProvider defines configuration for the Delinea Secret Server provider.
- 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>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretServerProviderRef">
- SecretServerProviderRef
- </a>
- </em>
- </td>
- <td>
- <p>Username is the secret server account username.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>password</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretServerProviderRef">
- SecretServerProviderRef
- </a>
- </em>
- </td>
- <td>
- <p>Password is the secret server account password.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serverURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ServerURL
- URL to your secret server installation</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretServerProviderRef">SecretServerProviderRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretServerProvider">SecretServerProvider</a>)
- </p>
- <p>
- <p>SecretServerProviderRef defines a reference to a secret containing credentials for the Secret Server provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Value can be specified directly to set a value without using a secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef references a key in a secret that will be used as value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStore">SecretStore
- </h3>
- <p>
- <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
- SecretStoreSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
- The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
- SecretStoreProvider
- </a>
- </em>
- </td>
- <td>
- <p>Used to configure the provider. Only one provider may be set</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrySettings</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
- SecretStoreRetrySettings
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure HTTP retries on failures.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
- []ClusterSecretStoreCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to constrain a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
- SecretStoreStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreCapabilities">SecretStoreCapabilities
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
- </p>
- <p>
- <p>SecretStoreCapabilities defines the possible operations a SecretStore can do.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ReadOnly"</p></td>
- <td><p>SecretStoreReadOnly indicates that the SecretStore only supports reading secrets.</p>
- </td>
- </tr><tr><td><p>"ReadWrite"</p></td>
- <td><p>SecretStoreReadWrite indicates that the SecretStore supports both reading and writing secrets.</p>
- </td>
- </tr><tr><td><p>"WriteOnly"</p></td>
- <td><p>SecretStoreWriteOnly indicates that the SecretStore only supports writing secrets.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreConditionType">SecretStoreConditionType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
- </p>
- <p>
- <p>SecretStoreConditionType represents the condition type of the SecretStore.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Ready"</p></td>
- <td><p>SecretStoreReady indicates that the SecretStore has been successfully configured.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
- </p>
- <p>
- <p>SecretStoreProvider contains the provider-specific configuration.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>aws</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AWSProvider">
- AWSProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>azurekv</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AzureKVProvider">
- AzureKVProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>akeyless</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AkeylessProvider">
- AkeylessProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>bitwardensecretsmanager</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerProvider">
- BitwardenSecretsManagerProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>BitwardenSecretsManager configures this store to sync secrets using BitwardenSecretsManager provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vault</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultProvider">
- VaultProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Vault configures this store to sync secrets using the HashiCorp Vault provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>gcpsm</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GCPSMProvider">
- GCPSMProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>oracle</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OracleProvider">
- OracleProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>ibm</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.IBMProvider">
- IBMProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>yandexcertificatemanager</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">
- YandexCertificateManagerProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>YandexCertificateManager configures this store to sync secrets using Yandex Certificate Manager provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>yandexlockbox</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">
- YandexLockboxProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>github</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GithubProvider">
- GithubProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Github configures this store to push GitHub Actions secrets using the GitHub API provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>gitlab</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GitlabProvider">
- GitlabProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>GitLab configures this store to sync secrets using GitLab Variables provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>alibaba</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AlibabaProvider">
- AlibabaProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>onepassword</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OnePasswordProvider">
- OnePasswordProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>OnePassword configures this store to sync secrets using the 1Password Cloud provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>webhook</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.WebhookProvider">
- WebhookProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Webhook configures this store to sync secrets using a generic templated webhook</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetes</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.KubernetesProvider">
- KubernetesProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kubernetes configures this store to sync secrets using a Kubernetes cluster provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>fake</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.FakeProvider">
- FakeProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Fake configures a store with static key/value pairs</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>senhasegura</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">
- SenhaseguraProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Senhasegura configures this store to sync secrets using senhasegura provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>scaleway</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ScalewayProvider">
- ScalewayProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Scaleway configures this store to sync secrets using the Scaleway provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>doppler</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.DopplerProvider">
- DopplerProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Doppler configures this store to sync secrets using the Doppler provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>previder</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.PreviderProvider">
- PreviderProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Previder configures this store to sync secrets using the Previder provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>onboardbase</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OnboardbaseProvider">
- OnboardbaseProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Onboardbase configures this store to sync secrets using the Onboardbase provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>keepersecurity</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.KeeperSecurityProvider">
- KeeperSecurityProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>KeeperSecurity configures this store to sync secrets using the KeeperSecurity provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conjur</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ConjurProvider">
- ConjurProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Conjur configures this store to sync secrets using conjur provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>delinea</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.DelineaProvider">
- DelineaProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Delinea DevOps Secrets Vault
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretserver</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretServerProvider">
- SecretServerProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretServer configures this store to sync secrets using SecretServer provider
- <a href="https://docs.delinea.com/online-help/secret-server/start.htm">https://docs.delinea.com/online-help/secret-server/start.htm</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>chef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ChefProvider">
- ChefProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Chef configures this store to sync secrets with chef server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>pulumi</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.PulumiProvider">
- PulumiProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Pulumi configures this store to sync secrets using the Pulumi provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>fortanix</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.FortanixProvider">
- FortanixProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Fortanix configures this store to sync secrets using the Fortanix provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>passworddepot</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.PasswordDepotProvider">
- PasswordDepotProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>passbolt</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.PassboltProvider">
- PassboltProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>device42</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.Device42Provider">
- Device42Provider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Device42 configures this store to sync secrets using the Device42 provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>infisical</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.InfisicalProvider">
- InfisicalProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Infisical configures this store to sync secrets using the Infisical provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>beyondtrust</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.BeyondtrustProvider">
- BeyondtrustProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Beyondtrust configures this store to sync secrets using Password Safe provider.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>cloudrusm</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CloudruSMProvider">
- CloudruSMProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CloudruSM configures this store to sync secrets using the Cloud.ru Secret Manager provider</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreRef">SecretStoreRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>,
- <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef</a>,
- <a href="#external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef</a>)
- </p>
- <p>
- <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name of the SecretStore resource</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kind</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
- Defaults to <code>SecretStore</code></p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreRetrySettings">SecretStoreRetrySettings
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
- </p>
- <p>
- <p>SecretStoreRetrySettings defines configuration for retrying failed requests to the provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>maxRetries</code></br>
- <em>
- int32
- </em>
- </td>
- <td>
- <p>MaxRetries is the maximum number of retry attempts.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retryInterval</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>RetryInterval is the interval between retry attempts.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
- <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
- </p>
- <p>
- <p>SecretStoreSpec defines the desired state of SecretStore.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
- The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
- SecretStoreProvider
- </a>
- </em>
- </td>
- <td>
- <p>Used to configure the provider. Only one provider may be set</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrySettings</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
- SecretStoreRetrySettings
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure HTTP retries on failures.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
- []ClusterSecretStoreCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to constrain a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
- <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
- </p>
- <p>
- <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">
- []SecretStoreStatusCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>capabilities</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreCapabilities">
- SecretStoreCapabilities
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
- </p>
- <p>
- <p>SecretStoreStatusCondition defines the observed condition of the SecretStore.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreConditionType">
- SecretStoreConditionType
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
- Kubernetes core/v1.ConditionStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>reason</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>message</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>lastTransitionTime</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretsClient">SecretsClient
- </h3>
- <p>
- <p>SecretsClient provides access to secrets.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.SecretsManager">SecretsManager
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
- </p>
- <p>
- <p>SecretsManager defines how the provider behaves when interacting with AWS
- SecretsManager. Some of these settings are only applicable to controlling how
- secrets are deleted, and hence only apply to PushSecret (and only when
- deletionPolicy is set to Delete).</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>forceDeleteWithoutRecovery</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Specifies whether to delete the secret without any recovery window. You
- can’t use both this parameter and RecoveryWindowInDays in the same call.
- If you don’t use either, then by default Secrets Manager uses a 30 day
- recovery window.
- 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>
- </td>
- </tr>
- <tr>
- <td>
- <code>recoveryWindowInDays</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The number of days from 7 to 30 that Secrets Manager waits before
- permanently deleting the secret. You can’t use both this parameter and
- ForceDeleteWithoutRecovery in the same call. If you don’t use either,
- then by default Secrets Manager uses a 30 day recovery window.
- 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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SenhaseguraAuth">SenhaseguraAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
- </p>
- <p>
- <p>SenhaseguraAuth tells the controller how to do auth in senhasegura.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientSecretSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SenhaseguraModuleType">SenhaseguraModuleType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
- </p>
- <p>
- <p>SenhaseguraModuleType enum defines senhasegura target module to fetch secrets</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"DSM"</p></td>
- <td><pre><code> SenhaseguraModuleDSM is the senhasegura DevOps Secrets Management module
- see: https://senhasegura.com/devops
- </code></pre>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>SenhaseguraProvider setup a store to sync secrets with senhasegura.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL of senhasegura</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>module</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SenhaseguraModuleType">
- SenhaseguraModuleType
- </a>
- </em>
- </td>
- <td>
- <p>Module defines which senhasegura module should be used to get secrets</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SenhaseguraAuth">
- SenhaseguraAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines parameters to authenticate in senhasegura</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>ignoreSslCertificate</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <p>IgnoreSslCertificate defines if SSL certificate must be ignored</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
- </p>
- <p>
- <p>StoreGeneratorSourceRef allows you to override the source
- from which the secret will be pulled from.
- You can define at maximum one property.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>storeRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreRef">
- SecretStoreRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>generatorRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GeneratorRef">
- GeneratorRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>GeneratorRef points to a generator custom resource.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>)
- </p>
- <p>
- <p>StoreSourceRef allows you to override the SecretStore source
- from which the secret will be pulled from.
- You can define at maximum one property.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>storeRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreRef">
- SecretStoreRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>generatorRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GeneratorRef">
- GeneratorRef
- </a>
- </em>
- </td>
- <td>
- <p>GeneratorRef points to a generator custom resource.</p>
- <p>Deprecated: The generatorRef is not implemented in .data[].
- this will be removed with v1.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.Tag">Tag
- </h3>
- <p>
- <p>Tag defines a tag key and value for AWS resources.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TemplateEngineVersion">TemplateEngineVersion
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
- </p>
- <p>
- <p>TemplateEngineVersion defines the version of the template engine to use.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"v2"</p></td>
- <td><p>TemplateEngineV2 specifies the v2 template engine version.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TemplateFrom">TemplateFrom
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
- </p>
- <p>
- <p>TemplateFrom defines a source for template data.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>configMap</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateRef">
- TemplateRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>secret</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateRef">
- TemplateRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>target</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateTarget">
- TemplateTarget
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>literal</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TemplateMergePolicy">TemplateMergePolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
- </p>
- <p>
- <p>TemplateMergePolicy defines how template values should be merged when generating a secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Merge"</p></td>
- <td><p>MergePolicyMerge merges the template content with existing values.</p>
- </td>
- </tr><tr><td><p>"Replace"</p></td>
- <td><p>MergePolicyReplace replaces the entire template content during merge operations.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TemplateRef">TemplateRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
- </p>
- <p>
- <p>TemplateRef defines a reference to a template source in a ConfigMap or Secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The name of the ConfigMap/Secret resource</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>items</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateRefItem">
- []TemplateRefItem
- </a>
- </em>
- </td>
- <td>
- <p>A list of keys in the ConfigMap/Secret to use as templates for Secret data</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.TemplateRef">TemplateRef</a>)
- </p>
- <p>
- <p>TemplateRefItem defines which key in the referenced ConfigMap or Secret to use as a template.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>A key in the ConfigMap/Secret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>templateAs</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateScope">
- TemplateScope
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TemplateScope">TemplateScope
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem</a>)
- </p>
- <p>
- <p>TemplateScope defines the scope of the template when processing template data.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"KeysAndValues"</p></td>
- <td><p>TemplateScopeKeysAndValues processes both keys and values of the data.</p>
- </td>
- </tr><tr><td><p>"Values"</p></td>
- <td><p>TemplateScopeValues processes only the values of the data.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TemplateTarget">TemplateTarget
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
- </p>
- <p>
- <p>TemplateTarget defines the target field where the template result will be stored.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Annotations"</p></td>
- <td><p>TemplateTargetAnnotations stores template results in the annotations field of the secret.</p>
- </td>
- </tr><tr><td><p>"Data"</p></td>
- <td><p>TemplateTargetData stores template results in the data field of the secret.</p>
- </td>
- </tr><tr><td><p>"Labels"</p></td>
- <td><p>TemplateTargetLabels stores template results in the labels field of the secret.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TokenAuth">TokenAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
- </p>
- <p>
- <p>TokenAuth defines token-based authentication for the Kubernetes provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>bearerToken</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.UniversalAuthCredentials">UniversalAuthCredentials
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.InfisicalAuth">InfisicalAuth</a>)
- </p>
- <p>
- <p>UniversalAuthCredentials defines the credentials for Infisical Universal Auth.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientSecret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ValidationResult">ValidationResult
- (<code>byte</code> alias)</p></h3>
- <p>
- <p>ValidationResult represents the result of validating a provider client configuration.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>2</p></td>
- <td><p>ValidationResultError indicates that there is a misconfiguration.</p>
- </td>
- </tr><tr><td><p>0</p></td>
- <td><p>ValidationResultReady indicates that the client is configured correctly and can be used.</p>
- </td>
- </tr><tr><td><p>1</p></td>
- <td><p>ValidationResultUnknown indicates that the client can be used but information is missing and it can not be validated.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultAppRole">VaultAppRole
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
- with the role and secret stored in a Kubernetes Secret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the App Role authentication backend is mounted
- in Vault, e.g: “approle”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>roleId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>RoleID configured in the App Role authentication backend when setting
- up the authentication backend in Vault.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>roleRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Reference to a key in a Secret that contains the App Role ID used
- to authenticate with Vault.
- The <code>key</code> field must be specified and denotes which entry within the Secret
- resource is used as the app role id.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Reference to a key in a Secret that contains the App Role secret used
- to authenticate with Vault.
- The <code>key</code> field must be specified and denotes which entry within the Secret
- resource is used as the app role secret.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultAuth">VaultAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
- </p>
- <p>
- <p>VaultAuth is the configuration used to authenticate with a Vault server.
- 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>
- can be specified. A namespace to authenticate against can optionally be specified.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Name of the vault namespace to authenticate to. This can be different than the namespace your secret is in.
- Namespaces is a set of features within Vault Enterprise that allows
- Vault environments to support Secure Multi-tenancy. e.g: “ns1”.
- More about namespaces can be found here <a href="https://www.vaultproject.io/docs/enterprise/namespaces">https://www.vaultproject.io/docs/enterprise/namespaces</a>
- This will default to Vault.Namespace field if set, or empty otherwise</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>appRole</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultAppRole">
- VaultAppRole
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AppRole authenticates with Vault using the App Role auth mechanism,
- with the role and secret stored in a Kubernetes Secret resource.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetes</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultKubernetesAuth">
- VaultKubernetesAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kubernetes authenticates with Vault by passing the ServiceAccount
- token stored in the named Secret resource to the Vault server.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>ldap</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultLdapAuth">
- VaultLdapAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Ldap authenticates with Vault by passing username/password pair using
- the LDAP authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultJwtAuth">
- VaultJwtAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Jwt authenticates with Vault by passing role and JWT token using the
- JWT/OIDC authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>cert</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultCertAuth">
- VaultCertAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
- Cert authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>iam</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultIamAuth">
- VaultIamAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Iam authenticates with vault by passing a special AWS request signed with AWS IAM credentials
- AWS IAM authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>userPass</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultUserPassAuth">
- VaultUserPassAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>UserPass authenticates with Vault by passing username/password pair</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth
- </h3>
- <p>
- <p>VaultAwsAuth tells the controller how to do authentication with aws.
- Only one of secretRef or jwt can be specified.
- if none is specified the controller will try to load credentials from its own service account assuming it is IRSA enabled.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultAwsAuthSecretRef">
- VaultAwsAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultAwsJWTAuth">
- VaultAwsJWTAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultAwsAuthSecretRef">VaultAwsAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth</a>,
- <a href="#external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth</a>)
- </p>
- <p>
- <p>VaultAwsAuthSecretRef holds secret references for AWS credentials
- both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessKeyIDSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The AccessKeyID is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretAccessKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The SecretAccessKey is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sessionTokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The SessionToken used for authentication
- This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
- 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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultAwsJWTAuth">VaultAwsJWTAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth</a>,
- <a href="#external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth</a>)
- </p>
- <p>
- <p>VaultAwsJWTAuth Authenticate against AWS using service account tokens.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultCertAuth">VaultCertAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultCertAuth authenticates with Vault using the JWT/OIDC authentication
- method, with the role name and token stored in a Kubernetes Secret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientCert</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ClientCert is a certificate to authenticate using the Cert Vault
- authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef to a key in a Secret resource containing client private key to
- authenticate with Vault using the Cert authentication method</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultClientTLS">VaultClientTLS
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
- </p>
- <p>
- <p>VaultClientTLS is the configuration used for client side related TLS communication,
- when the Vault server requires mutual authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>certSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CertSecretRef is a certificate added to the transport layer
- when communicating with the Vault server.
- If no key for the Secret is specified, external-secret will default to ‘tls.crt’.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>keySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>KeySecretRef to a key in a Secret resource containing client private key
- added to the transport layer when communicating with the Vault server.
- If no key for the Secret is specified, external-secret will default to ‘tls.key’.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultIamAuth authenticates with Vault using the Vault’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>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Path where the AWS auth method is enabled in Vault, e.g: “aws”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AWS region</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>This is the AWS role to be assumed before talking to vault</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vaultRole</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>AWS External ID set on assumed IAM roles</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vaultAwsIamServerID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultAwsAuthSecretRef">
- VaultAwsAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Specify credentials in a Secret object</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultAwsJWTAuth">
- VaultAwsJWTAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Specify a service account with IRSA enabled</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
- method, with the role name and a token stored in a Kubernetes Secret resource or
- a Kubernetes service account token retrieved via <code>TokenRequest</code>.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the JWT authentication backend is mounted
- in Vault, e.g: “jwt”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
- authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
- authenticate with Vault using the JWT/OIDC authentication method.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetesServiceAccountToken</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">
- VaultKubernetesServiceAccountTokenAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional ServiceAccountToken specifies the Kubernetes service account for which to request
- a token for with the <code>TokenRequest</code> API.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultKVStoreVersion">VaultKVStoreVersion
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
- </p>
- <p>
- <p>VaultKVStoreVersion defines the version of the KV store in Vault.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"v1"</p></td>
- <td><p>VaultKVStoreV1 represents version 1 of the Vault KV store.</p>
- </td>
- </tr><tr><td><p>"v2"</p></td>
- <td><p>VaultKVStoreV2 represents version 2 of the Vault KV store.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultKubernetesAuth">VaultKubernetesAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultKubernetesAuth authenticates against Vault using a Kubernetes ServiceAccount token stored in a Secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>mountPath</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
- “kubernetes”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional service account field containing the name of a kubernetes ServiceAccount.
- If the service account is specified, the service account secret token JWT will be used
- for authenticating with Vault. If the service account selector is not supplied,
- the secretRef will be used instead.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
- for authenticating with Vault. If a name is specified without a key,
- <code>token</code> is the default. If one is not specified, the one bound to
- the controller will be used.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>A required field containing the Vault Role to assume. A Role binds a
- Kubernetes ServiceAccount with a set of Vault policies.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">VaultKubernetesServiceAccountTokenAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth</a>)
- </p>
- <p>
- <p>VaultKubernetesServiceAccountTokenAuth authenticates with Vault using a temporary
- Kubernetes service account token retrieved by the <code>TokenRequest</code> API.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <p>Service account field containing the name of a kubernetes ServiceAccount.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>audiences</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional audiences field that will be used to request a temporary Kubernetes service
- account token for the service account referenced by <code>serviceAccountRef</code>.
- Defaults to a single audience <code>vault</code> it not specified.</p>
- <p>Deprecated: use serviceAccountRef.Audiences instead</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>expirationSeconds</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional expiration time in seconds that will be used to request a temporary
- Kubernetes service account token for the service account referenced by
- <code>serviceAccountRef</code>.</p>
- <p>Deprecated: this will be removed in the future.
- Defaults to 10 minutes.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultLdapAuth">VaultLdapAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
- with the username and password stored in a Kubernetes Secret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the LDAP authentication backend is mounted
- in Vault, e.g: “ldap”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Username is an LDAP username used to authenticate using the LDAP Vault
- authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef to a key in a Secret resource containing password for the LDAP
- user used to authenticate with Vault using the LDAP authentication
- method</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultProvider">VaultProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>VaultProvider configures a store to sync secrets using a HashiCorp Vault KV backend.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">
- VaultAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with the Vault server.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>server</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Server is the connection address for the Vault server, e.g: “<a href="https://vault.example.com:8200"">https://vault.example.com:8200”</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Path is the mount path of the Vault KV backend endpoint, e.g:
- “secret”. The v2 KV secret engine version specific “/data” path suffix
- for fetching secrets from Vault is optional and will be appended
- if not present in specified path.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>version</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultKVStoreVersion">
- VaultKVStoreVersion
- </a>
- </em>
- </td>
- <td>
- <p>Version is the Vault KV secret engine version. This can be either “v1” or
- “v2”. Version defaults to “v2”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
- Vault environments to support Secure Multi-tenancy. e.g: “ns1”.
- 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>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
- if the Server URL is using HTTPS protocol. This parameter is ignored for
- plain HTTP protocol connection. If not set the system root certificates
- are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tls</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultClientTLS">
- VaultClientTLS
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The configuration used for client side related TLS communication, when the Vault server
- requires mutual authentication. Only used if the Server URL is using HTTPS protocol.
- This parameter is ignored for plain HTTP protocol connection.
- It’s worth noting this configuration is different from the “TLS certificates auth method”,
- which is available under the <code>auth.cert</code> section.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>readYourWrites</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ReadYourWrites ensures isolated read-after-write semantics by
- providing discovered cluster replication states in each request.
- More information about eventual consistency in Vault can be found here
- <a href="https://www.vaultproject.io/docs/enterprise/consistency">https://www.vaultproject.io/docs/enterprise/consistency</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>forwardInconsistent</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
- leader instead of simply retrying within a loop. This can increase performance if
- the option is enabled serverside.
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>headers</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Headers to be added in Vault request</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultUserPassAuth">VaultUserPassAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultUserPassAuth authenticates with Vault using UserPass authentication method,
- with the username and password stored in a Kubernetes Secret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the UserPassword authentication backend is mounted
- in Vault, e.g: “userpass”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Username is a username used to authenticate using the UserPass Vault
- authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef to a key in a Secret resource containing password for the
- user used to authenticate with Vault using the UserPass authentication
- method</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
- </p>
- <p>
- <p>WebhookCAProvider defines a location to fetch the certificate for the webhook provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.WebhookCAProviderType">
- WebhookCAProviderType
- </a>
- </em>
- </td>
- <td>
- <p>The type of provider to use such as “Secret”, or “ConfigMap”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The name of the object located at the provider type.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The key where the CA certificate can be found in the Secret or ConfigMap.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The namespace the Provider type is in.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.WebhookCAProviderType">WebhookCAProviderType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider</a>)
- </p>
- <p>
- <p>WebhookCAProviderType defines the type of provider to use for CA certificates with Webhook providers.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ConfigMap"</p></td>
- <td><p>WebhookCAProviderTypeConfigMap indicates that the CA certificate is stored in a ConfigMap.</p>
- </td>
- </tr><tr><td><p>"Secret"</p></td>
- <td><p>WebhookCAProviderTypeSecret indicates that the CA certificate is stored in a Secret.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.WebhookProvider">WebhookProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>WebhookProvider configures a store to sync secrets from simple web APIs.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>method</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Webhook Method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Webhook url to call</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>headers</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Headers</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AuthorizationProtocol">
- AuthorizationProtocol
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth specifies a authorization protocol. Only one protocol may be set.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>body</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Body</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>timeout</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Timeout</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>result</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.WebhookResult">
- WebhookResult
- </a>
- </em>
- </td>
- <td>
- <p>Result formatting</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secrets</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.WebhookSecret">
- []WebhookSecret
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Secrets to fill in templates
- These secrets will be passed to the templating function as key value pairs under the given name</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
- if the Server URL is using HTTPS protocol. This parameter is ignored for
- plain HTTP protocol connection. If not set the system root certificates
- are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.WebhookCAProvider">
- WebhookCAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.WebhookResult">WebhookResult
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
- </p>
- <p>
- <p>WebhookResult defines how to extract and format the result from the webhook response.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>jsonPath</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Json path of return value</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.WebhookSecret">WebhookSecret
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
- </p>
- <p>
- <p>WebhookSecret defines a secret to be used in webhook templates.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name of this secret in templates</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Secret ref to fill in credentials</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerAuth">YandexCertificateManagerAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
- </p>
- <p>
- <p>YandexCertificateManagerAuth defines authentication configuration for the Yandex Certificate Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>authorizedKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The authorized key used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">YandexCertificateManagerCAProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
- </p>
- <p>
- <p>YandexCertificateManagerCAProvider defines CA certificate configuration for Yandex Certificate Manager.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>certSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>YandexCertificateManagerProvider configures a store to sync secrets using the Yandex Certificate Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Yandex.Cloud API endpoint (e.g. ‘api.cloud.yandex.net:443’)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.YandexCertificateManagerAuth">
- YandexCertificateManagerAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against Yandex Certificate Manager</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">
- YandexCertificateManagerCAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.YandexLockboxAuth">YandexLockboxAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
- </p>
- <p>
- <p>YandexLockboxAuth defines authentication configuration for the Yandex Lockbox provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>authorizedKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The authorized key used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.YandexLockboxCAProvider">YandexLockboxCAProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
- </p>
- <p>
- <p>YandexLockboxCAProvider defines CA certificate configuration for Yandex Lockbox.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>certSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>YandexLockboxProvider configures a store to sync secrets using the Yandex Lockbox provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Yandex.Cloud API endpoint (e.g. ‘api.cloud.yandex.net:443’)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.YandexLockboxAuth">
- YandexLockboxAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.YandexLockboxCAProvider">
- YandexLockboxCAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <hr/>
- <h2 id="generators.external-secrets.io/v1alpha1">generators.external-secrets.io/v1alpha1</h2>
- <p>
- <p>Package v1alpha1 contains resources for generators</p>
- </p>
- <p>Resource Types:</p>
- <ul></ul>
- <h3 id="generators.external-secrets.io/v1alpha1.ACRAccessToken">ACRAccessToken
- </h3>
- <p>
- <p>ACRAccessToken returns an Azure Container Registry token
- that can be used for pushing/pulling images.
- Note: by default it will return an ACR Refresh Token with full access
- (depending on the identity).
- This can be scoped down to the repository level using .spec.scope.
- In case scope is defined it will return an ACR Access Token.</p>
- <p>See docs: <a href="https://github.com/Azure/acr/blob/main/docs/AAD-OAuth.md">https://github.com/Azure/acr/blob/main/docs/AAD-OAuth.md</a></p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.ACRAccessTokenSpec">
- ACRAccessTokenSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.ACRAuth">
- ACRAuth
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>tenantId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>registry</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>the domain name of the ACR registry
- e.g. foobarexample.azurecr.io</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>scope</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Define the scope for the access token, e.g. pull/push access for a repository.
- if not provided it will return a refresh token that has full scope.
- Note: you need to pin it down to the repository level, there is no wildcard available.</p>
- <p>examples:
- repository:my-repository:pull,push
- repository:my-repository:pull</p>
- <p>see docs for details: <a href="https://docs.docker.com/registry/spec/auth/scope/">https://docs.docker.com/registry/spec/auth/scope/</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environmentType</code></br>
- <em>
- <a href="#external-secrets.io/v1.AzureEnvironmentType">
- AzureEnvironmentType
- </a>
- </em>
- </td>
- <td>
- <p>EnvironmentType specifies the Azure cloud environment endpoints to use for
- connecting and authenticating with Azure. By default, it points to the public cloud AAD endpoint.
- 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>
- PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.ACRAccessTokenSpec">ACRAccessTokenSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.ACRAccessToken">ACRAccessToken</a>,
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>)
- </p>
- <p>
- <p>ACRAccessTokenSpec defines how to generate the access token
- e.g. how to authenticate and which registry to use.
- see: <a href="https://github.com/Azure/acr/blob/main/docs/AAD-OAuth.md#overview">https://github.com/Azure/acr/blob/main/docs/AAD-OAuth.md#overview</a></p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.ACRAuth">
- ACRAuth
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>tenantId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>registry</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>the domain name of the ACR registry
- e.g. foobarexample.azurecr.io</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>scope</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Define the scope for the access token, e.g. pull/push access for a repository.
- if not provided it will return a refresh token that has full scope.
- Note: you need to pin it down to the repository level, there is no wildcard available.</p>
- <p>examples:
- repository:my-repository:pull,push
- repository:my-repository:pull</p>
- <p>see docs for details: <a href="https://docs.docker.com/registry/spec/auth/scope/">https://docs.docker.com/registry/spec/auth/scope/</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environmentType</code></br>
- <em>
- <a href="#external-secrets.io/v1.AzureEnvironmentType">
- AzureEnvironmentType
- </a>
- </em>
- </td>
- <td>
- <p>EnvironmentType specifies the Azure cloud environment endpoints to use for
- connecting and authenticating with Azure. By default, it points to the public cloud AAD endpoint.
- 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>
- PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.ACRAuth">ACRAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.ACRAccessTokenSpec">ACRAccessTokenSpec</a>)
- </p>
- <p>
- <p>ACRAuth defines the authentication methods for Azure Container Registry.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>servicePrincipal</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.AzureACRServicePrincipalAuth">
- AzureACRServicePrincipalAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ServicePrincipal uses Azure Service Principal credentials to authenticate with Azure.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>managedIdentity</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.AzureACRManagedIdentityAuth">
- AzureACRManagedIdentityAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ManagedIdentity uses Azure Managed Identity to authenticate with Azure.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>workloadIdentity</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.AzureACRWorkloadIdentityAuth">
- AzureACRWorkloadIdentityAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>WorkloadIdentity uses Azure Workload Identity to authenticate with Azure.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.AWSAuth">AWSAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.ECRAuthorizationTokenSpec">ECRAuthorizationTokenSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.STSSessionTokenSpec">STSSessionTokenSpec</a>)
- </p>
- <p>
- <p>AWSAuth tells the controller how to do authentication with aws.
- Only one of secretRef or jwt can be specified.
- if none is specified the controller will load credentials using the aws sdk defaults.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.AWSAuthSecretRef">
- AWSAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.AWSJWTAuth">
- AWSJWTAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.AWSAuthSecretRef">AWSAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
- </p>
- <p>
- <p>AWSAuthSecretRef holds secret references for AWS credentials
- both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessKeyIDSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessKeyID is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretAccessKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SecretAccessKey is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sessionTokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SessionToken used for authentication
- This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
- 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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.AWSJWTAuth">AWSJWTAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
- </p>
- <p>
- <p>AWSJWTAuth provides configuration to authenticate against AWS using service account tokens.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.AuthorizationProtocol">AuthorizationProtocol
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookSpec">WebhookSpec</a>)
- </p>
- <p>
- <p>AuthorizationProtocol contains the protocol-specific configuration</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>ntlm</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.NTLMProtocol">
- NTLMProtocol
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>NTLMProtocol configures the store to use NTLM for auth</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.AzureACRManagedIdentityAuth">AzureACRManagedIdentityAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.ACRAuth">ACRAuth</a>)
- </p>
- <p>
- <p>AzureACRManagedIdentityAuth defines the configuration for using Azure Managed Identity authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>identityId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.AzureACRServicePrincipalAuth">AzureACRServicePrincipalAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.ACRAuth">ACRAuth</a>)
- </p>
- <p>
- <p>AzureACRServicePrincipalAuth defines the configuration for using Azure Service Principal authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.AzureACRServicePrincipalAuthSecretRef">
- AzureACRServicePrincipalAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.AzureACRServicePrincipalAuthSecretRef">AzureACRServicePrincipalAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.AzureACRServicePrincipalAuth">AzureACRServicePrincipalAuth</a>)
- </p>
- <p>
- <p>AzureACRServicePrincipalAuthSecretRef defines the secret references for Azure Service Principal authentication.
- It uses static credentials stored in a Kind=Secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The Azure clientId of the service principle used for authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientSecret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The Azure ClientSecret of the service principle used for authentication.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.AzureACRWorkloadIdentityAuth">AzureACRWorkloadIdentityAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.ACRAuth">ACRAuth</a>)
- </p>
- <p>
- <p>AzureACRWorkloadIdentityAuth defines the configuration for using Azure Workload Identity authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ServiceAccountRef specified the service account
- that should be used when authenticating with WorkloadIdentity.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.BeyondtrustWorkloadCredentialsDynamicSecret">BeyondtrustWorkloadCredentialsDynamicSecret
- </h3>
- <p>
- <p>BeyondtrustWorkloadCredentialsDynamicSecret represents a generator that requests dynamic credentials from BeyondTrust Workload Credentials.
- This generator calls the BeyondTrust Workload Credentials API to generate fresh, temporary credentials
- (such as AWS STS credentials) each time an ExternalSecret is refreshed.
- Dynamic secret definitions must be created in BeyondTrust Workload Credentials before they can be referenced.
- For complete documentation, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api">https://docs.beyondtrust.com/bt-docs/docs/secrets-api</a></p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.BeyondtrustWorkloadCredentialsDynamicSecretSpec">
- BeyondtrustWorkloadCredentialsDynamicSecretSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Controller selects the controller that should handle this generator.
- Leave empty to use the default controller.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provider</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondtrustWorkloadCredentialsProvider">
- BeyondtrustWorkloadCredentialsProvider
- </a>
- </em>
- </td>
- <td>
- <p>Provider contains the BeyondtrustWorkloadCredentials provider configuration including authentication,
- server connection details, and the folder path to the dynamic secret definition.
- The folderPath should point to a dynamic secret definition that has been created in
- BeyondTrust Workload Credentials (e.g., “production/aws-temp”).
- For setup details, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api">https://docs.beyondtrust.com/bt-docs/docs/secrets-api</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrySettings</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreRetrySettings">
- SecretStoreRetrySettings
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>RetrySettings configures exponential backoff for failed API requests.
- If not specified, uses the default retry settings.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.BeyondtrustWorkloadCredentialsDynamicSecretSpec">BeyondtrustWorkloadCredentialsDynamicSecretSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.BeyondtrustWorkloadCredentialsDynamicSecret">BeyondtrustWorkloadCredentialsDynamicSecret</a>,
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>)
- </p>
- <p>
- <p>BeyondtrustWorkloadCredentialsDynamicSecretSpec defines the desired spec for BeyondtrustWorkloadCredentials dynamic generator.
- This generator enables obtaining temporary, short-lived credentials from BeyondTrust Workload Credentials.
- For more information, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api">https://docs.beyondtrust.com/bt-docs/docs/secrets-api</a></p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Controller selects the controller that should handle this generator.
- Leave empty to use the default controller.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provider</code></br>
- <em>
- <a href="#external-secrets.io/v1.BeyondtrustWorkloadCredentialsProvider">
- BeyondtrustWorkloadCredentialsProvider
- </a>
- </em>
- </td>
- <td>
- <p>Provider contains the BeyondtrustWorkloadCredentials provider configuration including authentication,
- server connection details, and the folder path to the dynamic secret definition.
- The folderPath should point to a dynamic secret definition that has been created in
- BeyondTrust Workload Credentials (e.g., “production/aws-temp”).
- For setup details, see: <a href="https://docs.beyondtrust.com/bt-docs/docs/secrets-api">https://docs.beyondtrust.com/bt-docs/docs/secrets-api</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrySettings</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreRetrySettings">
- SecretStoreRetrySettings
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>RetrySettings configures exponential backoff for failed API requests.
- If not specified, uses the default retry settings.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.CloudsmithAccessToken">CloudsmithAccessToken
- </h3>
- <p>
- <p>CloudsmithAccessToken generates Cloudsmith access token using OIDC authentication</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.CloudsmithAccessTokenSpec">
- CloudsmithAccessTokenSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>apiUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>APIURL configures the Cloudsmith API URL. Defaults to <a href="https://api.cloudsmith.io">https://api.cloudsmith.io</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>orgSlug</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>OrgSlug is the organization slug in Cloudsmith</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceSlug</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ServiceSlug is the service slug in Cloudsmith for OIDC authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <p>Name of the service account you are federating with</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.CloudsmithAccessTokenSpec">CloudsmithAccessTokenSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.CloudsmithAccessToken">CloudsmithAccessToken</a>,
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>)
- </p>
- <p>
- <p>CloudsmithAccessTokenSpec defines the configuration for generating a Cloudsmith access token using OIDC authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>APIURL configures the Cloudsmith API URL. Defaults to <a href="https://api.cloudsmith.io">https://api.cloudsmith.io</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>orgSlug</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>OrgSlug is the organization slug in Cloudsmith</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceSlug</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ServiceSlug is the service slug in Cloudsmith for OIDC authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <p>Name of the service account you are federating with</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.ClusterGenerator">ClusterGenerator
- </h3>
- <p>
- <p>ClusterGenerator represents a cluster-wide generator which can be referenced as part of <code>generatorRef</code> fields.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.ClusterGeneratorSpec">
- ClusterGeneratorSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>kind</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorKind">
- GeneratorKind
- </a>
- </em>
- </td>
- <td>
- <p>Kind the kind of this generator.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>generator</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">
- GeneratorSpec
- </a>
- </em>
- </td>
- <td>
- <p>Generator the spec for this generator, must match the kind.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.ClusterGeneratorSpec">ClusterGeneratorSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.ClusterGenerator">ClusterGenerator</a>)
- </p>
- <p>
- <p>ClusterGeneratorSpec defines the desired state of a ClusterGenerator.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>kind</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorKind">
- GeneratorKind
- </a>
- </em>
- </td>
- <td>
- <p>Kind the kind of this generator.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>generator</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">
- GeneratorSpec
- </a>
- </em>
- </td>
- <td>
- <p>Generator the spec for this generator, must match the kind.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.ControllerClassResource">ControllerClassResource
- </h3>
- <p>
- <p>ControllerClassResource defines a resource that can be assigned to a specific controller class.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- struct{ControllerClass string "json:\"controller\""}
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.ECRAuthorizationToken">ECRAuthorizationToken
- </h3>
- <p>
- <p>ECRAuthorizationToken uses the GetAuthorizationToken API to retrieve an authorization token.
- The authorization token is valid for 12 hours.
- The authorizationToken returned is a base64 encoded string that can be decoded
- and used in a docker login command to authenticate to a registry.
- For more information, see Registry authentication (<a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth">https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth</a>) in the Amazon Elastic Container Registry User Guide.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.ECRAuthorizationTokenSpec">
- ECRAuthorizationTokenSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Region specifies the region to operate in.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.AWSAuth">
- AWSAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth defines how to authenticate with AWS</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>You can assume a role before making calls to the
- desired AWS service.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>scope</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Scope specifies the ECR service scope.
- Valid options are private and public.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.ECRAuthorizationTokenSpec">ECRAuthorizationTokenSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.ECRAuthorizationToken">ECRAuthorizationToken</a>,
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>)
- </p>
- <p>
- <p>ECRAuthorizationTokenSpec defines the desired state to generate an AWS ECR authorization token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Region specifies the region to operate in.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.AWSAuth">
- AWSAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth defines how to authenticate with AWS</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>You can assume a role before making calls to the
- desired AWS service.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>scope</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Scope specifies the ECR service scope.
- Valid options are private and public.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.Fake">Fake
- </h3>
- <p>
- <p>Fake generator is used for testing. It lets you define
- a static set of credentials that is always returned.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.FakeSpec">
- FakeSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
- The ESO controller is instantiated with a specific controller name and filters VDS based on this property</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <p>Data defines the static data returned
- by this generator.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.FakeSpec">FakeSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.Fake">Fake</a>,
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>)
- </p>
- <p>
- <p>FakeSpec contains the static data.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
- The ESO controller is instantiated with a specific controller name and filters VDS based on this property</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <p>Data defines the static data returned
- by this generator.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GCRAccessTokenSpec">GCRAccessTokenSpec</a>)
- </p>
- <p>
- <p>GCPSMAuth defines the authentication methods for Google Cloud Platform.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GCPSMAuthSecretRef">
- GCPSMAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>workloadIdentity</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GCPWorkloadIdentity">
- GCPWorkloadIdentity
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>workloadIdentityFederation</code></br>
- <em>
- <a href="#external-secrets.io/v1.GCPWorkloadIdentityFederation">
- GCPWorkloadIdentityFederation
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth</a>)
- </p>
- <p>
- <p>GCPSMAuthSecretRef defines the reference to a secret containing Google Cloud Platform credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretAccessKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The SecretAccessKey is used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GCPWorkloadIdentity">GCPWorkloadIdentity
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth</a>)
- </p>
- <p>
- <p>GCPWorkloadIdentity defines the configuration for using GCP Workload Identity authentication.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clusterLocation</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clusterName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clusterProjectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GCRAccessToken">GCRAccessToken
- </h3>
- <p>
- <p>GCRAccessToken generates an GCP access token
- that can be used to authenticate with GCR.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GCRAccessTokenSpec">
- GCRAccessTokenSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GCPSMAuth">
- GCPSMAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the means for authenticating with GCP</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectID defines which project to use to authenticate with</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GCRAccessTokenSpec">GCRAccessTokenSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GCRAccessToken">GCRAccessToken</a>,
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>)
- </p>
- <p>
- <p>GCRAccessTokenSpec defines the desired state to generate a Google Container Registry access token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GCPSMAuth">
- GCPSMAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the means for authenticating with GCP</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectID defines which project to use to authenticate with</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.Generator">Generator
- </h3>
- <p>
- <p>Generator is the common interface for all generators that is actually used to generate whatever is needed.</p>
- </p>
- <h3 id="generators.external-secrets.io/v1alpha1.GeneratorKind">GeneratorKind
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.ClusterGeneratorSpec">ClusterGeneratorSpec</a>)
- </p>
- <p>
- <p>GeneratorKind represents a kind of generator.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ACRAccessToken"</p></td>
- <td><p>GeneratorKindACRAccessToken represents an Azure Container Registry access token generator.</p>
- </td>
- </tr><tr><td><p>"BeyondtrustWorkloadCredentialsDynamicSecret"</p></td>
- <td><p>GeneratorKindBeyondtrustWorkloadCredentialsDynamicSecret represents a BeyondTrust Workload Credentials dynamic secret generator.</p>
- </td>
- </tr><tr><td><p>"CloudsmithAccessToken"</p></td>
- <td><p>GeneratorKindCloudsmithAccessToken represents a Cloudsmith access token generator.</p>
- </td>
- </tr><tr><td><p>"ECRAuthorizationToken"</p></td>
- <td><p>GeneratorKindECRAuthorizationToken represents an AWS ECR authorization token generator.</p>
- </td>
- </tr><tr><td><p>"Fake"</p></td>
- <td><p>GeneratorKindFake represents a fake generator for testing purposes.</p>
- </td>
- </tr><tr><td><p>"GCRAccessToken"</p></td>
- <td><p>GeneratorKindGCRAccessToken represents a Google Container Registry access token generator.</p>
- </td>
- </tr><tr><td><p>"GithubAccessToken"</p></td>
- <td><p>GeneratorKindGithubAccessToken represents a GitHub access token generator.</p>
- </td>
- </tr><tr><td><p>"GitlabDeployToken"</p></td>
- <td><p>GeneratorKindGitlabDeployToken represents a GitLab deploy token generator.</p>
- </td>
- </tr><tr><td><p>"Grafana"</p></td>
- <td><p>GeneratorKindGrafana represents a Grafana token generator.</p>
- </td>
- </tr><tr><td><p>"MFA"</p></td>
- <td><p>GeneratorKindMFA represents a Multi-Factor Authentication generator.</p>
- </td>
- </tr><tr><td><p>"Password"</p></td>
- <td><p>GeneratorKindPassword represents a password generator.</p>
- </td>
- </tr><tr><td><p>"QuayAccessToken"</p></td>
- <td><p>GeneratorKindQuayAccessToken represents a Quay access token generator.</p>
- </td>
- </tr><tr><td><p>"SSHKey"</p></td>
- <td><p>GeneratorKindSSHKey represents an SSH key generator.</p>
- </td>
- </tr><tr><td><p>"STSSessionToken"</p></td>
- <td><p>GeneratorKindSTSSessionToken represents an AWS STS session token generator.</p>
- </td>
- </tr><tr><td><p>"UUID"</p></td>
- <td><p>GeneratorKindUUID represents a UUID generator.</p>
- </td>
- </tr><tr><td><p>"VaultDynamicSecret"</p></td>
- <td><p>GeneratorKindVaultDynamicSecret represents a HashiCorp Vault dynamic secret generator.</p>
- </td>
- </tr><tr><td><p>"Webhook"</p></td>
- <td><p>GeneratorKindWebhook represents a webhook-based generator.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="<UNKNOWN_API_GROUP>.GeneratorProviderState">GeneratorProviderState
- </h3>
- <p>
- <p>GeneratorProviderState represents the state of a generator provider that can be stored and retrieved.</p>
- </p>
- <h3 id="generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.ClusterGeneratorSpec">ClusterGeneratorSpec</a>)
- </p>
- <p>
- <p>GeneratorSpec defines the configuration for various supported generator types.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>acrAccessTokenSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.ACRAccessTokenSpec">
- ACRAccessTokenSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>beyondtrustWorkloadCredentialsDynamicSecretSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.BeyondtrustWorkloadCredentialsDynamicSecretSpec">
- BeyondtrustWorkloadCredentialsDynamicSecretSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>cloudsmithAccessTokenSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.CloudsmithAccessTokenSpec">
- CloudsmithAccessTokenSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>ecrAuthorizationTokenSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.ECRAuthorizationTokenSpec">
- ECRAuthorizationTokenSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>fakeSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.FakeSpec">
- FakeSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>gcrAccessTokenSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GCRAccessTokenSpec">
- GCRAccessTokenSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>githubAccessTokenSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GithubAccessTokenSpec">
- GithubAccessTokenSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>gitlabDeployTokenSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GitlabDeployTokenSpec">
- GitlabDeployTokenSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>quayAccessTokenSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.QuayAccessTokenSpec">
- QuayAccessTokenSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>passwordSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.PasswordSpec">
- PasswordSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>sshKeySpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.SSHKeySpec">
- SSHKeySpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>stsSessionTokenSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.STSSessionTokenSpec">
- STSSessionTokenSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>uuidSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.UUIDSpec">
- UUIDSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>vaultDynamicSecretSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.VaultDynamicSecretSpec">
- VaultDynamicSecretSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>webhookSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookSpec">
- WebhookSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>grafanaSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaSpec">
- GrafanaSpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>mfaSpec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.MFASpec">
- MFASpec
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GeneratorState">GeneratorState
- </h3>
- <p>
- <p>GeneratorState represents the state created and managed by a generator resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorStateSpec">
- GeneratorStateSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>garbageCollectionDeadline</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <p>GarbageCollectionDeadline is the time after which the generator state
- will be deleted.
- It is set by the controller which creates the generator state and
- can be set configured by the user.
- If the garbage collection deadline is not set the generator state will not be deleted.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>resource</code></br>
- <em>
- k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON
- </em>
- </td>
- <td>
- <p>Resource is the generator manifest that produced the state.
- It is a snapshot of the generator manifest at the time the state was produced.
- This manifest will be used to delete the resource. Any configuration that is referenced
- in the manifest should be available at the time of garbage collection. If that is not the case deletion will
- be blocked by a finalizer.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>state</code></br>
- <em>
- k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON
- </em>
- </td>
- <td>
- <p>State is the state that was produced by the generator implementation.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorStateStatus">
- GeneratorStateStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GeneratorStateConditionType">GeneratorStateConditionType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorStateStatusCondition">GeneratorStateStatusCondition</a>)
- </p>
- <p>
- <p>GeneratorStateConditionType represents the type of condition for a generator state.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Ready"</p></td>
- <td><p>GeneratorStateReady indicates the generator state is ready and available.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GeneratorStateSpec">GeneratorStateSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorState">GeneratorState</a>)
- </p>
- <p>
- <p>GeneratorStateSpec defines the desired state of a generator state resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>garbageCollectionDeadline</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <p>GarbageCollectionDeadline is the time after which the generator state
- will be deleted.
- It is set by the controller which creates the generator state and
- can be set configured by the user.
- If the garbage collection deadline is not set the generator state will not be deleted.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>resource</code></br>
- <em>
- k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON
- </em>
- </td>
- <td>
- <p>Resource is the generator manifest that produced the state.
- It is a snapshot of the generator manifest at the time the state was produced.
- This manifest will be used to delete the resource. Any configuration that is referenced
- in the manifest should be available at the time of garbage collection. If that is not the case deletion will
- be blocked by a finalizer.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>state</code></br>
- <em>
- k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON
- </em>
- </td>
- <td>
- <p>State is the state that was produced by the generator implementation.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GeneratorStateStatus">GeneratorStateStatus
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorState">GeneratorState</a>)
- </p>
- <p>
- <p>GeneratorStateStatus defines the observed state of a generator state resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorStateStatusCondition">
- []GeneratorStateStatusCondition
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GeneratorStateStatusCondition">GeneratorStateStatusCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorStateStatus">GeneratorStateStatus</a>)
- </p>
- <p>
- <p>GeneratorStateStatusCondition represents the observed condition of a generator state.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorStateConditionType">
- GeneratorStateConditionType
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
- Kubernetes core/v1.ConditionStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>reason</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>message</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>lastTransitionTime</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GithubAccessToken">GithubAccessToken
- </h3>
- <p>
- <p>GithubAccessToken generates ghs_ accessToken</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GithubAccessTokenSpec">
- GithubAccessTokenSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL configures the GitHub instance URL. Defaults to <a href="https://github.com/">https://github.com/</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>appID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>installID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>repositories</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <p>List of repositories the token will have access to. If omitted, defaults to all repositories the GitHub App
- is installed to.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>permissions</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <p>Map of permissions the token will have. If omitted, defaults to all permissions the GitHub App has.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GithubAuth">
- GithubAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how ESO authenticates with a Github instance.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GithubAccessTokenSpec">GithubAccessTokenSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.GithubAccessToken">GithubAccessToken</a>)
- </p>
- <p>
- <p>GithubAccessTokenSpec defines the desired state to generate a GitHub access token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL configures the GitHub instance URL. Defaults to <a href="https://github.com/">https://github.com/</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>appID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>installID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>repositories</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <p>List of repositories the token will have access to. If omitted, defaults to all repositories the GitHub App
- is installed to.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>permissions</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <p>Map of permissions the token will have. If omitted, defaults to all permissions the GitHub App has.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GithubAuth">
- GithubAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how ESO authenticates with a Github instance.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GithubAuth">GithubAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GithubAccessTokenSpec">GithubAccessTokenSpec</a>)
- </p>
- <p>
- <p>GithubAuth defines the authentication configuration for GitHub access.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>privateKey</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GithubSecretRef">
- GithubSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GithubSecretRef">GithubSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GithubAuth">GithubAuth</a>)
- </p>
- <p>
- <p>GithubSecretRef references a secret containing GitHub credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GitlabDeployToken">GitlabDeployToken
- </h3>
- <p>
- <p>GitlabDeployToken generates a GitLab deploy token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GitlabDeployTokenSpec">
- GitlabDeployTokenSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com">https://gitlab.com</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ProjectID is the numeric ID or unescaped path (e.g. group/project) of the
- project to create the deploy token in. The generator URL-escapes paths before
- calling the GitLab API, so do not pre-encode. Mutually exclusive with groupID.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>groupID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>GroupID is the numeric ID or unescaped path (e.g. parent/group) of the group to
- create the deploy token in. The generator URL-escapes paths before calling the
- GitLab API, so do not pre-encode. Mutually exclusive with projectID.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name of the deploy token.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>scopes</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GitlabDeployTokenScope">
- []GitlabDeployTokenScope
- </a>
- </em>
- </td>
- <td>
- <p>Scopes granted to the deploy token. At least one scope is required.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>expiresAt</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ExpiresAt is an optional expiry for the deploy token. If omitted the token does
- not expire on the GitLab side and is revoked only when the generator state is
- cleaned up (on regeneration or when the consuming ExternalSecret is deleted).</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Username is an optional username for the deploy token. GitLab defaults it to
- gitlab+deploy-token-{n} when omitted.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GitlabDeployTokenAuth">
- GitlabDeployTokenAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how ESO authenticates with the GitLab API.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GitlabDeployTokenAuth">GitlabDeployTokenAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GitlabDeployTokenSpec">GitlabDeployTokenSpec</a>)
- </p>
- <p>
- <p>GitlabDeployTokenAuth defines the authentication configuration for the GitLab API.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>token</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GitlabDeployTokenSecretRef">
- GitlabDeployTokenSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>Token references a secret containing a GitLab access token (personal, group, or
- project) with the api scope and at least the Maintainer role on the target.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GitlabDeployTokenScope">GitlabDeployTokenScope
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GitlabDeployTokenSpec">GitlabDeployTokenSpec</a>)
- </p>
- <p>
- <p>GitlabDeployTokenScope is a scope that can be granted to a GitLab deploy token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"read_package_registry"</p></td>
- <td><p>GitlabDeployTokenScopeReadPackageRegistry allows read access to the package registry.</p>
- </td>
- </tr><tr><td><p>"read_registry"</p></td>
- <td><p>GitlabDeployTokenScopeReadRegistry allows read access to the container registry.</p>
- </td>
- </tr><tr><td><p>"read_repository"</p></td>
- <td><p>GitlabDeployTokenScopeReadRepository allows read access to the repository.</p>
- </td>
- </tr><tr><td><p>"read_virtual_registry"</p></td>
- <td><p>GitlabDeployTokenScopeReadVirtualRegistry allows read access to the virtual registry (projects only).</p>
- </td>
- </tr><tr><td><p>"write_package_registry"</p></td>
- <td><p>GitlabDeployTokenScopeWritePackageRegistry allows write access to the package registry.</p>
- </td>
- </tr><tr><td><p>"write_registry"</p></td>
- <td><p>GitlabDeployTokenScopeWriteRegistry allows write access to the container registry.</p>
- </td>
- </tr><tr><td><p>"write_virtual_registry"</p></td>
- <td><p>GitlabDeployTokenScopeWriteVirtualRegistry allows write access to the virtual registry (projects only).</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GitlabDeployTokenSecretRef">GitlabDeployTokenSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GitlabDeployTokenAuth">GitlabDeployTokenAuth</a>)
- </p>
- <p>
- <p>GitlabDeployTokenSecretRef references a secret containing a GitLab access token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GitlabDeployTokenSpec">GitlabDeployTokenSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.GitlabDeployToken">GitlabDeployToken</a>)
- </p>
- <p>
- <p>GitlabDeployTokenSpec defines the desired state to generate a GitLab deploy token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com">https://gitlab.com</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ProjectID is the numeric ID or unescaped path (e.g. group/project) of the
- project to create the deploy token in. The generator URL-escapes paths before
- calling the GitLab API, so do not pre-encode. Mutually exclusive with groupID.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>groupID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>GroupID is the numeric ID or unescaped path (e.g. parent/group) of the group to
- create the deploy token in. The generator URL-escapes paths before calling the
- GitLab API, so do not pre-encode. Mutually exclusive with projectID.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name of the deploy token.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>scopes</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GitlabDeployTokenScope">
- []GitlabDeployTokenScope
- </a>
- </em>
- </td>
- <td>
- <p>Scopes granted to the deploy token. At least one scope is required.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>expiresAt</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ExpiresAt is an optional expiry for the deploy token. If omitted the token does
- not expire on the GitLab side and is revoked only when the generator state is
- cleaned up (on regeneration or when the consuming ExternalSecret is deleted).</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Username is an optional username for the deploy token. GitLab defaults it to
- gitlab+deploy-token-{n} when omitted.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GitlabDeployTokenAuth">
- GitlabDeployTokenAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how ESO authenticates with the GitLab API.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.Grafana">Grafana
- </h3>
- <p>
- <p>Grafana represents a generator for Grafana service account tokens.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaSpec">
- GrafanaSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL is the URL of the Grafana instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaAuth">
- GrafanaAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth is the authentication configuration to authenticate
- against the Grafana instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccount</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaServiceAccount">
- GrafanaServiceAccount
- </a>
- </em>
- </td>
- <td>
- <p>ServiceAccount is the configuration for the service account that
- is supposed to be generated by the generator.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GrafanaAuth">GrafanaAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaSpec">GrafanaSpec</a>)
- </p>
- <p>
- <p>GrafanaAuth defines the authentication methods for connecting to a Grafana instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>token</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.SecretKeySelector">
- SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>A service account token used to authenticate against the Grafana instance.
- Note: you need a token which has elevated permissions to create service accounts.
- See here for the documentation on basic roles offered by Grafana:
- <a href="https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/">https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>basic</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaBasicAuth">
- GrafanaBasicAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Basic auth credentials used to authenticate against the Grafana instance.
- Note: you need a token which has elevated permissions to create service accounts.
- See here for the documentation on basic roles offered by Grafana:
- <a href="https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/">https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/</a></p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GrafanaBasicAuth">GrafanaBasicAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaAuth">GrafanaAuth</a>)
- </p>
- <p>
- <p>GrafanaBasicAuth defines the credentials for basic authentication with Grafana.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>A basic auth username used to authenticate against the Grafana instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>password</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.SecretKeySelector">
- SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>A basic auth password used to authenticate against the Grafana instance.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GrafanaServiceAccount">GrafanaServiceAccount
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaSpec">GrafanaSpec</a>)
- </p>
- <p>
- <p>GrafanaServiceAccount defines the configuration for a Grafana service account to be created.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name is the name of the service account that will be created by ESO.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Role is the role of the service account.
- See here for the documentation on basic roles offered by Grafana:
- <a href="https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/">https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secondsToLive</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecondsToLive is the number of seconds before the generated service account token will expire.
- Some Grafana deployments (e.g. AWS Managed Grafana) require this value to be set.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GrafanaServiceAccountTokenState">GrafanaServiceAccountTokenState
- </h3>
- <p>
- <p>GrafanaServiceAccountTokenState is the state type produced by the Grafana generator.
- It contains the service account ID, login and token ID which is enough to
- identify the service account.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccount</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaStateServiceAccount">
- GrafanaStateServiceAccount
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GrafanaSpec">GrafanaSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.Grafana">Grafana</a>)
- </p>
- <p>
- <p>GrafanaSpec controls the behavior of the grafana generator.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL is the URL of the Grafana instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaAuth">
- GrafanaAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth is the authentication configuration to authenticate
- against the Grafana instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccount</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaServiceAccount">
- GrafanaServiceAccount
- </a>
- </em>
- </td>
- <td>
- <p>ServiceAccount is the configuration for the service account that
- is supposed to be generated by the generator.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.GrafanaStateServiceAccount">GrafanaStateServiceAccount
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaServiceAccountTokenState">GrafanaServiceAccountTokenState</a>)
- </p>
- <p>
- <p>GrafanaStateServiceAccount contains the service account ID, login and token ID.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>id</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>login</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>tokenID</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.MFA">MFA
- </h3>
- <p>
- <p>MFA generates a new TOTP token that is compliant with RFC 6238.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.MFASpec">
- MFASpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>secret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Secret is a secret selector to a secret containing the seed secret to generate the TOTP value from.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>length</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <p>Length defines the token length. Defaults to 6 characters.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>timePeriod</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <p>TimePeriod defines how long the token can be active. Defaults to 30 seconds.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>algorithm</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Algorithm to use for encoding. Defaults to SHA1 as per the RFC.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>when</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <p>When defines a time parameter that can be used to pin the origin time of the generated token.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.MFASpec">MFASpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.MFA">MFA</a>)
- </p>
- <p>
- <p>MFASpec controls the behavior of the mfa generator.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Secret is a secret selector to a secret containing the seed secret to generate the TOTP value from.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>length</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <p>Length defines the token length. Defaults to 6 characters.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>timePeriod</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <p>TimePeriod defines how long the token can be active. Defaults to 30 seconds.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>algorithm</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Algorithm to use for encoding. Defaults to SHA1 as per the RFC.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>when</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <p>When defines a time parameter that can be used to pin the origin time of the generated token.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.NTLMProtocol">NTLMProtocol
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.AuthorizationProtocol">AuthorizationProtocol</a>)
- </p>
- <p>
- <p>NTLMProtocol contains the NTLM-specific configuration.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>usernameSecret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>passwordSecret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.Password">Password
- </h3>
- <p>
- <p>Password generates a random password based on the
- configuration parameters in spec.
- You can specify the length, characterset and other attributes.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.PasswordSpec">
- PasswordSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>length</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <p>Length of the password to be generated.
- Defaults to 24</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>digits</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <p>Digits specifies the number of digits in the generated
- password. If omitted it defaults to 25% of the length of the password</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>symbols</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <p>Symbols specifies the number of symbol characters in the generated
- password. If omitted it defaults to 25% of the length of the password</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>symbolCharacters</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>SymbolCharacters specifies the special characters that should be used
- in the generated password.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>noUpper</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <p>Set NoUpper to disable uppercase characters</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>allowRepeat</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <p>set AllowRepeat to true to allow repeating characters.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretKeys</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretKeys defines the keys that will be populated with generated passwords.
- Defaults to “password” when not set.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>encoding</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Encoding specifies the encoding of the generated password.
- Valid values are:
- - “raw” (default): no encoding
- - “base64”: standard base64 encoding
- - “base64url”: base64url encoding
- - “base32”: base32 encoding
- - “hex”: hexadecimal encoding</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.PasswordSpec">PasswordSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.Password">Password</a>)
- </p>
- <p>
- <p>PasswordSpec controls the behavior of the password generator.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>length</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <p>Length of the password to be generated.
- Defaults to 24</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>digits</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <p>Digits specifies the number of digits in the generated
- password. If omitted it defaults to 25% of the length of the password</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>symbols</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <p>Symbols specifies the number of symbol characters in the generated
- password. If omitted it defaults to 25% of the length of the password</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>symbolCharacters</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>SymbolCharacters specifies the special characters that should be used
- in the generated password.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>noUpper</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <p>Set NoUpper to disable uppercase characters</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>allowRepeat</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <p>set AllowRepeat to true to allow repeating characters.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretKeys</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretKeys defines the keys that will be populated with generated passwords.
- Defaults to “password” when not set.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>encoding</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Encoding specifies the encoding of the generated password.
- Valid values are:
- - “raw” (default): no encoding
- - “base64”: standard base64 encoding
- - “base64url”: base64url encoding
- - “base32”: base32 encoding
- - “hex”: hexadecimal encoding</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.QuayAccessToken">QuayAccessToken
- </h3>
- <p>
- <p>QuayAccessToken generates Quay oauth token for pulling/pushing images</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.QuayAccessTokenSpec">
- QuayAccessTokenSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL configures the Quay instance URL. Defaults to quay.io.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>robotAccount</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name of the robot account you are federating with</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <p>Name of the service account you are federating with</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.QuayAccessTokenSpec">QuayAccessTokenSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.QuayAccessToken">QuayAccessToken</a>)
- </p>
- <p>
- <p>QuayAccessTokenSpec defines the desired state to generate a Quay access token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL configures the Quay instance URL. Defaults to quay.io.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>robotAccount</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name of the robot account you are federating with</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <p>Name of the service account you are federating with</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.RequestParameters">RequestParameters
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.STSSessionTokenSpec">STSSessionTokenSpec</a>)
- </p>
- <p>
- <p>RequestParameters contains parameters that can be passed to the STS service.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>sessionDuration</code></br>
- <em>
- int32
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>serialNumber</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SerialNumber is the identification number of the MFA device that is associated with the IAM user who is making
- the GetSessionToken call.
- Possible values: hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device
- (such as arn:aws:iam::123456789012:mfa/user)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tokenCode</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>TokenCode is the value provided by the MFA device, if MFA is required.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.SSHKey">SSHKey
- </h3>
- <p>
- <p>SSHKey generates SSH key pairs.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.SSHKeySpec">
- SSHKeySpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>keyType</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>KeyType specifies the SSH key type (rsa, ecdsa, ed25519)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>keySize</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <p>KeySize specifies the key size for RSA keys (default: 2048) and ECDSA keys (default: 256).
- For RSA keys: 2048, 3072, 4096
- For ECDSA keys: 256, 384, 521
- Ignored for ed25519 keys</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>comment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Comment specifies an optional comment for the SSH key</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.SSHKeySpec">SSHKeySpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.SSHKey">SSHKey</a>)
- </p>
- <p>
- <p>SSHKeySpec controls the behavior of the ssh key generator.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>keyType</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>KeyType specifies the SSH key type (rsa, ecdsa, ed25519)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>keySize</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <p>KeySize specifies the key size for RSA keys (default: 2048) and ECDSA keys (default: 256).
- For RSA keys: 2048, 3072, 4096
- For ECDSA keys: 256, 384, 521
- Ignored for ed25519 keys</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>comment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Comment specifies an optional comment for the SSH key</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.STSSessionToken">STSSessionToken
- </h3>
- <p>
- <p>STSSessionToken uses the GetSessionToken API to retrieve an authorization token.
- The authorization token is valid for 12 hours.
- The authorizationToken returned is a base64 encoded string that can be decoded.
- For more information, see GetSessionToken (<a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_GetSessionToken.html">https://docs.aws.amazon.com/STS/latest/APIReference/API_GetSessionToken.html</a>).</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.STSSessionTokenSpec">
- STSSessionTokenSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Region specifies the region to operate in.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.AWSAuth">
- AWSAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth defines how to authenticate with AWS</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>You can assume a role before making calls to the
- desired AWS service.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>requestParameters</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.RequestParameters">
- RequestParameters
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>RequestParameters contains parameters that can be passed to the STS service.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.STSSessionTokenSpec">STSSessionTokenSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.STSSessionToken">STSSessionToken</a>)
- </p>
- <p>
- <p>STSSessionTokenSpec defines the desired state to generate an AWS STS session token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Region specifies the region to operate in.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.AWSAuth">
- AWSAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth defines how to authenticate with AWS</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>You can assume a role before making calls to the
- desired AWS service.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>requestParameters</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.RequestParameters">
- RequestParameters
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>RequestParameters contains parameters that can be passed to the STS service.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.SecretKeySelector">SecretKeySelector
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaAuth">GrafanaAuth</a>,
- <a href="#generators.external-secrets.io/v1alpha1.GrafanaBasicAuth">GrafanaBasicAuth</a>,
- <a href="#generators.external-secrets.io/v1alpha1.WebhookSecret">WebhookSecret</a>)
- </p>
- <p>
- <p>SecretKeySelector defines a reference to a specific key within a Kubernetes Secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The name of the Secret resource being referred to.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The key where the token is found.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.StatefulResource">StatefulResource
- </h3>
- <p>
- <p>StatefulResource represents a Kubernetes resource that has state which can be tracked.</p>
- </p>
- <h3 id="generators.external-secrets.io/v1alpha1.UUID">UUID
- </h3>
- <p>
- <p>UUID generates a version 1 UUID (e56657e3-764f-11ef-a397-65231a88c216).</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.UUIDSpec">
- UUIDSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.UUIDSpec">UUIDSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.UUID">UUID</a>)
- </p>
- <p>
- <p>UUIDSpec controls the behavior of the uuid generator.</p>
- </p>
- <h3 id="generators.external-secrets.io/v1alpha1.VaultDynamicSecret">VaultDynamicSecret
- </h3>
- <p>
- <p>VaultDynamicSecret represents a generator that can create dynamic secrets from HashiCorp Vault.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.VaultDynamicSecretSpec">
- VaultDynamicSecretSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
- The ESO controller is instantiated with a specific controller name and filters VDS based on this property</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>method</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Vault API method to use (GET/POST/other)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>parameters</code></br>
- <em>
- k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON
- </em>
- </td>
- <td>
- <p>Parameters to pass to Vault write (for non-GET methods)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>getParameters</code></br>
- <em>
- map[string][]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>GetParameters are query-string parameters passed to Vault on GET calls.
- Each key may map to multiple values, matching HTTP query-string semantics.
- Ignored for non-GET methods; use Parameters for write bodies.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>resultType</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.VaultDynamicSecretResultType">
- VaultDynamicSecretResultType
- </a>
- </em>
- </td>
- <td>
- <p>Result type defines which data is returned from the generator.
- By default, it is the “data” section of the Vault API response.
- When using e.g. /auth/token/create the “data” section is empty but
- the “auth” section contains the generated token.
- Please refer to the vault docs regarding the result data structure.
- Additionally, accessing the raw response is possibly by using “Raw” result type.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrySettings</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreRetrySettings">
- SecretStoreRetrySettings
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure http retries if failed</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provider</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultProvider">
- VaultProvider
- </a>
- </em>
- </td>
- <td>
- <p>Vault provider common spec</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Vault path to obtain the dynamic secret from</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>allowEmptyResponse</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Do not fail if no secrets are found. Useful for requests where no data is expected.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.VaultDynamicSecretResultType">VaultDynamicSecretResultType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.VaultDynamicSecretSpec">VaultDynamicSecretSpec</a>)
- </p>
- <p>
- <p>VaultDynamicSecretResultType defines which part of the Vault API response should be returned.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Auth"</p></td>
- <td><p>VaultDynamicSecretResultTypeAuth specifies to return the “auth” section of the Vault API response.</p>
- </td>
- </tr><tr><td><p>"Data"</p></td>
- <td><p>VaultDynamicSecretResultTypeData specifies to return the “data” section of the Vault API response.</p>
- </td>
- </tr><tr><td><p>"Raw"</p></td>
- <td><p>VaultDynamicSecretResultTypeRaw specifies to return the raw response from the Vault API.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.VaultDynamicSecretSpec">VaultDynamicSecretSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.VaultDynamicSecret">VaultDynamicSecret</a>)
- </p>
- <p>
- <p>VaultDynamicSecretSpec defines the desired spec of VaultDynamicSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
- The ESO controller is instantiated with a specific controller name and filters VDS based on this property</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>method</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Vault API method to use (GET/POST/other)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>parameters</code></br>
- <em>
- k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON
- </em>
- </td>
- <td>
- <p>Parameters to pass to Vault write (for non-GET methods)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>getParameters</code></br>
- <em>
- map[string][]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>GetParameters are query-string parameters passed to Vault on GET calls.
- Each key may map to multiple values, matching HTTP query-string semantics.
- Ignored for non-GET methods; use Parameters for write bodies.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>resultType</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.VaultDynamicSecretResultType">
- VaultDynamicSecretResultType
- </a>
- </em>
- </td>
- <td>
- <p>Result type defines which data is returned from the generator.
- By default, it is the “data” section of the Vault API response.
- When using e.g. /auth/token/create the “data” section is empty but
- the “auth” section contains the generated token.
- Please refer to the vault docs regarding the result data structure.
- Additionally, accessing the raw response is possibly by using “Raw” result type.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrySettings</code></br>
- <em>
- <a href="#external-secrets.io/v1.SecretStoreRetrySettings">
- SecretStoreRetrySettings
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure http retries if failed</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provider</code></br>
- <em>
- <a href="#external-secrets.io/v1.VaultProvider">
- VaultProvider
- </a>
- </em>
- </td>
- <td>
- <p>Vault provider common spec</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Vault path to obtain the dynamic secret from</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>allowEmptyResponse</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Do not fail if no secrets are found. Useful for requests where no data is expected.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.Webhook">Webhook
- </h3>
- <p>
- <p>Webhook connects to a third party API server to handle the secrets generation
- configuration parameters in spec.
- You can specify the server, the token, and additional body parameters.
- See documentation for the full API specification for requests and responses.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookSpec">
- WebhookSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>method</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Webhook Method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Webhook url to call</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>headers</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Headers</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.AuthorizationProtocol">
- AuthorizationProtocol
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth specifies a authorization protocol. Only one protocol may be set.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>body</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Body</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>timeout</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Timeout</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>result</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookResult">
- WebhookResult
- </a>
- </em>
- </td>
- <td>
- <p>Result formatting</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secrets</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookSecret">
- []WebhookSecret
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Secrets to fill in templates
- These secrets will be passed to the templating function as key value pairs under the given name</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
- if the Server URL is using HTTPS protocol. This parameter is ignored for
- plain HTTP protocol connection. If not set the system root certificates
- are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookCAProvider">
- WebhookCAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.WebhookCAProvider">WebhookCAProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookSpec">WebhookSpec</a>)
- </p>
- <p>
- <p>WebhookCAProvider defines a location to fetch the cert for the webhook provider from.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookCAProviderType">
- WebhookCAProviderType
- </a>
- </em>
- </td>
- <td>
- <p>The type of provider to use such as “Secret”, or “ConfigMap”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The name of the object located at the provider type.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The key where the CA certificate can be found in the Secret or ConfigMap.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The namespace the Provider type is in.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.WebhookCAProviderType">WebhookCAProviderType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookCAProvider">WebhookCAProvider</a>)
- </p>
- <p>
- <p>WebhookCAProviderType defines the type of provider for webhook CA certificates.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ConfigMap"</p></td>
- <td><p>WebhookCAProviderTypeConfigMap indicates the CA provider is a ConfigMap resource.</p>
- </td>
- </tr><tr><td><p>"Secret"</p></td>
- <td><p>WebhookCAProviderTypeSecret indicates the CA provider is a Secret resource.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.WebhookResult">WebhookResult
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookSpec">WebhookSpec</a>)
- </p>
- <p>
- <p>WebhookResult defines how to format and extract results from the webhook response.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>jsonPath</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Json path of return value</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.WebhookSecret">WebhookSecret
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookSpec">WebhookSpec</a>)
- </p>
- <p>
- <p>WebhookSecret defines a secret reference that will be used in webhook templates.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name of this secret in templates</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.SecretKeySelector">
- SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Secret ref to fill in credentials</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="generators.external-secrets.io/v1alpha1.WebhookSpec">WebhookSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#generators.external-secrets.io/v1alpha1.GeneratorSpec">GeneratorSpec</a>,
- <a href="#generators.external-secrets.io/v1alpha1.Webhook">Webhook</a>)
- </p>
- <p>
- <p>WebhookSpec controls the behavior of the external generator. Any body parameters should be passed to the server through the parameters field.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>method</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Webhook Method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Webhook url to call</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>headers</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Headers</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.AuthorizationProtocol">
- AuthorizationProtocol
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth specifies a authorization protocol. Only one protocol may be set.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>body</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Body</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>timeout</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Timeout</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>result</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookResult">
- WebhookResult
- </a>
- </em>
- </td>
- <td>
- <p>Result formatting</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secrets</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookSecret">
- []WebhookSecret
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Secrets to fill in templates
- These secrets will be passed to the templating function as key value pairs under the given name</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
- if the Server URL is using HTTPS protocol. This parameter is ignored for
- plain HTTP protocol connection. If not set the system root certificates
- are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#generators.external-secrets.io/v1alpha1.WebhookCAProvider">
- WebhookCAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <hr/>
- <p><em>
- Generated with <code>gen-crd-api-reference-docs</code>.
- </em></p>
-
-
- </article>
- </div>
-
-
- <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
- </div>
-
- </main>
-
- <img referrerpolicy="no-referrer-when-downgrade"
- src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""
- hidden />
-
- <footer class="md-footer">
-
- <div class="md-footer-meta md-typeset">
- <div class="md-footer-meta__inner md-grid">
- <div class="md-copyright">
-
- <div class="md-copyright__highlight">
- © 2025 The external-secrets Authors.<br/>
- © 2025 The Linux Foundation. All rights reserved.<br/><br/>
- The Linux Foundation has registered trademarks and uses trademarks.<br/>
- For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
- </div>
-
-
- Made with
- <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
- Material for MkDocs
- </a>
-
- </div>
-
- </div>
- </div>
- </footer>
-
- </div>
- <div class="md-dialog" data-md-component="dialog">
- <div class="md-dialog__inner md-typeset"></div>
- </div>
-
-
-
-
-
- <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
-
-
- <script src="../../assets/javascripts/bundle.d7400e89.min.js"></script>
-
-
- </body>
- </html>
|
