index.html 154 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="icon" href="../../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
  8. <title>API specification - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("../..",location),__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>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. </div>
  24. <div data-md-component="announce">
  25. </div>
  26. <div data-md-component="outdated" hidden>
  27. <aside class="md-banner md-banner--warning">
  28. <div class="md-banner__inner md-grid md-typeset">
  29. You're not viewing the latest version.
  30. <a href="../../..">
  31. <strong>Click here to go to latest.</strong>
  32. </a>
  33. </div>
  34. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  35. </aside>
  36. </div>
  37. <header class="md-header" data-md-component="header">
  38. <nav class="md-header__inner md-grid" aria-label="Header">
  39. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  40. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  41. </a>
  42. <label class="md-header__button md-icon" for="__drawer">
  43. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  44. </label>
  45. <div class="md-header__title" data-md-component="header-title">
  46. <div class="md-header__ellipsis">
  47. <div class="md-header__topic">
  48. <span class="md-ellipsis">
  49. External Secrets Operator
  50. </span>
  51. </div>
  52. <div class="md-header__topic" data-md-component="header-topic">
  53. <span class="md-ellipsis">
  54. API specification
  55. </span>
  56. </div>
  57. </div>
  58. </div>
  59. <label class="md-header__button md-icon" for="__search">
  60. <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.516 6.516 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 5z"/></svg>
  61. </label>
  62. <div class="md-search" data-md-component="search" role="dialog">
  63. <label class="md-search__overlay" for="__search"></label>
  64. <div class="md-search__inner" role="search">
  65. <form class="md-search__form" name="search">
  66. <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>
  67. <label class="md-search__icon md-icon" for="__search">
  68. <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.516 6.516 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 5z"/></svg>
  69. <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 11h12z"/></svg>
  70. </label>
  71. <nav class="md-search__options" aria-label="Search">
  72. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  73. <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 12 19 6.41z"/></svg>
  74. </button>
  75. </nav>
  76. </form>
  77. <div class="md-search__output">
  78. <div class="md-search__scrollwrap" data-md-scrollfix>
  79. <div class="md-search-result" data-md-component="search-result">
  80. <div class="md-search-result__meta">
  81. Initializing search
  82. </div>
  83. <ol class="md-search-result__list"></ol>
  84. </div>
  85. </div>
  86. </div>
  87. </div>
  88. </div>
  89. <div class="md-header__source">
  90. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  91. <div class="md-source__icon md-icon">
  92. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  93. </div>
  94. <div class="md-source__repository">
  95. External Secrets Operator
  96. </div>
  97. </a>
  98. </div>
  99. </nav>
  100. </header>
  101. <div class="md-container" data-md-component="container">
  102. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  103. <div class="md-tabs__inner md-grid">
  104. <ul class="md-tabs__list">
  105. <li class="md-tabs__item">
  106. <a href="../.." class="md-tabs__link">
  107. Introduction
  108. </a>
  109. </li>
  110. <li class="md-tabs__item">
  111. <a href="../components/" class="md-tabs__link md-tabs__link--active">
  112. API
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../../guides/introduction/" class="md-tabs__link">
  117. Guides
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  122. Provider
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  127. Examples
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../contributing/devguide/" class="md-tabs__link">
  132. Community
  133. </a>
  134. </li>
  135. </ul>
  136. </div>
  137. </nav>
  138. <main class="md-main" data-md-component="main">
  139. <div class="md-main__inner md-grid">
  140. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  141. <div class="md-sidebar__scrollwrap">
  142. <div class="md-sidebar__inner">
  143. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  144. <label class="md-nav__title" for="__drawer">
  145. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  146. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  147. </a>
  148. External Secrets Operator
  149. </label>
  150. <div class="md-nav__source">
  151. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  152. <div class="md-source__icon md-icon">
  153. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  154. </div>
  155. <div class="md-source__repository">
  156. External Secrets Operator
  157. </div>
  158. </a>
  159. </div>
  160. <ul class="md-nav__list" data-md-scrollfix>
  161. <li class="md-nav__item md-nav__item--nested">
  162. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  163. <div class="md-nav__link md-nav__link--index ">
  164. <a href="../..">Introduction</a>
  165. <label for="__nav_1">
  166. <span class="md-nav__icon md-icon"></span>
  167. </label>
  168. </div>
  169. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  170. <label class="md-nav__title" for="__nav_1">
  171. <span class="md-nav__icon md-icon"></span>
  172. Introduction
  173. </label>
  174. <ul class="md-nav__list" data-md-scrollfix>
  175. <li class="md-nav__item">
  176. <a href="../../introduction/overview/" class="md-nav__link">
  177. Overview
  178. </a>
  179. </li>
  180. <li class="md-nav__item">
  181. <a href="../../introduction/getting-started/" class="md-nav__link">
  182. Getting started
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../../introduction/faq/" class="md-nav__link">
  187. FAQ
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../../introduction/stability-support/" class="md-nav__link">
  192. Stability and Support
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  197. Deprecation Policy
  198. </a>
  199. </li>
  200. </ul>
  201. </nav>
  202. </li>
  203. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  204. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
  205. <label class="md-nav__link" for="__nav_2">
  206. API
  207. <span class="md-nav__icon md-icon"></span>
  208. </label>
  209. <nav class="md-nav" aria-label="API" data-md-level="1">
  210. <label class="md-nav__title" for="__nav_2">
  211. <span class="md-nav__icon md-icon"></span>
  212. API
  213. </label>
  214. <ul class="md-nav__list" data-md-scrollfix>
  215. <li class="md-nav__item">
  216. <a href="../components/" class="md-nav__link">
  217. Components
  218. </a>
  219. </li>
  220. <li class="md-nav__item md-nav__item--nested">
  221. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  222. <label class="md-nav__link" for="__nav_2_2">
  223. Core Resources
  224. <span class="md-nav__icon md-icon"></span>
  225. </label>
  226. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  227. <label class="md-nav__title" for="__nav_2_2">
  228. <span class="md-nav__icon md-icon"></span>
  229. Core Resources
  230. </label>
  231. <ul class="md-nav__list" data-md-scrollfix>
  232. <li class="md-nav__item">
  233. <a href="../externalsecret/" class="md-nav__link">
  234. ExternalSecret
  235. </a>
  236. </li>
  237. <li class="md-nav__item">
  238. <a href="../secretstore/" class="md-nav__link">
  239. SecretStore
  240. </a>
  241. </li>
  242. <li class="md-nav__item">
  243. <a href="../clustersecretstore/" class="md-nav__link">
  244. ClusterSecretStore
  245. </a>
  246. </li>
  247. <li class="md-nav__item">
  248. <a href="../clusterexternalsecret/" class="md-nav__link">
  249. ClusterExternalSecret
  250. </a>
  251. </li>
  252. <li class="md-nav__item">
  253. <a href="../pushsecret/" class="md-nav__link">
  254. PushSecret
  255. </a>
  256. </li>
  257. </ul>
  258. </nav>
  259. </li>
  260. <li class="md-nav__item md-nav__item--nested">
  261. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  262. <div class="md-nav__link md-nav__link--index ">
  263. <a href="../generator/">Generators</a>
  264. <label for="__nav_2_3">
  265. <span class="md-nav__icon md-icon"></span>
  266. </label>
  267. </div>
  268. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  269. <label class="md-nav__title" for="__nav_2_3">
  270. <span class="md-nav__icon md-icon"></span>
  271. Generators
  272. </label>
  273. <ul class="md-nav__list" data-md-scrollfix>
  274. <li class="md-nav__item">
  275. <a href="../generator/acr/" class="md-nav__link">
  276. Azure Container Registry
  277. </a>
  278. </li>
  279. <li class="md-nav__item">
  280. <a href="../generator/ecr/" class="md-nav__link">
  281. AWS Elastic Container Registry
  282. </a>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="../generator/gcr/" class="md-nav__link">
  286. Google Container Registry
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../generator/password/" class="md-nav__link">
  291. Password
  292. </a>
  293. </li>
  294. <li class="md-nav__item">
  295. <a href="../generator/fake/" class="md-nav__link">
  296. Fake
  297. </a>
  298. </li>
  299. </ul>
  300. </nav>
  301. </li>
  302. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  303. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" type="checkbox" id="__nav_2_4" checked>
  304. <label class="md-nav__link" for="__nav_2_4">
  305. Reference Docs
  306. <span class="md-nav__icon md-icon"></span>
  307. </label>
  308. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  309. <label class="md-nav__title" for="__nav_2_4">
  310. <span class="md-nav__icon md-icon"></span>
  311. Reference Docs
  312. </label>
  313. <ul class="md-nav__list" data-md-scrollfix>
  314. <li class="md-nav__item md-nav__item--active">
  315. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  316. <a href="./" class="md-nav__link md-nav__link--active">
  317. API specification
  318. </a>
  319. </li>
  320. <li class="md-nav__item">
  321. <a href="../controller-options/" class="md-nav__link">
  322. Controller Options
  323. </a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="../metrics/" class="md-nav__link">
  327. Metrics
  328. </a>
  329. </li>
  330. </ul>
  331. </nav>
  332. </li>
  333. </ul>
  334. </nav>
  335. </li>
  336. <li class="md-nav__item md-nav__item--nested">
  337. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  338. <label class="md-nav__link" for="__nav_3">
  339. Guides
  340. <span class="md-nav__icon md-icon"></span>
  341. </label>
  342. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  343. <label class="md-nav__title" for="__nav_3">
  344. <span class="md-nav__icon md-icon"></span>
  345. Guides
  346. </label>
  347. <ul class="md-nav__list" data-md-scrollfix>
  348. <li class="md-nav__item">
  349. <a href="../../guides/introduction/" class="md-nav__link">
  350. Introduction
  351. </a>
  352. </li>
  353. <li class="md-nav__item md-nav__item--nested">
  354. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  355. <label class="md-nav__link" for="__nav_3_2">
  356. Advanced Templating
  357. <span class="md-nav__icon md-icon"></span>
  358. </label>
  359. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  360. <label class="md-nav__title" for="__nav_3_2">
  361. <span class="md-nav__icon md-icon"></span>
  362. Advanced Templating
  363. </label>
  364. <ul class="md-nav__list" data-md-scrollfix>
  365. <li class="md-nav__item">
  366. <a href="../../guides/templating/" class="md-nav__link">
  367. v2
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../../guides/templating-v1/" class="md-nav__link">
  372. v1
  373. </a>
  374. </li>
  375. </ul>
  376. </nav>
  377. </li>
  378. <li class="md-nav__item">
  379. <a href="../../guides/generator/" class="md-nav__link">
  380. Generators
  381. </a>
  382. </li>
  383. <li class="md-nav__item">
  384. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  385. All keys, One secret
  386. </a>
  387. </li>
  388. <li class="md-nav__item">
  389. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  390. Common K8S Secret Types
  391. </a>
  392. </li>
  393. <li class="md-nav__item">
  394. <a href="../../guides/controller-class/" class="md-nav__link">
  395. Controller Classes
  396. </a>
  397. </li>
  398. <li class="md-nav__item">
  399. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  400. Lifecycle: ownership & deletion
  401. </a>
  402. </li>
  403. <li class="md-nav__item">
  404. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  405. Decoding Strategies
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../guides/getallsecrets/" class="md-nav__link">
  410. Getting Multiple Secrets
  411. </a>
  412. </li>
  413. <li class="md-nav__item">
  414. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  415. Multi Tenancy
  416. </a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  420. Rewriting Keys
  421. </a>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../../guides/v1beta1/" class="md-nav__link">
  425. Upgrading to v1beta1
  426. </a>
  427. </li>
  428. <li class="md-nav__item">
  429. <a href="../../guides/using-latest-image/" class="md-nav__link">
  430. Using Latest Image
  431. </a>
  432. </li>
  433. </ul>
  434. </nav>
  435. </li>
  436. <li class="md-nav__item md-nav__item--nested">
  437. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  438. <label class="md-nav__link" for="__nav_4">
  439. Provider
  440. <span class="md-nav__icon md-icon"></span>
  441. </label>
  442. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  443. <label class="md-nav__title" for="__nav_4">
  444. <span class="md-nav__icon md-icon"></span>
  445. Provider
  446. </label>
  447. <ul class="md-nav__list" data-md-scrollfix>
  448. <li class="md-nav__item">
  449. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  450. AWS Secrets Manager
  451. </a>
  452. </li>
  453. <li class="md-nav__item">
  454. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  455. AWS Parameter Store
  456. </a>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  460. Azure Key Vault
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  465. Google Secret Manager
  466. </a>
  467. </li>
  468. <li class="md-nav__item">
  469. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  470. IBM Secrets Manager
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="../../provider/akeyless/" class="md-nav__link">
  475. Akeyless
  476. </a>
  477. </li>
  478. <li class="md-nav__item">
  479. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  480. HashiCorp Vault
  481. </a>
  482. </li>
  483. <li class="md-nav__item">
  484. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  485. Yandex Certificate Manager
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  490. Yandex Lockbox
  491. </a>
  492. </li>
  493. <li class="md-nav__item">
  494. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  495. Gitlab Variables
  496. </a>
  497. </li>
  498. <li class="md-nav__item">
  499. <a href="../../provider/oracle-vault/" class="md-nav__link">
  500. Oracle Vault
  501. </a>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="../../provider/1password-automation/" class="md-nav__link">
  505. 1Password Secrets Automation
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../provider/webhook/" class="md-nav__link">
  510. Webhook
  511. </a>
  512. </li>
  513. <li class="md-nav__item">
  514. <a href="../../provider/fake/" class="md-nav__link">
  515. Fake
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../../provider/kubernetes/" class="md-nav__link">
  520. Kubernetes
  521. </a>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  525. senhasegura DevOps Secrets Management (DSM)
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="../../provider/doppler/" class="md-nav__link">
  530. Doppler
  531. </a>
  532. </li>
  533. <li class="md-nav__item">
  534. <a href="../../provider/keeper-security/" class="md-nav__link">
  535. Keeper Security
  536. </a>
  537. </li>
  538. </ul>
  539. </nav>
  540. </li>
  541. <li class="md-nav__item md-nav__item--nested">
  542. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  543. <label class="md-nav__link" for="__nav_5">
  544. Examples
  545. <span class="md-nav__icon md-icon"></span>
  546. </label>
  547. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  548. <label class="md-nav__title" for="__nav_5">
  549. <span class="md-nav__icon md-icon"></span>
  550. Examples
  551. </label>
  552. <ul class="md-nav__list" data-md-scrollfix>
  553. <li class="md-nav__item">
  554. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  555. FluxCD
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  560. Anchore Engine
  561. </a>
  562. </li>
  563. <li class="md-nav__item">
  564. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  565. Jenkins
  566. </a>
  567. </li>
  568. </ul>
  569. </nav>
  570. </li>
  571. <li class="md-nav__item md-nav__item--nested">
  572. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  573. <label class="md-nav__link" for="__nav_6">
  574. Community
  575. <span class="md-nav__icon md-icon"></span>
  576. </label>
  577. <nav class="md-nav" aria-label="Community" data-md-level="1">
  578. <label class="md-nav__title" for="__nav_6">
  579. <span class="md-nav__icon md-icon"></span>
  580. Community
  581. </label>
  582. <ul class="md-nav__list" data-md-scrollfix>
  583. <li class="md-nav__item md-nav__item--nested">
  584. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  585. <label class="md-nav__link" for="__nav_6_1">
  586. Contributing
  587. <span class="md-nav__icon md-icon"></span>
  588. </label>
  589. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  590. <label class="md-nav__title" for="__nav_6_1">
  591. <span class="md-nav__icon md-icon"></span>
  592. Contributing
  593. </label>
  594. <ul class="md-nav__list" data-md-scrollfix>
  595. <li class="md-nav__item">
  596. <a href="../../contributing/devguide/" class="md-nav__link">
  597. Developer guide
  598. </a>
  599. </li>
  600. <li class="md-nav__item">
  601. <a href="../../contributing/process/" class="md-nav__link">
  602. Contributing Process
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../../contributing/release/" class="md-nav__link">
  607. Release Process
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="../../contributing/coc/" class="md-nav__link">
  612. Code of Conduct
  613. </a>
  614. </li>
  615. <li class="md-nav__item">
  616. <a href="../../contributing/roadmap/" class="md-nav__link">
  617. Roadmap
  618. </a>
  619. </li>
  620. </ul>
  621. </nav>
  622. </li>
  623. <li class="md-nav__item md-nav__item--nested">
  624. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  625. <label class="md-nav__link" for="__nav_6_2">
  626. External Resources
  627. <span class="md-nav__icon md-icon"></span>
  628. </label>
  629. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  630. <label class="md-nav__title" for="__nav_6_2">
  631. <span class="md-nav__icon md-icon"></span>
  632. External Resources
  633. </label>
  634. <ul class="md-nav__list" data-md-scrollfix>
  635. <li class="md-nav__item">
  636. <a href="../../eso-talks/" class="md-nav__link">
  637. Talks
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../../eso-demos/" class="md-nav__link">
  642. Demos
  643. </a>
  644. </li>
  645. <li class="md-nav__item">
  646. <a href="../../eso-blogs/" class="md-nav__link">
  647. Blogs
  648. </a>
  649. </li>
  650. </ul>
  651. </nav>
  652. </li>
  653. </ul>
  654. </nav>
  655. </li>
  656. </ul>
  657. </nav>
  658. </div>
  659. </div>
  660. </div>
  661. <div class="md-content" data-md-component="content">
  662. <article class="md-content__inner md-typeset">
  663. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/api/spec.md" title="Edit this page" class="md-content__button md-icon">
  664. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  665. </a>
  666. <h1>API specification</h1>
  667. <p>Packages:</p>
  668. <ul>
  669. <li>
  670. <a href="#external-secrets.io%2fv1beta1">external-secrets.io/v1beta1</a>
  671. </li>
  672. </ul>
  673. <h2 id="external-secrets.io/v1beta1">external-secrets.io/v1beta1</h2>
  674. <p>
  675. <p>Package v1beta1 contains resources for external-secrets</p>
  676. </p>
  677. <p>Resource Types:</p>
  678. <ul></ul>
  679. <h3 id="external-secrets.io/v1beta1.AWSAuth">AWSAuth
  680. </h3>
  681. <p>
  682. (<em>Appears on:</em>
  683. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  684. </p>
  685. <p>
  686. <p>AWSAuth tells the controller how to do authentication with aws.
  687. Only one of secretRef or jwt can be specified.
  688. if none is specified the controller will load credentials using the aws sdk defaults.</p>
  689. </p>
  690. <table>
  691. <thead>
  692. <tr>
  693. <th>Field</th>
  694. <th>Description</th>
  695. </tr>
  696. </thead>
  697. <tbody>
  698. <tr>
  699. <td>
  700. <code>secretRef</code></br>
  701. <em>
  702. <a href="#external-secrets.io/v1beta1.AWSAuthSecretRef">
  703. AWSAuthSecretRef
  704. </a>
  705. </em>
  706. </td>
  707. <td>
  708. <em>(Optional)</em>
  709. </td>
  710. </tr>
  711. <tr>
  712. <td>
  713. <code>jwt</code></br>
  714. <em>
  715. <a href="#external-secrets.io/v1beta1.AWSJWTAuth">
  716. AWSJWTAuth
  717. </a>
  718. </em>
  719. </td>
  720. <td>
  721. <em>(Optional)</em>
  722. </td>
  723. </tr>
  724. </tbody>
  725. </table>
  726. <h3 id="external-secrets.io/v1beta1.AWSAuthSecretRef">AWSAuthSecretRef
  727. </h3>
  728. <p>
  729. (<em>Appears on:</em>
  730. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  731. </p>
  732. <p>
  733. <p>AWSAuthSecretRef holds secret references for AWS credentials
  734. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  735. </p>
  736. <table>
  737. <thead>
  738. <tr>
  739. <th>Field</th>
  740. <th>Description</th>
  741. </tr>
  742. </thead>
  743. <tbody>
  744. <tr>
  745. <td>
  746. <code>accessKeyIDSecretRef</code></br>
  747. <em>
  748. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  749. External Secrets meta/v1.SecretKeySelector
  750. </a>
  751. </em>
  752. </td>
  753. <td>
  754. <p>The AccessKeyID is used for authentication</p>
  755. </td>
  756. </tr>
  757. <tr>
  758. <td>
  759. <code>secretAccessKeySecretRef</code></br>
  760. <em>
  761. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  762. External Secrets meta/v1.SecretKeySelector
  763. </a>
  764. </em>
  765. </td>
  766. <td>
  767. <p>The SecretAccessKey is used for authentication</p>
  768. </td>
  769. </tr>
  770. <tr>
  771. <td>
  772. <code>sessionTokenSecretRef</code></br>
  773. <em>
  774. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  775. External Secrets meta/v1.SecretKeySelector
  776. </a>
  777. </em>
  778. </td>
  779. <td>
  780. <p>The SessionToken used for authentication
  781. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  782. 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>
  783. </td>
  784. </tr>
  785. </tbody>
  786. </table>
  787. <h3 id="external-secrets.io/v1beta1.AWSJWTAuth">AWSJWTAuth
  788. </h3>
  789. <p>
  790. (<em>Appears on:</em>
  791. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  792. </p>
  793. <p>
  794. <p>Authenticate against AWS using service account tokens.</p>
  795. </p>
  796. <table>
  797. <thead>
  798. <tr>
  799. <th>Field</th>
  800. <th>Description</th>
  801. </tr>
  802. </thead>
  803. <tbody>
  804. <tr>
  805. <td>
  806. <code>serviceAccountRef</code></br>
  807. <em>
  808. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  809. External Secrets meta/v1.ServiceAccountSelector
  810. </a>
  811. </em>
  812. </td>
  813. <td>
  814. </td>
  815. </tr>
  816. </tbody>
  817. </table>
  818. <h3 id="external-secrets.io/v1beta1.AWSProvider">AWSProvider
  819. </h3>
  820. <p>
  821. (<em>Appears on:</em>
  822. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  823. </p>
  824. <p>
  825. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  826. </p>
  827. <table>
  828. <thead>
  829. <tr>
  830. <th>Field</th>
  831. <th>Description</th>
  832. </tr>
  833. </thead>
  834. <tbody>
  835. <tr>
  836. <td>
  837. <code>service</code></br>
  838. <em>
  839. <a href="#external-secrets.io/v1beta1.AWSServiceType">
  840. AWSServiceType
  841. </a>
  842. </em>
  843. </td>
  844. <td>
  845. <p>Service defines which service should be used to fetch the secrets</p>
  846. </td>
  847. </tr>
  848. <tr>
  849. <td>
  850. <code>auth</code></br>
  851. <em>
  852. <a href="#external-secrets.io/v1beta1.AWSAuth">
  853. AWSAuth
  854. </a>
  855. </em>
  856. </td>
  857. <td>
  858. <em>(Optional)</em>
  859. <p>Auth defines the information necessary to authenticate against AWS
  860. if not set aws sdk will infer credentials from your environment
  861. 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>
  862. </td>
  863. </tr>
  864. <tr>
  865. <td>
  866. <code>role</code></br>
  867. <em>
  868. string
  869. </em>
  870. </td>
  871. <td>
  872. <em>(Optional)</em>
  873. <p>Role is a Role ARN which the SecretManager provider will assume</p>
  874. </td>
  875. </tr>
  876. <tr>
  877. <td>
  878. <code>region</code></br>
  879. <em>
  880. string
  881. </em>
  882. </td>
  883. <td>
  884. <p>AWS Region to be used for the provider</p>
  885. </td>
  886. </tr>
  887. <tr>
  888. <td>
  889. <code>additionalRoles</code></br>
  890. <em>
  891. []string
  892. </em>
  893. </td>
  894. <td>
  895. <em>(Optional)</em>
  896. <p>AdditionalRoles is a chained list of Role ARNs which the SecretManager provider will sequentially assume before assuming Role</p>
  897. </td>
  898. </tr>
  899. </tbody>
  900. </table>
  901. <h3 id="external-secrets.io/v1beta1.AWSServiceType">AWSServiceType
  902. (<code>string</code> alias)</p></h3>
  903. <p>
  904. (<em>Appears on:</em>
  905. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  906. </p>
  907. <p>
  908. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  909. </p>
  910. <table>
  911. <thead>
  912. <tr>
  913. <th>Value</th>
  914. <th>Description</th>
  915. </tr>
  916. </thead>
  917. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  918. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore.
  919. 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>
  920. </td>
  921. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  922. <td><p>AWSServiceSecretsManager is the AWS SecretsManager.
  923. 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>
  924. </td>
  925. </tr></tbody>
  926. </table>
  927. <h3 id="external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth
  928. </h3>
  929. <p>
  930. (<em>Appears on:</em>
  931. <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>)
  932. </p>
  933. <p>
  934. </p>
  935. <table>
  936. <thead>
  937. <tr>
  938. <th>Field</th>
  939. <th>Description</th>
  940. </tr>
  941. </thead>
  942. <tbody>
  943. <tr>
  944. <td>
  945. <code>secretRef</code></br>
  946. <em>
  947. <a href="#external-secrets.io/v1beta1.AkeylessAuthSecretRef">
  948. AkeylessAuthSecretRef
  949. </a>
  950. </em>
  951. </td>
  952. <td>
  953. <em>(Optional)</em>
  954. <p>Reference to a Secret that contains the details
  955. to authenticate with Akeyless.</p>
  956. </td>
  957. </tr>
  958. <tr>
  959. <td>
  960. <code>kubernetesAuth</code></br>
  961. <em>
  962. <a href="#external-secrets.io/v1beta1.AkeylessKubernetesAuth">
  963. AkeylessKubernetesAuth
  964. </a>
  965. </em>
  966. </td>
  967. <td>
  968. <em>(Optional)</em>
  969. <p>Kubernetes authenticates with Akeyless by passing the ServiceAccount
  970. token stored in the named Secret resource.</p>
  971. </td>
  972. </tr>
  973. </tbody>
  974. </table>
  975. <h3 id="external-secrets.io/v1beta1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
  976. </h3>
  977. <p>
  978. (<em>Appears on:</em>
  979. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  980. </p>
  981. <p>
  982. <p>AkeylessAuthSecretRef
  983. AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
  984. </p>
  985. <table>
  986. <thead>
  987. <tr>
  988. <th>Field</th>
  989. <th>Description</th>
  990. </tr>
  991. </thead>
  992. <tbody>
  993. <tr>
  994. <td>
  995. <code>accessID</code></br>
  996. <em>
  997. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  998. External Secrets meta/v1.SecretKeySelector
  999. </a>
  1000. </em>
  1001. </td>
  1002. <td>
  1003. <p>The SecretAccessID is used for authentication</p>
  1004. </td>
  1005. </tr>
  1006. <tr>
  1007. <td>
  1008. <code>accessType</code></br>
  1009. <em>
  1010. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1011. External Secrets meta/v1.SecretKeySelector
  1012. </a>
  1013. </em>
  1014. </td>
  1015. <td>
  1016. </td>
  1017. </tr>
  1018. <tr>
  1019. <td>
  1020. <code>accessTypeParam</code></br>
  1021. <em>
  1022. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1023. External Secrets meta/v1.SecretKeySelector
  1024. </a>
  1025. </em>
  1026. </td>
  1027. <td>
  1028. </td>
  1029. </tr>
  1030. </tbody>
  1031. </table>
  1032. <h3 id="external-secrets.io/v1beta1.AkeylessKubernetesAuth">AkeylessKubernetesAuth
  1033. </h3>
  1034. <p>
  1035. (<em>Appears on:</em>
  1036. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  1037. </p>
  1038. <p>
  1039. <p>Authenticate with Kubernetes ServiceAccount token stored.</p>
  1040. </p>
  1041. <table>
  1042. <thead>
  1043. <tr>
  1044. <th>Field</th>
  1045. <th>Description</th>
  1046. </tr>
  1047. </thead>
  1048. <tbody>
  1049. <tr>
  1050. <td>
  1051. <code>accessID</code></br>
  1052. <em>
  1053. string
  1054. </em>
  1055. </td>
  1056. <td>
  1057. <p>the Akeyless Kubernetes auth-method access-id</p>
  1058. </td>
  1059. </tr>
  1060. <tr>
  1061. <td>
  1062. <code>k8sConfName</code></br>
  1063. <em>
  1064. string
  1065. </em>
  1066. </td>
  1067. <td>
  1068. <p>Kubernetes-auth configuration name in Akeyless-Gateway</p>
  1069. </td>
  1070. </tr>
  1071. <tr>
  1072. <td>
  1073. <code>serviceAccountRef</code></br>
  1074. <em>
  1075. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  1076. External Secrets meta/v1.ServiceAccountSelector
  1077. </a>
  1078. </em>
  1079. </td>
  1080. <td>
  1081. <em>(Optional)</em>
  1082. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  1083. If the service account is specified, the service account secret token JWT will be used
  1084. for authenticating with Akeyless. If the service account selector is not supplied,
  1085. the secretRef will be used instead.</p>
  1086. </td>
  1087. </tr>
  1088. <tr>
  1089. <td>
  1090. <code>secretRef</code></br>
  1091. <em>
  1092. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1093. External Secrets meta/v1.SecretKeySelector
  1094. </a>
  1095. </em>
  1096. </td>
  1097. <td>
  1098. <em>(Optional)</em>
  1099. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  1100. for authenticating with Akeyless. If a name is specified without a key,
  1101. <code>token</code> is the default. If one is not specified, the one bound to
  1102. the controller will be used.</p>
  1103. </td>
  1104. </tr>
  1105. </tbody>
  1106. </table>
  1107. <h3 id="external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider
  1108. </h3>
  1109. <p>
  1110. (<em>Appears on:</em>
  1111. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1112. </p>
  1113. <p>
  1114. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  1115. </p>
  1116. <table>
  1117. <thead>
  1118. <tr>
  1119. <th>Field</th>
  1120. <th>Description</th>
  1121. </tr>
  1122. </thead>
  1123. <tbody>
  1124. <tr>
  1125. <td>
  1126. <code>akeylessGWApiURL</code></br>
  1127. <em>
  1128. string
  1129. </em>
  1130. </td>
  1131. <td>
  1132. <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
  1133. </td>
  1134. </tr>
  1135. <tr>
  1136. <td>
  1137. <code>authSecretRef</code></br>
  1138. <em>
  1139. <a href="#external-secrets.io/v1beta1.AkeylessAuth">
  1140. AkeylessAuth
  1141. </a>
  1142. </em>
  1143. </td>
  1144. <td>
  1145. <p>Auth configures how the operator authenticates with Akeyless.</p>
  1146. </td>
  1147. </tr>
  1148. </tbody>
  1149. </table>
  1150. <h3 id="external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth
  1151. </h3>
  1152. <p>
  1153. (<em>Appears on:</em>
  1154. <a href="#external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider</a>)
  1155. </p>
  1156. <p>
  1157. <p>AlibabaAuth contains a secretRef for credentials.</p>
  1158. </p>
  1159. <table>
  1160. <thead>
  1161. <tr>
  1162. <th>Field</th>
  1163. <th>Description</th>
  1164. </tr>
  1165. </thead>
  1166. <tbody>
  1167. <tr>
  1168. <td>
  1169. <code>secretRef</code></br>
  1170. <em>
  1171. <a href="#external-secrets.io/v1beta1.AlibabaAuthSecretRef">
  1172. AlibabaAuthSecretRef
  1173. </a>
  1174. </em>
  1175. </td>
  1176. <td>
  1177. </td>
  1178. </tr>
  1179. </tbody>
  1180. </table>
  1181. <h3 id="external-secrets.io/v1beta1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
  1182. </h3>
  1183. <p>
  1184. (<em>Appears on:</em>
  1185. <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
  1186. </p>
  1187. <p>
  1188. <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
  1189. </p>
  1190. <table>
  1191. <thead>
  1192. <tr>
  1193. <th>Field</th>
  1194. <th>Description</th>
  1195. </tr>
  1196. </thead>
  1197. <tbody>
  1198. <tr>
  1199. <td>
  1200. <code>accessKeyIDSecretRef</code></br>
  1201. <em>
  1202. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1203. External Secrets meta/v1.SecretKeySelector
  1204. </a>
  1205. </em>
  1206. </td>
  1207. <td>
  1208. <p>The AccessKeyID is used for authentication</p>
  1209. </td>
  1210. </tr>
  1211. <tr>
  1212. <td>
  1213. <code>accessKeySecretSecretRef</code></br>
  1214. <em>
  1215. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1216. External Secrets meta/v1.SecretKeySelector
  1217. </a>
  1218. </em>
  1219. </td>
  1220. <td>
  1221. <p>The AccessKeySecret is used for authentication</p>
  1222. </td>
  1223. </tr>
  1224. </tbody>
  1225. </table>
  1226. <h3 id="external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider
  1227. </h3>
  1228. <p>
  1229. (<em>Appears on:</em>
  1230. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1231. </p>
  1232. <p>
  1233. <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
  1234. </p>
  1235. <table>
  1236. <thead>
  1237. <tr>
  1238. <th>Field</th>
  1239. <th>Description</th>
  1240. </tr>
  1241. </thead>
  1242. <tbody>
  1243. <tr>
  1244. <td>
  1245. <code>auth</code></br>
  1246. <em>
  1247. <a href="#external-secrets.io/v1beta1.AlibabaAuth">
  1248. AlibabaAuth
  1249. </a>
  1250. </em>
  1251. </td>
  1252. <td>
  1253. </td>
  1254. </tr>
  1255. <tr>
  1256. <td>
  1257. <code>endpoint</code></br>
  1258. <em>
  1259. string
  1260. </em>
  1261. </td>
  1262. <td>
  1263. <em>(Optional)</em>
  1264. </td>
  1265. </tr>
  1266. <tr>
  1267. <td>
  1268. <code>regionID</code></br>
  1269. <em>
  1270. string
  1271. </em>
  1272. </td>
  1273. <td>
  1274. <p>Alibaba Region to be used for the provider</p>
  1275. </td>
  1276. </tr>
  1277. </tbody>
  1278. </table>
  1279. <h3 id="external-secrets.io/v1beta1.AzureAuthType">AzureAuthType
  1280. (<code>string</code> alias)</p></h3>
  1281. <p>
  1282. (<em>Appears on:</em>
  1283. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1284. </p>
  1285. <p>
  1286. <p>AuthType describes how to authenticate to the Azure Keyvault
  1287. Only one of the following auth types may be specified.
  1288. If none of the following auth type is specified, the default one
  1289. is ServicePrincipal.</p>
  1290. </p>
  1291. <table>
  1292. <thead>
  1293. <tr>
  1294. <th>Value</th>
  1295. <th>Description</th>
  1296. </tr>
  1297. </thead>
  1298. <tbody><tr><td><p>&#34;ManagedIdentity&#34;</p></td>
  1299. <td><p>Using Managed Identity to authenticate. Used with aad-pod-identity installed in the cluster.</p>
  1300. </td>
  1301. </tr><tr><td><p>&#34;ServicePrincipal&#34;</p></td>
  1302. <td><p>Using service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.</p>
  1303. </td>
  1304. </tr><tr><td><p>&#34;WorkloadIdentity&#34;</p></td>
  1305. <td><p>Using Workload Identity service accounts to authenticate.</p>
  1306. </td>
  1307. </tr></tbody>
  1308. </table>
  1309. <h3 id="external-secrets.io/v1beta1.AzureEnvironmentType">AzureEnvironmentType
  1310. (<code>string</code> alias)</p></h3>
  1311. <p>
  1312. (<em>Appears on:</em>
  1313. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1314. </p>
  1315. <p>
  1316. <p>AzureEnvironmentType specifies the Azure cloud environment endpoints to use for
  1317. connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
  1318. 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>
  1319. PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
  1320. </p>
  1321. <table>
  1322. <thead>
  1323. <tr>
  1324. <th>Value</th>
  1325. <th>Description</th>
  1326. </tr>
  1327. </thead>
  1328. <tbody><tr><td><p>&#34;ChinaCloud&#34;</p></td>
  1329. <td></td>
  1330. </tr><tr><td><p>&#34;GermanCloud&#34;</p></td>
  1331. <td></td>
  1332. </tr><tr><td><p>&#34;PublicCloud&#34;</p></td>
  1333. <td></td>
  1334. </tr><tr><td><p>&#34;USGovernmentCloud&#34;</p></td>
  1335. <td></td>
  1336. </tr></tbody>
  1337. </table>
  1338. <h3 id="external-secrets.io/v1beta1.AzureKVAuth">AzureKVAuth
  1339. </h3>
  1340. <p>
  1341. (<em>Appears on:</em>
  1342. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1343. </p>
  1344. <p>
  1345. <p>Configuration used to authenticate with Azure.</p>
  1346. </p>
  1347. <table>
  1348. <thead>
  1349. <tr>
  1350. <th>Field</th>
  1351. <th>Description</th>
  1352. </tr>
  1353. </thead>
  1354. <tbody>
  1355. <tr>
  1356. <td>
  1357. <code>clientId</code></br>
  1358. <em>
  1359. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1360. External Secrets meta/v1.SecretKeySelector
  1361. </a>
  1362. </em>
  1363. </td>
  1364. <td>
  1365. <em>(Optional)</em>
  1366. <p>The Azure clientId of the service principle used for authentication.</p>
  1367. </td>
  1368. </tr>
  1369. <tr>
  1370. <td>
  1371. <code>clientSecret</code></br>
  1372. <em>
  1373. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1374. External Secrets meta/v1.SecretKeySelector
  1375. </a>
  1376. </em>
  1377. </td>
  1378. <td>
  1379. <em>(Optional)</em>
  1380. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  1381. </td>
  1382. </tr>
  1383. </tbody>
  1384. </table>
  1385. <h3 id="external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider
  1386. </h3>
  1387. <p>
  1388. (<em>Appears on:</em>
  1389. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1390. </p>
  1391. <p>
  1392. <p>Configures an store to sync secrets using Azure KV.</p>
  1393. </p>
  1394. <table>
  1395. <thead>
  1396. <tr>
  1397. <th>Field</th>
  1398. <th>Description</th>
  1399. </tr>
  1400. </thead>
  1401. <tbody>
  1402. <tr>
  1403. <td>
  1404. <code>authType</code></br>
  1405. <em>
  1406. <a href="#external-secrets.io/v1beta1.AzureAuthType">
  1407. AzureAuthType
  1408. </a>
  1409. </em>
  1410. </td>
  1411. <td>
  1412. <em>(Optional)</em>
  1413. <p>Auth type defines how to authenticate to the keyvault service.
  1414. Valid values are:
  1415. - &ldquo;ServicePrincipal&rdquo; (default): Using a service principal (tenantId, clientId, clientSecret)
  1416. - &ldquo;ManagedIdentity&rdquo;: Using Managed Identity assigned to the pod (see aad-pod-identity)</p>
  1417. </td>
  1418. </tr>
  1419. <tr>
  1420. <td>
  1421. <code>vaultUrl</code></br>
  1422. <em>
  1423. string
  1424. </em>
  1425. </td>
  1426. <td>
  1427. <p>Vault Url from which the secrets to be fetched from.</p>
  1428. </td>
  1429. </tr>
  1430. <tr>
  1431. <td>
  1432. <code>tenantId</code></br>
  1433. <em>
  1434. string
  1435. </em>
  1436. </td>
  1437. <td>
  1438. <em>(Optional)</em>
  1439. <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type.</p>
  1440. </td>
  1441. </tr>
  1442. <tr>
  1443. <td>
  1444. <code>environmentType</code></br>
  1445. <em>
  1446. <a href="#external-secrets.io/v1beta1.AzureEnvironmentType">
  1447. AzureEnvironmentType
  1448. </a>
  1449. </em>
  1450. </td>
  1451. <td>
  1452. <p>EnvironmentType specifies the Azure cloud environment endpoints to use for
  1453. connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
  1454. 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>
  1455. PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
  1456. </td>
  1457. </tr>
  1458. <tr>
  1459. <td>
  1460. <code>authSecretRef</code></br>
  1461. <em>
  1462. <a href="#external-secrets.io/v1beta1.AzureKVAuth">
  1463. AzureKVAuth
  1464. </a>
  1465. </em>
  1466. </td>
  1467. <td>
  1468. <em>(Optional)</em>
  1469. <p>Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type.</p>
  1470. </td>
  1471. </tr>
  1472. <tr>
  1473. <td>
  1474. <code>serviceAccountRef</code></br>
  1475. <em>
  1476. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  1477. External Secrets meta/v1.ServiceAccountSelector
  1478. </a>
  1479. </em>
  1480. </td>
  1481. <td>
  1482. <em>(Optional)</em>
  1483. <p>ServiceAccountRef specified the service account
  1484. that should be used when authenticating with WorkloadIdentity.</p>
  1485. </td>
  1486. </tr>
  1487. <tr>
  1488. <td>
  1489. <code>identityId</code></br>
  1490. <em>
  1491. string
  1492. </em>
  1493. </td>
  1494. <td>
  1495. <em>(Optional)</em>
  1496. <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
  1497. </td>
  1498. </tr>
  1499. </tbody>
  1500. </table>
  1501. <h3 id="external-secrets.io/v1beta1.CAProvider">CAProvider
  1502. </h3>
  1503. <p>
  1504. (<em>Appears on:</em>
  1505. <a href="#external-secrets.io/v1beta1.KubernetesServer">KubernetesServer</a>,
  1506. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  1507. </p>
  1508. <p>
  1509. <p>Used to provide custom certificate authority (CA) certificates
  1510. for a secret store. The CAProvider points to a Secret or ConfigMap resource
  1511. that contains a PEM-encoded certificate.</p>
  1512. </p>
  1513. <table>
  1514. <thead>
  1515. <tr>
  1516. <th>Field</th>
  1517. <th>Description</th>
  1518. </tr>
  1519. </thead>
  1520. <tbody>
  1521. <tr>
  1522. <td>
  1523. <code>type</code></br>
  1524. <em>
  1525. <a href="#external-secrets.io/v1beta1.CAProviderType">
  1526. CAProviderType
  1527. </a>
  1528. </em>
  1529. </td>
  1530. <td>
  1531. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  1532. </td>
  1533. </tr>
  1534. <tr>
  1535. <td>
  1536. <code>name</code></br>
  1537. <em>
  1538. string
  1539. </em>
  1540. </td>
  1541. <td>
  1542. <p>The name of the object located at the provider type.</p>
  1543. </td>
  1544. </tr>
  1545. <tr>
  1546. <td>
  1547. <code>key</code></br>
  1548. <em>
  1549. string
  1550. </em>
  1551. </td>
  1552. <td>
  1553. <p>The key where the CA certificate can be found in the Secret or ConfigMap.</p>
  1554. </td>
  1555. </tr>
  1556. <tr>
  1557. <td>
  1558. <code>namespace</code></br>
  1559. <em>
  1560. string
  1561. </em>
  1562. </td>
  1563. <td>
  1564. <em>(Optional)</em>
  1565. <p>The namespace the Provider type is in.
  1566. Can only be defined when used in a ClusterSecretStore.</p>
  1567. </td>
  1568. </tr>
  1569. </tbody>
  1570. </table>
  1571. <h3 id="external-secrets.io/v1beta1.CAProviderType">CAProviderType
  1572. (<code>string</code> alias)</p></h3>
  1573. <p>
  1574. (<em>Appears on:</em>
  1575. <a href="#external-secrets.io/v1beta1.CAProvider">CAProvider</a>)
  1576. </p>
  1577. <p>
  1578. </p>
  1579. <table>
  1580. <thead>
  1581. <tr>
  1582. <th>Value</th>
  1583. <th>Description</th>
  1584. </tr>
  1585. </thead>
  1586. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  1587. <td></td>
  1588. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  1589. <td></td>
  1590. </tr></tbody>
  1591. </table>
  1592. <h3 id="external-secrets.io/v1beta1.CertAuth">CertAuth
  1593. </h3>
  1594. <p>
  1595. (<em>Appears on:</em>
  1596. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  1597. </p>
  1598. <p>
  1599. </p>
  1600. <table>
  1601. <thead>
  1602. <tr>
  1603. <th>Field</th>
  1604. <th>Description</th>
  1605. </tr>
  1606. </thead>
  1607. <tbody>
  1608. <tr>
  1609. <td>
  1610. <code>clientCert</code></br>
  1611. <em>
  1612. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1613. External Secrets meta/v1.SecretKeySelector
  1614. </a>
  1615. </em>
  1616. </td>
  1617. <td>
  1618. </td>
  1619. </tr>
  1620. <tr>
  1621. <td>
  1622. <code>clientKey</code></br>
  1623. <em>
  1624. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1625. External Secrets meta/v1.SecretKeySelector
  1626. </a>
  1627. </em>
  1628. </td>
  1629. <td>
  1630. </td>
  1631. </tr>
  1632. </tbody>
  1633. </table>
  1634. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret
  1635. </h3>
  1636. <p>
  1637. <p>ClusterExternalSecret is the Schema for the clusterexternalsecrets API.</p>
  1638. </p>
  1639. <table>
  1640. <thead>
  1641. <tr>
  1642. <th>Field</th>
  1643. <th>Description</th>
  1644. </tr>
  1645. </thead>
  1646. <tbody>
  1647. <tr>
  1648. <td>
  1649. <code>metadata</code></br>
  1650. <em>
  1651. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  1652. Kubernetes meta/v1.ObjectMeta
  1653. </a>
  1654. </em>
  1655. </td>
  1656. <td>
  1657. Refer to the Kubernetes API documentation for the fields of the
  1658. <code>metadata</code> field.
  1659. </td>
  1660. </tr>
  1661. <tr>
  1662. <td>
  1663. <code>spec</code></br>
  1664. <em>
  1665. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">
  1666. ClusterExternalSecretSpec
  1667. </a>
  1668. </em>
  1669. </td>
  1670. <td>
  1671. <br/>
  1672. <br/>
  1673. <table>
  1674. <tr>
  1675. <td>
  1676. <code>externalSecretSpec</code></br>
  1677. <em>
  1678. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  1679. ExternalSecretSpec
  1680. </a>
  1681. </em>
  1682. </td>
  1683. <td>
  1684. <p>The spec for the ExternalSecrets to be created</p>
  1685. </td>
  1686. </tr>
  1687. <tr>
  1688. <td>
  1689. <code>externalSecretName</code></br>
  1690. <em>
  1691. string
  1692. </em>
  1693. </td>
  1694. <td>
  1695. <em>(Optional)</em>
  1696. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  1697. </td>
  1698. </tr>
  1699. <tr>
  1700. <td>
  1701. <code>namespaceSelector</code></br>
  1702. <em>
  1703. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  1704. Kubernetes meta/v1.LabelSelector
  1705. </a>
  1706. </em>
  1707. </td>
  1708. <td>
  1709. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
  1710. </td>
  1711. </tr>
  1712. <tr>
  1713. <td>
  1714. <code>refreshTime</code></br>
  1715. <em>
  1716. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  1717. Kubernetes meta/v1.Duration
  1718. </a>
  1719. </em>
  1720. </td>
  1721. <td>
  1722. <p>The time in which the controller should reconcile it&rsquo;s objects and recheck namespaces for labels.</p>
  1723. </td>
  1724. </tr>
  1725. </table>
  1726. </td>
  1727. </tr>
  1728. <tr>
  1729. <td>
  1730. <code>status</code></br>
  1731. <em>
  1732. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">
  1733. ClusterExternalSecretStatus
  1734. </a>
  1735. </em>
  1736. </td>
  1737. <td>
  1738. </td>
  1739. </tr>
  1740. </tbody>
  1741. </table>
  1742. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretConditionType">ClusterExternalSecretConditionType
  1743. (<code>string</code> alias)</p></h3>
  1744. <p>
  1745. (<em>Appears on:</em>
  1746. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition</a>)
  1747. </p>
  1748. <p>
  1749. </p>
  1750. <table>
  1751. <thead>
  1752. <tr>
  1753. <th>Value</th>
  1754. <th>Description</th>
  1755. </tr>
  1756. </thead>
  1757. <tbody><tr><td><p>&#34;NotReady&#34;</p></td>
  1758. <td></td>
  1759. </tr><tr><td><p>&#34;PartiallyReady&#34;</p></td>
  1760. <td></td>
  1761. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  1762. <td></td>
  1763. </tr></tbody>
  1764. </table>
  1765. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">ClusterExternalSecretNamespaceFailure
  1766. </h3>
  1767. <p>
  1768. (<em>Appears on:</em>
  1769. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  1770. </p>
  1771. <p>
  1772. <p>ClusterExternalSecretNamespaceFailure represents a failed namespace deployment and it&rsquo;s reason.</p>
  1773. </p>
  1774. <table>
  1775. <thead>
  1776. <tr>
  1777. <th>Field</th>
  1778. <th>Description</th>
  1779. </tr>
  1780. </thead>
  1781. <tbody>
  1782. <tr>
  1783. <td>
  1784. <code>namespace</code></br>
  1785. <em>
  1786. string
  1787. </em>
  1788. </td>
  1789. <td>
  1790. <p>Namespace is the namespace that failed when trying to apply an ExternalSecret</p>
  1791. </td>
  1792. </tr>
  1793. <tr>
  1794. <td>
  1795. <code>reason</code></br>
  1796. <em>
  1797. string
  1798. </em>
  1799. </td>
  1800. <td>
  1801. <em>(Optional)</em>
  1802. <p>Reason is why the ExternalSecret failed to apply to the namespace</p>
  1803. </td>
  1804. </tr>
  1805. </tbody>
  1806. </table>
  1807. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec
  1808. </h3>
  1809. <p>
  1810. (<em>Appears on:</em>
  1811. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  1812. </p>
  1813. <p>
  1814. <p>ClusterExternalSecretSpec defines the desired state of ClusterExternalSecret.</p>
  1815. </p>
  1816. <table>
  1817. <thead>
  1818. <tr>
  1819. <th>Field</th>
  1820. <th>Description</th>
  1821. </tr>
  1822. </thead>
  1823. <tbody>
  1824. <tr>
  1825. <td>
  1826. <code>externalSecretSpec</code></br>
  1827. <em>
  1828. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  1829. ExternalSecretSpec
  1830. </a>
  1831. </em>
  1832. </td>
  1833. <td>
  1834. <p>The spec for the ExternalSecrets to be created</p>
  1835. </td>
  1836. </tr>
  1837. <tr>
  1838. <td>
  1839. <code>externalSecretName</code></br>
  1840. <em>
  1841. string
  1842. </em>
  1843. </td>
  1844. <td>
  1845. <em>(Optional)</em>
  1846. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  1847. </td>
  1848. </tr>
  1849. <tr>
  1850. <td>
  1851. <code>namespaceSelector</code></br>
  1852. <em>
  1853. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  1854. Kubernetes meta/v1.LabelSelector
  1855. </a>
  1856. </em>
  1857. </td>
  1858. <td>
  1859. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
  1860. </td>
  1861. </tr>
  1862. <tr>
  1863. <td>
  1864. <code>refreshTime</code></br>
  1865. <em>
  1866. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  1867. Kubernetes meta/v1.Duration
  1868. </a>
  1869. </em>
  1870. </td>
  1871. <td>
  1872. <p>The time in which the controller should reconcile it&rsquo;s objects and recheck namespaces for labels.</p>
  1873. </td>
  1874. </tr>
  1875. </tbody>
  1876. </table>
  1877. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus
  1878. </h3>
  1879. <p>
  1880. (<em>Appears on:</em>
  1881. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  1882. </p>
  1883. <p>
  1884. <p>ClusterExternalSecretStatus defines the observed state of ClusterExternalSecret.</p>
  1885. </p>
  1886. <table>
  1887. <thead>
  1888. <tr>
  1889. <th>Field</th>
  1890. <th>Description</th>
  1891. </tr>
  1892. </thead>
  1893. <tbody>
  1894. <tr>
  1895. <td>
  1896. <code>failedNamespaces</code></br>
  1897. <em>
  1898. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">
  1899. []ClusterExternalSecretNamespaceFailure
  1900. </a>
  1901. </em>
  1902. </td>
  1903. <td>
  1904. <em>(Optional)</em>
  1905. <p>Failed namespaces are the namespaces that failed to apply an ExternalSecret</p>
  1906. </td>
  1907. </tr>
  1908. <tr>
  1909. <td>
  1910. <code>provisionedNamespaces</code></br>
  1911. <em>
  1912. []string
  1913. </em>
  1914. </td>
  1915. <td>
  1916. <em>(Optional)</em>
  1917. <p>ProvisionedNamespaces are the namespaces where the ClusterExternalSecret has secrets</p>
  1918. </td>
  1919. </tr>
  1920. <tr>
  1921. <td>
  1922. <code>conditions</code></br>
  1923. <em>
  1924. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">
  1925. []ClusterExternalSecretStatusCondition
  1926. </a>
  1927. </em>
  1928. </td>
  1929. <td>
  1930. <em>(Optional)</em>
  1931. </td>
  1932. </tr>
  1933. </tbody>
  1934. </table>
  1935. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition
  1936. </h3>
  1937. <p>
  1938. (<em>Appears on:</em>
  1939. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  1940. </p>
  1941. <p>
  1942. </p>
  1943. <table>
  1944. <thead>
  1945. <tr>
  1946. <th>Field</th>
  1947. <th>Description</th>
  1948. </tr>
  1949. </thead>
  1950. <tbody>
  1951. <tr>
  1952. <td>
  1953. <code>type</code></br>
  1954. <em>
  1955. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretConditionType">
  1956. ClusterExternalSecretConditionType
  1957. </a>
  1958. </em>
  1959. </td>
  1960. <td>
  1961. </td>
  1962. </tr>
  1963. <tr>
  1964. <td>
  1965. <code>status</code></br>
  1966. <em>
  1967. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  1968. Kubernetes core/v1.ConditionStatus
  1969. </a>
  1970. </em>
  1971. </td>
  1972. <td>
  1973. </td>
  1974. </tr>
  1975. <tr>
  1976. <td>
  1977. <code>message</code></br>
  1978. <em>
  1979. string
  1980. </em>
  1981. </td>
  1982. <td>
  1983. <em>(Optional)</em>
  1984. </td>
  1985. </tr>
  1986. </tbody>
  1987. </table>
  1988. <h3 id="external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore
  1989. </h3>
  1990. <p>
  1991. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  1992. </p>
  1993. <table>
  1994. <thead>
  1995. <tr>
  1996. <th>Field</th>
  1997. <th>Description</th>
  1998. </tr>
  1999. </thead>
  2000. <tbody>
  2001. <tr>
  2002. <td>
  2003. <code>metadata</code></br>
  2004. <em>
  2005. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  2006. Kubernetes meta/v1.ObjectMeta
  2007. </a>
  2008. </em>
  2009. </td>
  2010. <td>
  2011. Refer to the Kubernetes API documentation for the fields of the
  2012. <code>metadata</code> field.
  2013. </td>
  2014. </tr>
  2015. <tr>
  2016. <td>
  2017. <code>spec</code></br>
  2018. <em>
  2019. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  2020. SecretStoreSpec
  2021. </a>
  2022. </em>
  2023. </td>
  2024. <td>
  2025. <br/>
  2026. <br/>
  2027. <table>
  2028. <tr>
  2029. <td>
  2030. <code>controller</code></br>
  2031. <em>
  2032. string
  2033. </em>
  2034. </td>
  2035. <td>
  2036. <em>(Optional)</em>
  2037. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  2038. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  2039. </td>
  2040. </tr>
  2041. <tr>
  2042. <td>
  2043. <code>provider</code></br>
  2044. <em>
  2045. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  2046. SecretStoreProvider
  2047. </a>
  2048. </em>
  2049. </td>
  2050. <td>
  2051. <p>Used to configure the provider. Only one provider may be set</p>
  2052. </td>
  2053. </tr>
  2054. <tr>
  2055. <td>
  2056. <code>retrySettings</code></br>
  2057. <em>
  2058. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  2059. SecretStoreRetrySettings
  2060. </a>
  2061. </em>
  2062. </td>
  2063. <td>
  2064. <em>(Optional)</em>
  2065. <p>Used to configure http retries if failed</p>
  2066. </td>
  2067. </tr>
  2068. <tr>
  2069. <td>
  2070. <code>refreshInterval</code></br>
  2071. <em>
  2072. int
  2073. </em>
  2074. </td>
  2075. <td>
  2076. <em>(Optional)</em>
  2077. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  2078. </td>
  2079. </tr>
  2080. <tr>
  2081. <td>
  2082. <code>conditions</code></br>
  2083. <em>
  2084. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  2085. []ClusterSecretStoreCondition
  2086. </a>
  2087. </em>
  2088. </td>
  2089. <td>
  2090. <em>(Optional)</em>
  2091. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  2092. </td>
  2093. </tr>
  2094. </table>
  2095. </td>
  2096. </tr>
  2097. <tr>
  2098. <td>
  2099. <code>status</code></br>
  2100. <em>
  2101. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  2102. SecretStoreStatus
  2103. </a>
  2104. </em>
  2105. </td>
  2106. <td>
  2107. </td>
  2108. </tr>
  2109. </tbody>
  2110. </table>
  2111. <h3 id="external-secrets.io/v1beta1.ClusterSecretStoreCondition">ClusterSecretStoreCondition
  2112. </h3>
  2113. <p>
  2114. (<em>Appears on:</em>
  2115. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  2116. </p>
  2117. <p>
  2118. <p>ClusterSecretStoreCondition describes a condition by which to choose namespaces to process ExternalSecrets in
  2119. for a ClusterSecretStore instance.</p>
  2120. </p>
  2121. <table>
  2122. <thead>
  2123. <tr>
  2124. <th>Field</th>
  2125. <th>Description</th>
  2126. </tr>
  2127. </thead>
  2128. <tbody>
  2129. <tr>
  2130. <td>
  2131. <code>namespaceSelector</code></br>
  2132. <em>
  2133. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  2134. Kubernetes meta/v1.LabelSelector
  2135. </a>
  2136. </em>
  2137. </td>
  2138. <td>
  2139. <em>(Optional)</em>
  2140. <p>Choose namespace using a labelSelector</p>
  2141. </td>
  2142. </tr>
  2143. <tr>
  2144. <td>
  2145. <code>namespaces</code></br>
  2146. <em>
  2147. []string
  2148. </em>
  2149. </td>
  2150. <td>
  2151. <p>Choose namespaces by name</p>
  2152. </td>
  2153. </tr>
  2154. </tbody>
  2155. </table>
  2156. <h3 id="external-secrets.io/v1beta1.DopplerAuth">DopplerAuth
  2157. </h3>
  2158. <p>
  2159. (<em>Appears on:</em>
  2160. <a href="#external-secrets.io/v1beta1.DopplerProvider">DopplerProvider</a>)
  2161. </p>
  2162. <p>
  2163. </p>
  2164. <table>
  2165. <thead>
  2166. <tr>
  2167. <th>Field</th>
  2168. <th>Description</th>
  2169. </tr>
  2170. </thead>
  2171. <tbody>
  2172. <tr>
  2173. <td>
  2174. <code>secretRef</code></br>
  2175. <em>
  2176. <a href="#external-secrets.io/v1beta1.DopplerAuthSecretRef">
  2177. DopplerAuthSecretRef
  2178. </a>
  2179. </em>
  2180. </td>
  2181. <td>
  2182. </td>
  2183. </tr>
  2184. </tbody>
  2185. </table>
  2186. <h3 id="external-secrets.io/v1beta1.DopplerAuthSecretRef">DopplerAuthSecretRef
  2187. </h3>
  2188. <p>
  2189. (<em>Appears on:</em>
  2190. <a href="#external-secrets.io/v1beta1.DopplerAuth">DopplerAuth</a>)
  2191. </p>
  2192. <p>
  2193. </p>
  2194. <table>
  2195. <thead>
  2196. <tr>
  2197. <th>Field</th>
  2198. <th>Description</th>
  2199. </tr>
  2200. </thead>
  2201. <tbody>
  2202. <tr>
  2203. <td>
  2204. <code>dopplerToken</code></br>
  2205. <em>
  2206. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2207. External Secrets meta/v1.SecretKeySelector
  2208. </a>
  2209. </em>
  2210. </td>
  2211. <td>
  2212. <p>The DopplerToken is used for authentication.
  2213. See <a href="https://docs.doppler.com/reference/api#authentication">https://docs.doppler.com/reference/api#authentication</a> for auth token types.
  2214. The Key attribute defaults to dopplerToken if not specified.</p>
  2215. </td>
  2216. </tr>
  2217. </tbody>
  2218. </table>
  2219. <h3 id="external-secrets.io/v1beta1.DopplerProvider">DopplerProvider
  2220. </h3>
  2221. <p>
  2222. (<em>Appears on:</em>
  2223. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2224. </p>
  2225. <p>
  2226. <p>DopplerProvider configures a store to sync secrets using the Doppler provider.
  2227. Project and Config are required if not using a Service Token.</p>
  2228. </p>
  2229. <table>
  2230. <thead>
  2231. <tr>
  2232. <th>Field</th>
  2233. <th>Description</th>
  2234. </tr>
  2235. </thead>
  2236. <tbody>
  2237. <tr>
  2238. <td>
  2239. <code>auth</code></br>
  2240. <em>
  2241. <a href="#external-secrets.io/v1beta1.DopplerAuth">
  2242. DopplerAuth
  2243. </a>
  2244. </em>
  2245. </td>
  2246. <td>
  2247. <p>Auth configures how the Operator authenticates with the Doppler API</p>
  2248. </td>
  2249. </tr>
  2250. <tr>
  2251. <td>
  2252. <code>project</code></br>
  2253. <em>
  2254. string
  2255. </em>
  2256. </td>
  2257. <td>
  2258. <em>(Optional)</em>
  2259. <p>Doppler project (required if not using a Service Token)</p>
  2260. </td>
  2261. </tr>
  2262. <tr>
  2263. <td>
  2264. <code>config</code></br>
  2265. <em>
  2266. string
  2267. </em>
  2268. </td>
  2269. <td>
  2270. <em>(Optional)</em>
  2271. <p>Doppler config (required if not using a Service Token)</p>
  2272. </td>
  2273. </tr>
  2274. <tr>
  2275. <td>
  2276. <code>nameTransformer</code></br>
  2277. <em>
  2278. string
  2279. </em>
  2280. </td>
  2281. <td>
  2282. <em>(Optional)</em>
  2283. <p>Environment variable compatible name transforms that change secret names to a different format</p>
  2284. </td>
  2285. </tr>
  2286. <tr>
  2287. <td>
  2288. <code>format</code></br>
  2289. <em>
  2290. string
  2291. </em>
  2292. </td>
  2293. <td>
  2294. <em>(Optional)</em>
  2295. <p>Format enables the downloading of secrets as a file (string)</p>
  2296. </td>
  2297. </tr>
  2298. </tbody>
  2299. </table>
  2300. <h3 id="external-secrets.io/v1beta1.ExternalSecret">ExternalSecret
  2301. </h3>
  2302. <p>
  2303. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  2304. </p>
  2305. <table>
  2306. <thead>
  2307. <tr>
  2308. <th>Field</th>
  2309. <th>Description</th>
  2310. </tr>
  2311. </thead>
  2312. <tbody>
  2313. <tr>
  2314. <td>
  2315. <code>metadata</code></br>
  2316. <em>
  2317. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  2318. Kubernetes meta/v1.ObjectMeta
  2319. </a>
  2320. </em>
  2321. </td>
  2322. <td>
  2323. Refer to the Kubernetes API documentation for the fields of the
  2324. <code>metadata</code> field.
  2325. </td>
  2326. </tr>
  2327. <tr>
  2328. <td>
  2329. <code>spec</code></br>
  2330. <em>
  2331. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  2332. ExternalSecretSpec
  2333. </a>
  2334. </em>
  2335. </td>
  2336. <td>
  2337. <br/>
  2338. <br/>
  2339. <table>
  2340. <tr>
  2341. <td>
  2342. <code>secretStoreRef</code></br>
  2343. <em>
  2344. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  2345. SecretStoreRef
  2346. </a>
  2347. </em>
  2348. </td>
  2349. <td>
  2350. <em>(Optional)</em>
  2351. </td>
  2352. </tr>
  2353. <tr>
  2354. <td>
  2355. <code>target</code></br>
  2356. <em>
  2357. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  2358. ExternalSecretTarget
  2359. </a>
  2360. </em>
  2361. </td>
  2362. <td>
  2363. <em>(Optional)</em>
  2364. </td>
  2365. </tr>
  2366. <tr>
  2367. <td>
  2368. <code>refreshInterval</code></br>
  2369. <em>
  2370. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  2371. Kubernetes meta/v1.Duration
  2372. </a>
  2373. </em>
  2374. </td>
  2375. <td>
  2376. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  2377. Valid time units are &ldquo;ns&rdquo;, &ldquo;us&rdquo; (or &ldquo;µs&rdquo;), &ldquo;ms&rdquo;, &ldquo;s&rdquo;, &ldquo;m&rdquo;, &ldquo;h&rdquo;
  2378. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  2379. </td>
  2380. </tr>
  2381. <tr>
  2382. <td>
  2383. <code>data</code></br>
  2384. <em>
  2385. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  2386. []ExternalSecretData
  2387. </a>
  2388. </em>
  2389. </td>
  2390. <td>
  2391. <em>(Optional)</em>
  2392. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  2393. </td>
  2394. </tr>
  2395. <tr>
  2396. <td>
  2397. <code>dataFrom</code></br>
  2398. <em>
  2399. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  2400. []ExternalSecretDataFromRemoteRef
  2401. </a>
  2402. </em>
  2403. </td>
  2404. <td>
  2405. <em>(Optional)</em>
  2406. <p>DataFrom is used to fetch all properties from a specific Provider data
  2407. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  2408. </td>
  2409. </tr>
  2410. </table>
  2411. </td>
  2412. </tr>
  2413. <tr>
  2414. <td>
  2415. <code>status</code></br>
  2416. <em>
  2417. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">
  2418. ExternalSecretStatus
  2419. </a>
  2420. </em>
  2421. </td>
  2422. <td>
  2423. </td>
  2424. </tr>
  2425. </tbody>
  2426. </table>
  2427. <h3 id="external-secrets.io/v1beta1.ExternalSecretConditionType">ExternalSecretConditionType
  2428. (<code>string</code> alias)</p></h3>
  2429. <p>
  2430. (<em>Appears on:</em>
  2431. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  2432. </p>
  2433. <p>
  2434. </p>
  2435. <table>
  2436. <thead>
  2437. <tr>
  2438. <th>Value</th>
  2439. <th>Description</th>
  2440. </tr>
  2441. </thead>
  2442. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
  2443. <td></td>
  2444. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  2445. <td></td>
  2446. </tr></tbody>
  2447. </table>
  2448. <h3 id="external-secrets.io/v1beta1.ExternalSecretConversionStrategy">ExternalSecretConversionStrategy
  2449. (<code>string</code> alias)</p></h3>
  2450. <p>
  2451. (<em>Appears on:</em>
  2452. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  2453. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  2454. </p>
  2455. <p>
  2456. </p>
  2457. <table>
  2458. <thead>
  2459. <tr>
  2460. <th>Value</th>
  2461. <th>Description</th>
  2462. </tr>
  2463. </thead>
  2464. <tbody><tr><td><p>&#34;Default&#34;</p></td>
  2465. <td></td>
  2466. </tr><tr><td><p>&#34;Unicode&#34;</p></td>
  2467. <td></td>
  2468. </tr></tbody>
  2469. </table>
  2470. <h3 id="external-secrets.io/v1beta1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  2471. (<code>string</code> alias)</p></h3>
  2472. <p>
  2473. (<em>Appears on:</em>
  2474. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  2475. </p>
  2476. <p>
  2477. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  2478. </p>
  2479. <table>
  2480. <thead>
  2481. <tr>
  2482. <th>Value</th>
  2483. <th>Description</th>
  2484. </tr>
  2485. </thead>
  2486. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  2487. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  2488. </td>
  2489. </tr><tr><td><p>&#34;None&#34;</p></td>
  2490. <td><p>None does not create a Secret (future use with injector).</p>
  2491. </td>
  2492. </tr><tr><td><p>&#34;Orphan&#34;</p></td>
  2493. <td><p>Orphan creates the Secret and does not set the ownerReference.
  2494. I.e. it will be orphaned after the deletion of the ExternalSecret.</p>
  2495. </td>
  2496. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  2497. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  2498. </td>
  2499. </tr></tbody>
  2500. </table>
  2501. <h3 id="external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData
  2502. </h3>
  2503. <p>
  2504. (<em>Appears on:</em>
  2505. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2506. </p>
  2507. <p>
  2508. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  2509. </p>
  2510. <table>
  2511. <thead>
  2512. <tr>
  2513. <th>Field</th>
  2514. <th>Description</th>
  2515. </tr>
  2516. </thead>
  2517. <tbody>
  2518. <tr>
  2519. <td>
  2520. <code>secretKey</code></br>
  2521. <em>
  2522. string
  2523. </em>
  2524. </td>
  2525. <td>
  2526. <p>SecretKey defines the key in which the controller stores
  2527. the value. This is the key in the Kind=Secret</p>
  2528. </td>
  2529. </tr>
  2530. <tr>
  2531. <td>
  2532. <code>remoteRef</code></br>
  2533. <em>
  2534. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  2535. ExternalSecretDataRemoteRef
  2536. </a>
  2537. </em>
  2538. </td>
  2539. <td>
  2540. <p>RemoteRef points to the remote secret and defines
  2541. which secret (version/property/..) to fetch.</p>
  2542. </td>
  2543. </tr>
  2544. <tr>
  2545. <td>
  2546. <code>sourceRef</code></br>
  2547. <em>
  2548. <a href="#external-secrets.io/v1beta1.SourceRef">
  2549. SourceRef
  2550. </a>
  2551. </em>
  2552. </td>
  2553. <td>
  2554. <p>SourceRef allows you to override the source
  2555. from which the value will pulled from.</p>
  2556. </td>
  2557. </tr>
  2558. </tbody>
  2559. </table>
  2560. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef
  2561. </h3>
  2562. <p>
  2563. (<em>Appears on:</em>
  2564. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2565. </p>
  2566. <p>
  2567. </p>
  2568. <table>
  2569. <thead>
  2570. <tr>
  2571. <th>Field</th>
  2572. <th>Description</th>
  2573. </tr>
  2574. </thead>
  2575. <tbody>
  2576. <tr>
  2577. <td>
  2578. <code>extract</code></br>
  2579. <em>
  2580. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  2581. ExternalSecretDataRemoteRef
  2582. </a>
  2583. </em>
  2584. </td>
  2585. <td>
  2586. <em>(Optional)</em>
  2587. <p>Used to extract multiple key/value pairs from one secret
  2588. Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
  2589. </td>
  2590. </tr>
  2591. <tr>
  2592. <td>
  2593. <code>find</code></br>
  2594. <em>
  2595. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">
  2596. ExternalSecretFind
  2597. </a>
  2598. </em>
  2599. </td>
  2600. <td>
  2601. <em>(Optional)</em>
  2602. <p>Used to find secrets based on tags or regular expressions
  2603. Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
  2604. </td>
  2605. </tr>
  2606. <tr>
  2607. <td>
  2608. <code>rewrite</code></br>
  2609. <em>
  2610. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">
  2611. []ExternalSecretRewrite
  2612. </a>
  2613. </em>
  2614. </td>
  2615. <td>
  2616. <em>(Optional)</em>
  2617. <p>Used to rewrite secret Keys after getting them from the secret Provider
  2618. Multiple Rewrite operations can be provided. They are applied in a layered order (first to last)</p>
  2619. </td>
  2620. </tr>
  2621. <tr>
  2622. <td>
  2623. <code>sourceRef</code></br>
  2624. <em>
  2625. <a href="#external-secrets.io/v1beta1.SourceRef">
  2626. SourceRef
  2627. </a>
  2628. </em>
  2629. </td>
  2630. <td>
  2631. <p>SourceRef points to a store or generator
  2632. which contains secret values ready to use.
  2633. Use this in combination with Extract or Find pull values out of
  2634. a specific SecretStore.
  2635. When sourceRef points to a generator Extract or Find is not supported.
  2636. The generator returns a static map of values</p>
  2637. </td>
  2638. </tr>
  2639. </tbody>
  2640. </table>
  2641. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  2642. </h3>
  2643. <p>
  2644. (<em>Appears on:</em>
  2645. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>,
  2646. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  2647. </p>
  2648. <p>
  2649. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  2650. </p>
  2651. <table>
  2652. <thead>
  2653. <tr>
  2654. <th>Field</th>
  2655. <th>Description</th>
  2656. </tr>
  2657. </thead>
  2658. <tbody>
  2659. <tr>
  2660. <td>
  2661. <code>key</code></br>
  2662. <em>
  2663. string
  2664. </em>
  2665. </td>
  2666. <td>
  2667. <p>Key is the key used in the Provider, mandatory</p>
  2668. </td>
  2669. </tr>
  2670. <tr>
  2671. <td>
  2672. <code>metadataPolicy</code></br>
  2673. <em>
  2674. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">
  2675. ExternalSecretMetadataPolicy
  2676. </a>
  2677. </em>
  2678. </td>
  2679. <td>
  2680. <em>(Optional)</em>
  2681. <p>Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None</p>
  2682. </td>
  2683. </tr>
  2684. <tr>
  2685. <td>
  2686. <code>property</code></br>
  2687. <em>
  2688. string
  2689. </em>
  2690. </td>
  2691. <td>
  2692. <em>(Optional)</em>
  2693. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  2694. </td>
  2695. </tr>
  2696. <tr>
  2697. <td>
  2698. <code>version</code></br>
  2699. <em>
  2700. string
  2701. </em>
  2702. </td>
  2703. <td>
  2704. <em>(Optional)</em>
  2705. <p>Used to select a specific version of the Provider value, if supported</p>
  2706. </td>
  2707. </tr>
  2708. <tr>
  2709. <td>
  2710. <code>conversionStrategy</code></br>
  2711. <em>
  2712. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  2713. ExternalSecretConversionStrategy
  2714. </a>
  2715. </em>
  2716. </td>
  2717. <td>
  2718. <em>(Optional)</em>
  2719. <p>Used to define a conversion Strategy</p>
  2720. </td>
  2721. </tr>
  2722. <tr>
  2723. <td>
  2724. <code>decodingStrategy</code></br>
  2725. <em>
  2726. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  2727. ExternalSecretDecodingStrategy
  2728. </a>
  2729. </em>
  2730. </td>
  2731. <td>
  2732. <em>(Optional)</em>
  2733. <p>Used to define a decoding Strategy</p>
  2734. </td>
  2735. </tr>
  2736. </tbody>
  2737. </table>
  2738. <h3 id="external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">ExternalSecretDecodingStrategy
  2739. (<code>string</code> alias)</p></h3>
  2740. <p>
  2741. (<em>Appears on:</em>
  2742. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  2743. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  2744. </p>
  2745. <p>
  2746. </p>
  2747. <table>
  2748. <thead>
  2749. <tr>
  2750. <th>Value</th>
  2751. <th>Description</th>
  2752. </tr>
  2753. </thead>
  2754. <tbody><tr><td><p>&#34;Auto&#34;</p></td>
  2755. <td></td>
  2756. </tr><tr><td><p>&#34;Base64&#34;</p></td>
  2757. <td></td>
  2758. </tr><tr><td><p>&#34;Base64URL&#34;</p></td>
  2759. <td></td>
  2760. </tr><tr><td><p>&#34;None&#34;</p></td>
  2761. <td></td>
  2762. </tr></tbody>
  2763. </table>
  2764. <h3 id="external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">ExternalSecretDeletionPolicy
  2765. (<code>string</code> alias)</p></h3>
  2766. <p>
  2767. (<em>Appears on:</em>
  2768. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  2769. </p>
  2770. <p>
  2771. <p>ExternalSecretDeletionPolicy defines rules on how to delete the resulting Secret.</p>
  2772. </p>
  2773. <table>
  2774. <thead>
  2775. <tr>
  2776. <th>Value</th>
  2777. <th>Description</th>
  2778. </tr>
  2779. </thead>
  2780. <tbody><tr><td><p>&#34;Delete&#34;</p></td>
  2781. <td><p>Delete deletes the secret if all provider secrets are deleted.
  2782. If a secret gets deleted on the provider side and is not accessible
  2783. anymore this is not considered an error and the ExternalSecret
  2784. does not go into SecretSyncedError status.</p>
  2785. </td>
  2786. </tr><tr><td><p>&#34;Merge&#34;</p></td>
  2787. <td><p>Merge removes keys in the secret, but not the secret itself.
  2788. If a secret gets deleted on the provider side and is not accessible
  2789. anymore this is not considered an error and the ExternalSecret
  2790. does not go into SecretSyncedError status.</p>
  2791. </td>
  2792. </tr><tr><td><p>&#34;Retain&#34;</p></td>
  2793. <td><p>Retain will retain the secret if all provider secrets have been deleted.
  2794. If a provider secret does not exist the ExternalSecret gets into the
  2795. SecretSyncedError status.</p>
  2796. </td>
  2797. </tr></tbody>
  2798. </table>
  2799. <h3 id="external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind
  2800. </h3>
  2801. <p>
  2802. (<em>Appears on:</em>
  2803. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  2804. </p>
  2805. <p>
  2806. </p>
  2807. <table>
  2808. <thead>
  2809. <tr>
  2810. <th>Field</th>
  2811. <th>Description</th>
  2812. </tr>
  2813. </thead>
  2814. <tbody>
  2815. <tr>
  2816. <td>
  2817. <code>path</code></br>
  2818. <em>
  2819. string
  2820. </em>
  2821. </td>
  2822. <td>
  2823. <em>(Optional)</em>
  2824. <p>A root path to start the find operations.</p>
  2825. </td>
  2826. </tr>
  2827. <tr>
  2828. <td>
  2829. <code>name</code></br>
  2830. <em>
  2831. <a href="#external-secrets.io/v1beta1.FindName">
  2832. FindName
  2833. </a>
  2834. </em>
  2835. </td>
  2836. <td>
  2837. <em>(Optional)</em>
  2838. <p>Finds secrets based on the name.</p>
  2839. </td>
  2840. </tr>
  2841. <tr>
  2842. <td>
  2843. <code>tags</code></br>
  2844. <em>
  2845. map[string]string
  2846. </em>
  2847. </td>
  2848. <td>
  2849. <em>(Optional)</em>
  2850. <p>Find secrets based on tags.</p>
  2851. </td>
  2852. </tr>
  2853. <tr>
  2854. <td>
  2855. <code>conversionStrategy</code></br>
  2856. <em>
  2857. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  2858. ExternalSecretConversionStrategy
  2859. </a>
  2860. </em>
  2861. </td>
  2862. <td>
  2863. <em>(Optional)</em>
  2864. <p>Used to define a conversion Strategy</p>
  2865. </td>
  2866. </tr>
  2867. <tr>
  2868. <td>
  2869. <code>decodingStrategy</code></br>
  2870. <em>
  2871. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  2872. ExternalSecretDecodingStrategy
  2873. </a>
  2874. </em>
  2875. </td>
  2876. <td>
  2877. <em>(Optional)</em>
  2878. <p>Used to define a decoding Strategy</p>
  2879. </td>
  2880. </tr>
  2881. </tbody>
  2882. </table>
  2883. <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">ExternalSecretMetadataPolicy
  2884. (<code>string</code> alias)</p></h3>
  2885. <p>
  2886. (<em>Appears on:</em>
  2887. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>)
  2888. </p>
  2889. <p>
  2890. </p>
  2891. <table>
  2892. <thead>
  2893. <tr>
  2894. <th>Value</th>
  2895. <th>Description</th>
  2896. </tr>
  2897. </thead>
  2898. <tbody><tr><td><p>&#34;Fetch&#34;</p></td>
  2899. <td></td>
  2900. </tr><tr><td><p>&#34;None&#34;</p></td>
  2901. <td></td>
  2902. </tr></tbody>
  2903. </table>
  2904. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite
  2905. </h3>
  2906. <p>
  2907. (<em>Appears on:</em>
  2908. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  2909. </p>
  2910. <p>
  2911. </p>
  2912. <table>
  2913. <thead>
  2914. <tr>
  2915. <th>Field</th>
  2916. <th>Description</th>
  2917. </tr>
  2918. </thead>
  2919. <tbody>
  2920. <tr>
  2921. <td>
  2922. <code>regexp</code></br>
  2923. <em>
  2924. <a href="#external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">
  2925. ExternalSecretRewriteRegexp
  2926. </a>
  2927. </em>
  2928. </td>
  2929. <td>
  2930. <em>(Optional)</em>
  2931. <p>Used to rewrite with regular expressions.
  2932. The resulting key will be the output of a regexp.ReplaceAll operation.</p>
  2933. </td>
  2934. </tr>
  2935. </tbody>
  2936. </table>
  2937. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">ExternalSecretRewriteRegexp
  2938. </h3>
  2939. <p>
  2940. (<em>Appears on:</em>
  2941. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
  2942. </p>
  2943. <p>
  2944. </p>
  2945. <table>
  2946. <thead>
  2947. <tr>
  2948. <th>Field</th>
  2949. <th>Description</th>
  2950. </tr>
  2951. </thead>
  2952. <tbody>
  2953. <tr>
  2954. <td>
  2955. <code>source</code></br>
  2956. <em>
  2957. string
  2958. </em>
  2959. </td>
  2960. <td>
  2961. <p>Used to define the regular expression of a re.Compiler.</p>
  2962. </td>
  2963. </tr>
  2964. <tr>
  2965. <td>
  2966. <code>target</code></br>
  2967. <em>
  2968. string
  2969. </em>
  2970. </td>
  2971. <td>
  2972. <p>Used to define the target pattern of a ReplaceAll operation.</p>
  2973. </td>
  2974. </tr>
  2975. </tbody>
  2976. </table>
  2977. <h3 id="external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec
  2978. </h3>
  2979. <p>
  2980. (<em>Appears on:</em>
  2981. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>,
  2982. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  2983. </p>
  2984. <p>
  2985. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  2986. </p>
  2987. <table>
  2988. <thead>
  2989. <tr>
  2990. <th>Field</th>
  2991. <th>Description</th>
  2992. </tr>
  2993. </thead>
  2994. <tbody>
  2995. <tr>
  2996. <td>
  2997. <code>secretStoreRef</code></br>
  2998. <em>
  2999. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  3000. SecretStoreRef
  3001. </a>
  3002. </em>
  3003. </td>
  3004. <td>
  3005. <em>(Optional)</em>
  3006. </td>
  3007. </tr>
  3008. <tr>
  3009. <td>
  3010. <code>target</code></br>
  3011. <em>
  3012. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  3013. ExternalSecretTarget
  3014. </a>
  3015. </em>
  3016. </td>
  3017. <td>
  3018. <em>(Optional)</em>
  3019. </td>
  3020. </tr>
  3021. <tr>
  3022. <td>
  3023. <code>refreshInterval</code></br>
  3024. <em>
  3025. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  3026. Kubernetes meta/v1.Duration
  3027. </a>
  3028. </em>
  3029. </td>
  3030. <td>
  3031. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  3032. Valid time units are &ldquo;ns&rdquo;, &ldquo;us&rdquo; (or &ldquo;µs&rdquo;), &ldquo;ms&rdquo;, &ldquo;s&rdquo;, &ldquo;m&rdquo;, &ldquo;h&rdquo;
  3033. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  3034. </td>
  3035. </tr>
  3036. <tr>
  3037. <td>
  3038. <code>data</code></br>
  3039. <em>
  3040. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  3041. []ExternalSecretData
  3042. </a>
  3043. </em>
  3044. </td>
  3045. <td>
  3046. <em>(Optional)</em>
  3047. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  3048. </td>
  3049. </tr>
  3050. <tr>
  3051. <td>
  3052. <code>dataFrom</code></br>
  3053. <em>
  3054. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  3055. []ExternalSecretDataFromRemoteRef
  3056. </a>
  3057. </em>
  3058. </td>
  3059. <td>
  3060. <em>(Optional)</em>
  3061. <p>DataFrom is used to fetch all properties from a specific Provider data
  3062. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  3063. </td>
  3064. </tr>
  3065. </tbody>
  3066. </table>
  3067. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus
  3068. </h3>
  3069. <p>
  3070. (<em>Appears on:</em>
  3071. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  3072. </p>
  3073. <p>
  3074. </p>
  3075. <table>
  3076. <thead>
  3077. <tr>
  3078. <th>Field</th>
  3079. <th>Description</th>
  3080. </tr>
  3081. </thead>
  3082. <tbody>
  3083. <tr>
  3084. <td>
  3085. <code>refreshTime</code></br>
  3086. <em>
  3087. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  3088. Kubernetes meta/v1.Time
  3089. </a>
  3090. </em>
  3091. </td>
  3092. <td>
  3093. <p>refreshTime is the time and date the external secret was fetched and
  3094. the target secret updated</p>
  3095. </td>
  3096. </tr>
  3097. <tr>
  3098. <td>
  3099. <code>syncedResourceVersion</code></br>
  3100. <em>
  3101. string
  3102. </em>
  3103. </td>
  3104. <td>
  3105. <p>SyncedResourceVersion keeps track of the last synced version</p>
  3106. </td>
  3107. </tr>
  3108. <tr>
  3109. <td>
  3110. <code>conditions</code></br>
  3111. <em>
  3112. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">
  3113. []ExternalSecretStatusCondition
  3114. </a>
  3115. </em>
  3116. </td>
  3117. <td>
  3118. <em>(Optional)</em>
  3119. </td>
  3120. </tr>
  3121. </tbody>
  3122. </table>
  3123. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  3124. </h3>
  3125. <p>
  3126. (<em>Appears on:</em>
  3127. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus</a>)
  3128. </p>
  3129. <p>
  3130. </p>
  3131. <table>
  3132. <thead>
  3133. <tr>
  3134. <th>Field</th>
  3135. <th>Description</th>
  3136. </tr>
  3137. </thead>
  3138. <tbody>
  3139. <tr>
  3140. <td>
  3141. <code>type</code></br>
  3142. <em>
  3143. <a href="#external-secrets.io/v1beta1.ExternalSecretConditionType">
  3144. ExternalSecretConditionType
  3145. </a>
  3146. </em>
  3147. </td>
  3148. <td>
  3149. </td>
  3150. </tr>
  3151. <tr>
  3152. <td>
  3153. <code>status</code></br>
  3154. <em>
  3155. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  3156. Kubernetes core/v1.ConditionStatus
  3157. </a>
  3158. </em>
  3159. </td>
  3160. <td>
  3161. </td>
  3162. </tr>
  3163. <tr>
  3164. <td>
  3165. <code>reason</code></br>
  3166. <em>
  3167. string
  3168. </em>
  3169. </td>
  3170. <td>
  3171. <em>(Optional)</em>
  3172. </td>
  3173. </tr>
  3174. <tr>
  3175. <td>
  3176. <code>message</code></br>
  3177. <em>
  3178. string
  3179. </em>
  3180. </td>
  3181. <td>
  3182. <em>(Optional)</em>
  3183. </td>
  3184. </tr>
  3185. <tr>
  3186. <td>
  3187. <code>lastTransitionTime</code></br>
  3188. <em>
  3189. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  3190. Kubernetes meta/v1.Time
  3191. </a>
  3192. </em>
  3193. </td>
  3194. <td>
  3195. <em>(Optional)</em>
  3196. </td>
  3197. </tr>
  3198. </tbody>
  3199. </table>
  3200. <h3 id="external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget
  3201. </h3>
  3202. <p>
  3203. (<em>Appears on:</em>
  3204. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  3205. </p>
  3206. <p>
  3207. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  3208. There can be only one target per ExternalSecret.</p>
  3209. </p>
  3210. <table>
  3211. <thead>
  3212. <tr>
  3213. <th>Field</th>
  3214. <th>Description</th>
  3215. </tr>
  3216. </thead>
  3217. <tbody>
  3218. <tr>
  3219. <td>
  3220. <code>name</code></br>
  3221. <em>
  3222. string
  3223. </em>
  3224. </td>
  3225. <td>
  3226. <em>(Optional)</em>
  3227. <p>Name defines the name of the Secret resource to be managed
  3228. This field is immutable
  3229. Defaults to the .metadata.name of the ExternalSecret resource</p>
  3230. </td>
  3231. </tr>
  3232. <tr>
  3233. <td>
  3234. <code>creationPolicy</code></br>
  3235. <em>
  3236. <a href="#external-secrets.io/v1beta1.ExternalSecretCreationPolicy">
  3237. ExternalSecretCreationPolicy
  3238. </a>
  3239. </em>
  3240. </td>
  3241. <td>
  3242. <em>(Optional)</em>
  3243. <p>CreationPolicy defines rules on how to create the resulting Secret
  3244. Defaults to &lsquo;Owner&rsquo;</p>
  3245. </td>
  3246. </tr>
  3247. <tr>
  3248. <td>
  3249. <code>deletionPolicy</code></br>
  3250. <em>
  3251. <a href="#external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">
  3252. ExternalSecretDeletionPolicy
  3253. </a>
  3254. </em>
  3255. </td>
  3256. <td>
  3257. <em>(Optional)</em>
  3258. <p>DeletionPolicy defines rules on how to delete the resulting Secret
  3259. Defaults to &lsquo;Retain&rsquo;</p>
  3260. </td>
  3261. </tr>
  3262. <tr>
  3263. <td>
  3264. <code>template</code></br>
  3265. <em>
  3266. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">
  3267. ExternalSecretTemplate
  3268. </a>
  3269. </em>
  3270. </td>
  3271. <td>
  3272. <em>(Optional)</em>
  3273. <p>Template defines a blueprint for the created Secret resource.</p>
  3274. </td>
  3275. </tr>
  3276. <tr>
  3277. <td>
  3278. <code>immutable</code></br>
  3279. <em>
  3280. bool
  3281. </em>
  3282. </td>
  3283. <td>
  3284. <em>(Optional)</em>
  3285. <p>Immutable defines if the final secret will be immutable</p>
  3286. </td>
  3287. </tr>
  3288. </tbody>
  3289. </table>
  3290. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate
  3291. </h3>
  3292. <p>
  3293. (<em>Appears on:</em>
  3294. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  3295. </p>
  3296. <p>
  3297. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  3298. 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>
  3299. </p>
  3300. <table>
  3301. <thead>
  3302. <tr>
  3303. <th>Field</th>
  3304. <th>Description</th>
  3305. </tr>
  3306. </thead>
  3307. <tbody>
  3308. <tr>
  3309. <td>
  3310. <code>type</code></br>
  3311. <em>
  3312. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secrettype-v1-core">
  3313. Kubernetes core/v1.SecretType
  3314. </a>
  3315. </em>
  3316. </td>
  3317. <td>
  3318. <em>(Optional)</em>
  3319. </td>
  3320. </tr>
  3321. <tr>
  3322. <td>
  3323. <code>engineVersion</code></br>
  3324. <em>
  3325. <a href="#external-secrets.io/v1beta1.TemplateEngineVersion">
  3326. TemplateEngineVersion
  3327. </a>
  3328. </em>
  3329. </td>
  3330. <td>
  3331. </td>
  3332. </tr>
  3333. <tr>
  3334. <td>
  3335. <code>metadata</code></br>
  3336. <em>
  3337. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">
  3338. ExternalSecretTemplateMetadata
  3339. </a>
  3340. </em>
  3341. </td>
  3342. <td>
  3343. <em>(Optional)</em>
  3344. </td>
  3345. </tr>
  3346. <tr>
  3347. <td>
  3348. <code>data</code></br>
  3349. <em>
  3350. map[string]string
  3351. </em>
  3352. </td>
  3353. <td>
  3354. <em>(Optional)</em>
  3355. </td>
  3356. </tr>
  3357. <tr>
  3358. <td>
  3359. <code>templateFrom</code></br>
  3360. <em>
  3361. <a href="#external-secrets.io/v1beta1.TemplateFrom">
  3362. []TemplateFrom
  3363. </a>
  3364. </em>
  3365. </td>
  3366. <td>
  3367. <em>(Optional)</em>
  3368. </td>
  3369. </tr>
  3370. </tbody>
  3371. </table>
  3372. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  3373. </h3>
  3374. <p>
  3375. (<em>Appears on:</em>
  3376. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  3377. </p>
  3378. <p>
  3379. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  3380. </p>
  3381. <table>
  3382. <thead>
  3383. <tr>
  3384. <th>Field</th>
  3385. <th>Description</th>
  3386. </tr>
  3387. </thead>
  3388. <tbody>
  3389. <tr>
  3390. <td>
  3391. <code>annotations</code></br>
  3392. <em>
  3393. map[string]string
  3394. </em>
  3395. </td>
  3396. <td>
  3397. <em>(Optional)</em>
  3398. </td>
  3399. </tr>
  3400. <tr>
  3401. <td>
  3402. <code>labels</code></br>
  3403. <em>
  3404. map[string]string
  3405. </em>
  3406. </td>
  3407. <td>
  3408. <em>(Optional)</em>
  3409. </td>
  3410. </tr>
  3411. </tbody>
  3412. </table>
  3413. <h3 id="external-secrets.io/v1beta1.ExternalSecretValidator">ExternalSecretValidator
  3414. </h3>
  3415. <p>
  3416. </p>
  3417. <h3 id="external-secrets.io/v1beta1.FakeProvider">FakeProvider
  3418. </h3>
  3419. <p>
  3420. (<em>Appears on:</em>
  3421. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3422. </p>
  3423. <p>
  3424. <p>FakeProvider configures a fake provider that returns static values.</p>
  3425. </p>
  3426. <table>
  3427. <thead>
  3428. <tr>
  3429. <th>Field</th>
  3430. <th>Description</th>
  3431. </tr>
  3432. </thead>
  3433. <tbody>
  3434. <tr>
  3435. <td>
  3436. <code>data</code></br>
  3437. <em>
  3438. <a href="#external-secrets.io/v1beta1.FakeProviderData">
  3439. []FakeProviderData
  3440. </a>
  3441. </em>
  3442. </td>
  3443. <td>
  3444. </td>
  3445. </tr>
  3446. </tbody>
  3447. </table>
  3448. <h3 id="external-secrets.io/v1beta1.FakeProviderData">FakeProviderData
  3449. </h3>
  3450. <p>
  3451. (<em>Appears on:</em>
  3452. <a href="#external-secrets.io/v1beta1.FakeProvider">FakeProvider</a>)
  3453. </p>
  3454. <p>
  3455. </p>
  3456. <table>
  3457. <thead>
  3458. <tr>
  3459. <th>Field</th>
  3460. <th>Description</th>
  3461. </tr>
  3462. </thead>
  3463. <tbody>
  3464. <tr>
  3465. <td>
  3466. <code>key</code></br>
  3467. <em>
  3468. string
  3469. </em>
  3470. </td>
  3471. <td>
  3472. </td>
  3473. </tr>
  3474. <tr>
  3475. <td>
  3476. <code>value</code></br>
  3477. <em>
  3478. string
  3479. </em>
  3480. </td>
  3481. <td>
  3482. </td>
  3483. </tr>
  3484. <tr>
  3485. <td>
  3486. <code>valueMap</code></br>
  3487. <em>
  3488. map[string]string
  3489. </em>
  3490. </td>
  3491. <td>
  3492. </td>
  3493. </tr>
  3494. <tr>
  3495. <td>
  3496. <code>version</code></br>
  3497. <em>
  3498. string
  3499. </em>
  3500. </td>
  3501. <td>
  3502. </td>
  3503. </tr>
  3504. </tbody>
  3505. </table>
  3506. <h3 id="external-secrets.io/v1beta1.FindName">FindName
  3507. </h3>
  3508. <p>
  3509. (<em>Appears on:</em>
  3510. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  3511. </p>
  3512. <p>
  3513. </p>
  3514. <table>
  3515. <thead>
  3516. <tr>
  3517. <th>Field</th>
  3518. <th>Description</th>
  3519. </tr>
  3520. </thead>
  3521. <tbody>
  3522. <tr>
  3523. <td>
  3524. <code>regexp</code></br>
  3525. <em>
  3526. string
  3527. </em>
  3528. </td>
  3529. <td>
  3530. <em>(Optional)</em>
  3531. <p>Finds secrets base</p>
  3532. </td>
  3533. </tr>
  3534. </tbody>
  3535. </table>
  3536. <h3 id="external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth
  3537. </h3>
  3538. <p>
  3539. (<em>Appears on:</em>
  3540. <a href="#external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider</a>)
  3541. </p>
  3542. <p>
  3543. </p>
  3544. <table>
  3545. <thead>
  3546. <tr>
  3547. <th>Field</th>
  3548. <th>Description</th>
  3549. </tr>
  3550. </thead>
  3551. <tbody>
  3552. <tr>
  3553. <td>
  3554. <code>secretRef</code></br>
  3555. <em>
  3556. <a href="#external-secrets.io/v1beta1.GCPSMAuthSecretRef">
  3557. GCPSMAuthSecretRef
  3558. </a>
  3559. </em>
  3560. </td>
  3561. <td>
  3562. <em>(Optional)</em>
  3563. </td>
  3564. </tr>
  3565. <tr>
  3566. <td>
  3567. <code>workloadIdentity</code></br>
  3568. <em>
  3569. <a href="#external-secrets.io/v1beta1.GCPWorkloadIdentity">
  3570. GCPWorkloadIdentity
  3571. </a>
  3572. </em>
  3573. </td>
  3574. <td>
  3575. <em>(Optional)</em>
  3576. </td>
  3577. </tr>
  3578. </tbody>
  3579. </table>
  3580. <h3 id="external-secrets.io/v1beta1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  3581. </h3>
  3582. <p>
  3583. (<em>Appears on:</em>
  3584. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  3585. </p>
  3586. <p>
  3587. </p>
  3588. <table>
  3589. <thead>
  3590. <tr>
  3591. <th>Field</th>
  3592. <th>Description</th>
  3593. </tr>
  3594. </thead>
  3595. <tbody>
  3596. <tr>
  3597. <td>
  3598. <code>secretAccessKeySecretRef</code></br>
  3599. <em>
  3600. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3601. External Secrets meta/v1.SecretKeySelector
  3602. </a>
  3603. </em>
  3604. </td>
  3605. <td>
  3606. <em>(Optional)</em>
  3607. <p>The SecretAccessKey is used for authentication</p>
  3608. </td>
  3609. </tr>
  3610. </tbody>
  3611. </table>
  3612. <h3 id="external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider
  3613. </h3>
  3614. <p>
  3615. (<em>Appears on:</em>
  3616. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3617. </p>
  3618. <p>
  3619. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  3620. </p>
  3621. <table>
  3622. <thead>
  3623. <tr>
  3624. <th>Field</th>
  3625. <th>Description</th>
  3626. </tr>
  3627. </thead>
  3628. <tbody>
  3629. <tr>
  3630. <td>
  3631. <code>auth</code></br>
  3632. <em>
  3633. <a href="#external-secrets.io/v1beta1.GCPSMAuth">
  3634. GCPSMAuth
  3635. </a>
  3636. </em>
  3637. </td>
  3638. <td>
  3639. <em>(Optional)</em>
  3640. <p>Auth defines the information necessary to authenticate against GCP</p>
  3641. </td>
  3642. </tr>
  3643. <tr>
  3644. <td>
  3645. <code>projectID</code></br>
  3646. <em>
  3647. string
  3648. </em>
  3649. </td>
  3650. <td>
  3651. <p>ProjectID project where secret is located</p>
  3652. </td>
  3653. </tr>
  3654. </tbody>
  3655. </table>
  3656. <h3 id="external-secrets.io/v1beta1.GCPWorkloadIdentity">GCPWorkloadIdentity
  3657. </h3>
  3658. <p>
  3659. (<em>Appears on:</em>
  3660. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  3661. </p>
  3662. <p>
  3663. </p>
  3664. <table>
  3665. <thead>
  3666. <tr>
  3667. <th>Field</th>
  3668. <th>Description</th>
  3669. </tr>
  3670. </thead>
  3671. <tbody>
  3672. <tr>
  3673. <td>
  3674. <code>serviceAccountRef</code></br>
  3675. <em>
  3676. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  3677. External Secrets meta/v1.ServiceAccountSelector
  3678. </a>
  3679. </em>
  3680. </td>
  3681. <td>
  3682. </td>
  3683. </tr>
  3684. <tr>
  3685. <td>
  3686. <code>clusterLocation</code></br>
  3687. <em>
  3688. string
  3689. </em>
  3690. </td>
  3691. <td>
  3692. </td>
  3693. </tr>
  3694. <tr>
  3695. <td>
  3696. <code>clusterName</code></br>
  3697. <em>
  3698. string
  3699. </em>
  3700. </td>
  3701. <td>
  3702. </td>
  3703. </tr>
  3704. <tr>
  3705. <td>
  3706. <code>clusterProjectID</code></br>
  3707. <em>
  3708. string
  3709. </em>
  3710. </td>
  3711. <td>
  3712. </td>
  3713. </tr>
  3714. </tbody>
  3715. </table>
  3716. <h3 id="external-secrets.io/v1beta1.GeneratorRef">GeneratorRef
  3717. </h3>
  3718. <p>
  3719. (<em>Appears on:</em>
  3720. <a href="#external-secrets.io/v1beta1.SourceRef">SourceRef</a>)
  3721. </p>
  3722. <p>
  3723. <p>GeneratorRef points to a generator custom resource.</p>
  3724. </p>
  3725. <table>
  3726. <thead>
  3727. <tr>
  3728. <th>Field</th>
  3729. <th>Description</th>
  3730. </tr>
  3731. </thead>
  3732. <tbody>
  3733. <tr>
  3734. <td>
  3735. <code>apiVersion</code></br>
  3736. <em>
  3737. string
  3738. </em>
  3739. </td>
  3740. <td>
  3741. <p>Specify the apiVersion of the generator resource</p>
  3742. </td>
  3743. </tr>
  3744. <tr>
  3745. <td>
  3746. <code>kind</code></br>
  3747. <em>
  3748. string
  3749. </em>
  3750. </td>
  3751. <td>
  3752. <p>Specify the Kind of the resource, e.g. Password, ACRAccessToken etc.</p>
  3753. </td>
  3754. </tr>
  3755. <tr>
  3756. <td>
  3757. <code>name</code></br>
  3758. <em>
  3759. string
  3760. </em>
  3761. </td>
  3762. <td>
  3763. <p>Specify the name of the generator resource</p>
  3764. </td>
  3765. </tr>
  3766. </tbody>
  3767. </table>
  3768. <h3 id="external-secrets.io/v1beta1.GenericStore">GenericStore
  3769. </h3>
  3770. <p>
  3771. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  3772. or a namespaced SecretStore.</p>
  3773. </p>
  3774. <h3 id="external-secrets.io/v1beta1.GenericStoreValidator">GenericStoreValidator
  3775. </h3>
  3776. <p>
  3777. </p>
  3778. <h3 id="external-secrets.io/v1beta1.GitlabAuth">GitlabAuth
  3779. </h3>
  3780. <p>
  3781. (<em>Appears on:</em>
  3782. <a href="#external-secrets.io/v1beta1.GitlabProvider">GitlabProvider</a>)
  3783. </p>
  3784. <p>
  3785. </p>
  3786. <table>
  3787. <thead>
  3788. <tr>
  3789. <th>Field</th>
  3790. <th>Description</th>
  3791. </tr>
  3792. </thead>
  3793. <tbody>
  3794. <tr>
  3795. <td>
  3796. <code>SecretRef</code></br>
  3797. <em>
  3798. <a href="#external-secrets.io/v1beta1.GitlabSecretRef">
  3799. GitlabSecretRef
  3800. </a>
  3801. </em>
  3802. </td>
  3803. <td>
  3804. </td>
  3805. </tr>
  3806. </tbody>
  3807. </table>
  3808. <h3 id="external-secrets.io/v1beta1.GitlabProvider">GitlabProvider
  3809. </h3>
  3810. <p>
  3811. (<em>Appears on:</em>
  3812. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3813. </p>
  3814. <p>
  3815. <p>Configures a store to sync secrets with a GitLab instance.</p>
  3816. </p>
  3817. <table>
  3818. <thead>
  3819. <tr>
  3820. <th>Field</th>
  3821. <th>Description</th>
  3822. </tr>
  3823. </thead>
  3824. <tbody>
  3825. <tr>
  3826. <td>
  3827. <code>url</code></br>
  3828. <em>
  3829. string
  3830. </em>
  3831. </td>
  3832. <td>
  3833. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
  3834. </td>
  3835. </tr>
  3836. <tr>
  3837. <td>
  3838. <code>auth</code></br>
  3839. <em>
  3840. <a href="#external-secrets.io/v1beta1.GitlabAuth">
  3841. GitlabAuth
  3842. </a>
  3843. </em>
  3844. </td>
  3845. <td>
  3846. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
  3847. </td>
  3848. </tr>
  3849. <tr>
  3850. <td>
  3851. <code>projectID</code></br>
  3852. <em>
  3853. string
  3854. </em>
  3855. </td>
  3856. <td>
  3857. <p>ProjectID specifies a project where secrets are located.</p>
  3858. </td>
  3859. </tr>
  3860. <tr>
  3861. <td>
  3862. <code>inheritFromGroups</code></br>
  3863. <em>
  3864. bool
  3865. </em>
  3866. </td>
  3867. <td>
  3868. <p>InheritFromGroups specifies whether parent groups should be discovered and checked for secrets.</p>
  3869. </td>
  3870. </tr>
  3871. <tr>
  3872. <td>
  3873. <code>groupIDs</code></br>
  3874. <em>
  3875. []string
  3876. </em>
  3877. </td>
  3878. <td>
  3879. <p>GroupIDs specify, which gitlab groups to pull secrets from. Group secrets are read from left to right followed by the project variables.</p>
  3880. </td>
  3881. </tr>
  3882. <tr>
  3883. <td>
  3884. <code>environment</code></br>
  3885. <em>
  3886. string
  3887. </em>
  3888. </td>
  3889. <td>
  3890. <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>
  3891. </td>
  3892. </tr>
  3893. </tbody>
  3894. </table>
  3895. <h3 id="external-secrets.io/v1beta1.GitlabSecretRef">GitlabSecretRef
  3896. </h3>
  3897. <p>
  3898. (<em>Appears on:</em>
  3899. <a href="#external-secrets.io/v1beta1.GitlabAuth">GitlabAuth</a>)
  3900. </p>
  3901. <p>
  3902. </p>
  3903. <table>
  3904. <thead>
  3905. <tr>
  3906. <th>Field</th>
  3907. <th>Description</th>
  3908. </tr>
  3909. </thead>
  3910. <tbody>
  3911. <tr>
  3912. <td>
  3913. <code>accessToken</code></br>
  3914. <em>
  3915. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3916. External Secrets meta/v1.SecretKeySelector
  3917. </a>
  3918. </em>
  3919. </td>
  3920. <td>
  3921. <p>AccessToken is used for authentication.</p>
  3922. </td>
  3923. </tr>
  3924. </tbody>
  3925. </table>
  3926. <h3 id="external-secrets.io/v1beta1.IBMAuth">IBMAuth
  3927. </h3>
  3928. <p>
  3929. (<em>Appears on:</em>
  3930. <a href="#external-secrets.io/v1beta1.IBMProvider">IBMProvider</a>)
  3931. </p>
  3932. <p>
  3933. </p>
  3934. <table>
  3935. <thead>
  3936. <tr>
  3937. <th>Field</th>
  3938. <th>Description</th>
  3939. </tr>
  3940. </thead>
  3941. <tbody>
  3942. <tr>
  3943. <td>
  3944. <code>secretRef</code></br>
  3945. <em>
  3946. <a href="#external-secrets.io/v1beta1.IBMAuthSecretRef">
  3947. IBMAuthSecretRef
  3948. </a>
  3949. </em>
  3950. </td>
  3951. <td>
  3952. </td>
  3953. </tr>
  3954. <tr>
  3955. <td>
  3956. <code>containerAuth</code></br>
  3957. <em>
  3958. <a href="#external-secrets.io/v1beta1.IBMAuthContainerAuth">
  3959. IBMAuthContainerAuth
  3960. </a>
  3961. </em>
  3962. </td>
  3963. <td>
  3964. </td>
  3965. </tr>
  3966. </tbody>
  3967. </table>
  3968. <h3 id="external-secrets.io/v1beta1.IBMAuthContainerAuth">IBMAuthContainerAuth
  3969. </h3>
  3970. <p>
  3971. (<em>Appears on:</em>
  3972. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  3973. </p>
  3974. <p>
  3975. <p>IBM Container-based auth with IAM Trusted Profile.</p>
  3976. </p>
  3977. <table>
  3978. <thead>
  3979. <tr>
  3980. <th>Field</th>
  3981. <th>Description</th>
  3982. </tr>
  3983. </thead>
  3984. <tbody>
  3985. <tr>
  3986. <td>
  3987. <code>profile</code></br>
  3988. <em>
  3989. string
  3990. </em>
  3991. </td>
  3992. <td>
  3993. <p>the IBM Trusted Profile</p>
  3994. </td>
  3995. </tr>
  3996. <tr>
  3997. <td>
  3998. <code>tokenLocation</code></br>
  3999. <em>
  4000. string
  4001. </em>
  4002. </td>
  4003. <td>
  4004. <p>Location the token is mounted on the pod</p>
  4005. </td>
  4006. </tr>
  4007. <tr>
  4008. <td>
  4009. <code>iamEndpoint</code></br>
  4010. <em>
  4011. string
  4012. </em>
  4013. </td>
  4014. <td>
  4015. </td>
  4016. </tr>
  4017. </tbody>
  4018. </table>
  4019. <h3 id="external-secrets.io/v1beta1.IBMAuthSecretRef">IBMAuthSecretRef
  4020. </h3>
  4021. <p>
  4022. (<em>Appears on:</em>
  4023. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  4024. </p>
  4025. <p>
  4026. </p>
  4027. <table>
  4028. <thead>
  4029. <tr>
  4030. <th>Field</th>
  4031. <th>Description</th>
  4032. </tr>
  4033. </thead>
  4034. <tbody>
  4035. <tr>
  4036. <td>
  4037. <code>secretApiKeySecretRef</code></br>
  4038. <em>
  4039. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  4040. External Secrets meta/v1.SecretKeySelector
  4041. </a>
  4042. </em>
  4043. </td>
  4044. <td>
  4045. <p>The SecretAccessKey is used for authentication</p>
  4046. </td>
  4047. </tr>
  4048. </tbody>
  4049. </table>
  4050. <h3 id="external-secrets.io/v1beta1.IBMProvider">IBMProvider
  4051. </h3>
  4052. <p>
  4053. (<em>Appears on:</em>
  4054. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4055. </p>
  4056. <p>
  4057. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
  4058. backend.</p>
  4059. </p>
  4060. <table>
  4061. <thead>
  4062. <tr>
  4063. <th>Field</th>
  4064. <th>Description</th>
  4065. </tr>
  4066. </thead>
  4067. <tbody>
  4068. <tr>
  4069. <td>
  4070. <code>auth</code></br>
  4071. <em>
  4072. <a href="#external-secrets.io/v1beta1.IBMAuth">
  4073. IBMAuth
  4074. </a>
  4075. </em>
  4076. </td>
  4077. <td>
  4078. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
  4079. </td>
  4080. </tr>
  4081. <tr>
  4082. <td>
  4083. <code>serviceUrl</code></br>
  4084. <em>
  4085. string
  4086. </em>
  4087. </td>
  4088. <td>
  4089. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
  4090. </td>
  4091. </tr>
  4092. </tbody>
  4093. </table>
  4094. <h3 id="external-secrets.io/v1beta1.KeeperSecurityProvider">KeeperSecurityProvider
  4095. </h3>
  4096. <p>
  4097. (<em>Appears on:</em>
  4098. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4099. </p>
  4100. <p>
  4101. <p>KeeperSecurityProvider Configures a store to sync secrets using Keeper Security.</p>
  4102. </p>
  4103. <table>
  4104. <thead>
  4105. <tr>
  4106. <th>Field</th>
  4107. <th>Description</th>
  4108. </tr>
  4109. </thead>
  4110. <tbody>
  4111. <tr>
  4112. <td>
  4113. <code>authRef</code></br>
  4114. <em>
  4115. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  4116. External Secrets meta/v1.SecretKeySelector
  4117. </a>
  4118. </em>
  4119. </td>
  4120. <td>
  4121. </td>
  4122. </tr>
  4123. <tr>
  4124. <td>
  4125. <code>hostname</code></br>
  4126. <em>
  4127. string
  4128. </em>
  4129. </td>
  4130. <td>
  4131. </td>
  4132. </tr>
  4133. <tr>
  4134. <td>
  4135. <code>folderID</code></br>
  4136. <em>
  4137. string
  4138. </em>
  4139. </td>
  4140. <td>
  4141. </td>
  4142. </tr>
  4143. </tbody>
  4144. </table>
  4145. <h3 id="external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth
  4146. </h3>
  4147. <p>
  4148. (<em>Appears on:</em>
  4149. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  4150. </p>
  4151. <p>
  4152. </p>
  4153. <table>
  4154. <thead>
  4155. <tr>
  4156. <th>Field</th>
  4157. <th>Description</th>
  4158. </tr>
  4159. </thead>
  4160. <tbody>
  4161. <tr>
  4162. <td>
  4163. <code>cert</code></br>
  4164. <em>
  4165. <a href="#external-secrets.io/v1beta1.CertAuth">
  4166. CertAuth
  4167. </a>
  4168. </em>
  4169. </td>
  4170. <td>
  4171. <em>(Optional)</em>
  4172. <p>has both clientCert and clientKey as secretKeySelector</p>
  4173. </td>
  4174. </tr>
  4175. <tr>
  4176. <td>
  4177. <code>token</code></br>
  4178. <em>
  4179. <a href="#external-secrets.io/v1beta1.TokenAuth">
  4180. TokenAuth
  4181. </a>
  4182. </em>
  4183. </td>
  4184. <td>
  4185. <em>(Optional)</em>
  4186. <p>use static token to authenticate with</p>
  4187. </td>
  4188. </tr>
  4189. <tr>
  4190. <td>
  4191. <code>serviceAccount</code></br>
  4192. <em>
  4193. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  4194. External Secrets meta/v1.ServiceAccountSelector
  4195. </a>
  4196. </em>
  4197. </td>
  4198. <td>
  4199. <em>(Optional)</em>
  4200. <p>points to a service account that should be used for authentication</p>
  4201. </td>
  4202. </tr>
  4203. </tbody>
  4204. </table>
  4205. <h3 id="external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider
  4206. </h3>
  4207. <p>
  4208. (<em>Appears on:</em>
  4209. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4210. </p>
  4211. <p>
  4212. <p>Configures a store to sync secrets with a Kubernetes instance.</p>
  4213. </p>
  4214. <table>
  4215. <thead>
  4216. <tr>
  4217. <th>Field</th>
  4218. <th>Description</th>
  4219. </tr>
  4220. </thead>
  4221. <tbody>
  4222. <tr>
  4223. <td>
  4224. <code>server</code></br>
  4225. <em>
  4226. <a href="#external-secrets.io/v1beta1.KubernetesServer">
  4227. KubernetesServer
  4228. </a>
  4229. </em>
  4230. </td>
  4231. <td>
  4232. <p>configures the Kubernetes server Address.</p>
  4233. </td>
  4234. </tr>
  4235. <tr>
  4236. <td>
  4237. <code>auth</code></br>
  4238. <em>
  4239. <a href="#external-secrets.io/v1beta1.KubernetesAuth">
  4240. KubernetesAuth
  4241. </a>
  4242. </em>
  4243. </td>
  4244. <td>
  4245. <p>Auth configures how secret-manager authenticates with a Kubernetes instance.</p>
  4246. </td>
  4247. </tr>
  4248. <tr>
  4249. <td>
  4250. <code>remoteNamespace</code></br>
  4251. <em>
  4252. string
  4253. </em>
  4254. </td>
  4255. <td>
  4256. <em>(Optional)</em>
  4257. <p>Remote namespace to fetch the secrets from</p>
  4258. </td>
  4259. </tr>
  4260. </tbody>
  4261. </table>
  4262. <h3 id="external-secrets.io/v1beta1.KubernetesServer">KubernetesServer
  4263. </h3>
  4264. <p>
  4265. (<em>Appears on:</em>
  4266. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  4267. </p>
  4268. <p>
  4269. </p>
  4270. <table>
  4271. <thead>
  4272. <tr>
  4273. <th>Field</th>
  4274. <th>Description</th>
  4275. </tr>
  4276. </thead>
  4277. <tbody>
  4278. <tr>
  4279. <td>
  4280. <code>url</code></br>
  4281. <em>
  4282. string
  4283. </em>
  4284. </td>
  4285. <td>
  4286. <em>(Optional)</em>
  4287. <p>configures the Kubernetes server Address.</p>
  4288. </td>
  4289. </tr>
  4290. <tr>
  4291. <td>
  4292. <code>caBundle</code></br>
  4293. <em>
  4294. []byte
  4295. </em>
  4296. </td>
  4297. <td>
  4298. <em>(Optional)</em>
  4299. <p>CABundle is a base64-encoded CA certificate</p>
  4300. </td>
  4301. </tr>
  4302. <tr>
  4303. <td>
  4304. <code>caProvider</code></br>
  4305. <em>
  4306. <a href="#external-secrets.io/v1beta1.CAProvider">
  4307. CAProvider
  4308. </a>
  4309. </em>
  4310. </td>
  4311. <td>
  4312. <em>(Optional)</em>
  4313. <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>
  4314. </td>
  4315. </tr>
  4316. </tbody>
  4317. </table>
  4318. <h3 id="external-secrets.io/v1beta1.NoSecretError">NoSecretError
  4319. </h3>
  4320. <p>
  4321. <p>NoSecretError shall be returned when a GetSecret can not find the
  4322. desired secret. This is used for deletionPolicy.</p>
  4323. </p>
  4324. <h3 id="external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth
  4325. </h3>
  4326. <p>
  4327. (<em>Appears on:</em>
  4328. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider</a>)
  4329. </p>
  4330. <p>
  4331. <p>OnePasswordAuth contains a secretRef for credentials.</p>
  4332. </p>
  4333. <table>
  4334. <thead>
  4335. <tr>
  4336. <th>Field</th>
  4337. <th>Description</th>
  4338. </tr>
  4339. </thead>
  4340. <tbody>
  4341. <tr>
  4342. <td>
  4343. <code>secretRef</code></br>
  4344. <em>
  4345. <a href="#external-secrets.io/v1beta1.OnePasswordAuthSecretRef">
  4346. OnePasswordAuthSecretRef
  4347. </a>
  4348. </em>
  4349. </td>
  4350. <td>
  4351. </td>
  4352. </tr>
  4353. </tbody>
  4354. </table>
  4355. <h3 id="external-secrets.io/v1beta1.OnePasswordAuthSecretRef">OnePasswordAuthSecretRef
  4356. </h3>
  4357. <p>
  4358. (<em>Appears on:</em>
  4359. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth</a>)
  4360. </p>
  4361. <p>
  4362. <p>OnePasswordAuthSecretRef holds secret references for 1Password credentials.</p>
  4363. </p>
  4364. <table>
  4365. <thead>
  4366. <tr>
  4367. <th>Field</th>
  4368. <th>Description</th>
  4369. </tr>
  4370. </thead>
  4371. <tbody>
  4372. <tr>
  4373. <td>
  4374. <code>connectTokenSecretRef</code></br>
  4375. <em>
  4376. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  4377. External Secrets meta/v1.SecretKeySelector
  4378. </a>
  4379. </em>
  4380. </td>
  4381. <td>
  4382. <p>The ConnectToken is used for authentication to a 1Password Connect Server.</p>
  4383. </td>
  4384. </tr>
  4385. </tbody>
  4386. </table>
  4387. <h3 id="external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider
  4388. </h3>
  4389. <p>
  4390. (<em>Appears on:</em>
  4391. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4392. </p>
  4393. <p>
  4394. <p>OnePasswordProvider configures a store to sync secrets using the 1Password Secret Manager provider.</p>
  4395. </p>
  4396. <table>
  4397. <thead>
  4398. <tr>
  4399. <th>Field</th>
  4400. <th>Description</th>
  4401. </tr>
  4402. </thead>
  4403. <tbody>
  4404. <tr>
  4405. <td>
  4406. <code>auth</code></br>
  4407. <em>
  4408. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">
  4409. OnePasswordAuth
  4410. </a>
  4411. </em>
  4412. </td>
  4413. <td>
  4414. <p>Auth defines the information necessary to authenticate against OnePassword Connect Server</p>
  4415. </td>
  4416. </tr>
  4417. <tr>
  4418. <td>
  4419. <code>connectHost</code></br>
  4420. <em>
  4421. string
  4422. </em>
  4423. </td>
  4424. <td>
  4425. <p>ConnectHost defines the OnePassword Connect Server to connect to</p>
  4426. </td>
  4427. </tr>
  4428. <tr>
  4429. <td>
  4430. <code>vaults</code></br>
  4431. <em>
  4432. map[string]int
  4433. </em>
  4434. </td>
  4435. <td>
  4436. <p>Vaults defines which OnePassword vaults to search in which order</p>
  4437. </td>
  4438. </tr>
  4439. </tbody>
  4440. </table>
  4441. <h3 id="external-secrets.io/v1beta1.OracleAuth">OracleAuth
  4442. </h3>
  4443. <p>
  4444. (<em>Appears on:</em>
  4445. <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
  4446. </p>
  4447. <p>
  4448. </p>
  4449. <table>
  4450. <thead>
  4451. <tr>
  4452. <th>Field</th>
  4453. <th>Description</th>
  4454. </tr>
  4455. </thead>
  4456. <tbody>
  4457. <tr>
  4458. <td>
  4459. <code>tenancy</code></br>
  4460. <em>
  4461. string
  4462. </em>
  4463. </td>
  4464. <td>
  4465. <p>Tenancy is the tenancy OCID where user is located.</p>
  4466. </td>
  4467. </tr>
  4468. <tr>
  4469. <td>
  4470. <code>user</code></br>
  4471. <em>
  4472. string
  4473. </em>
  4474. </td>
  4475. <td>
  4476. <p>User is an access OCID specific to the account.</p>
  4477. </td>
  4478. </tr>
  4479. <tr>
  4480. <td>
  4481. <code>secretRef</code></br>
  4482. <em>
  4483. <a href="#external-secrets.io/v1beta1.OracleSecretRef">
  4484. OracleSecretRef
  4485. </a>
  4486. </em>
  4487. </td>
  4488. <td>
  4489. <p>SecretRef to pass through sensitive information.</p>
  4490. </td>
  4491. </tr>
  4492. </tbody>
  4493. </table>
  4494. <h3 id="external-secrets.io/v1beta1.OracleProvider">OracleProvider
  4495. </h3>
  4496. <p>
  4497. (<em>Appears on:</em>
  4498. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4499. </p>
  4500. <p>
  4501. <p>Configures an store to sync secrets using a Oracle Vault
  4502. backend.</p>
  4503. </p>
  4504. <table>
  4505. <thead>
  4506. <tr>
  4507. <th>Field</th>
  4508. <th>Description</th>
  4509. </tr>
  4510. </thead>
  4511. <tbody>
  4512. <tr>
  4513. <td>
  4514. <code>region</code></br>
  4515. <em>
  4516. string
  4517. </em>
  4518. </td>
  4519. <td>
  4520. <p>Region is the region where vault is located.</p>
  4521. </td>
  4522. </tr>
  4523. <tr>
  4524. <td>
  4525. <code>vault</code></br>
  4526. <em>
  4527. string
  4528. </em>
  4529. </td>
  4530. <td>
  4531. <p>Vault is the vault&rsquo;s OCID of the specific vault where secret is located.</p>
  4532. </td>
  4533. </tr>
  4534. <tr>
  4535. <td>
  4536. <code>auth</code></br>
  4537. <em>
  4538. <a href="#external-secrets.io/v1beta1.OracleAuth">
  4539. OracleAuth
  4540. </a>
  4541. </em>
  4542. </td>
  4543. <td>
  4544. <em>(Optional)</em>
  4545. <p>Auth configures how secret-manager authenticates with the Oracle Vault.
  4546. If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
  4547. </td>
  4548. </tr>
  4549. </tbody>
  4550. </table>
  4551. <h3 id="external-secrets.io/v1beta1.OracleSecretRef">OracleSecretRef
  4552. </h3>
  4553. <p>
  4554. (<em>Appears on:</em>
  4555. <a href="#external-secrets.io/v1beta1.OracleAuth">OracleAuth</a>)
  4556. </p>
  4557. <p>
  4558. </p>
  4559. <table>
  4560. <thead>
  4561. <tr>
  4562. <th>Field</th>
  4563. <th>Description</th>
  4564. </tr>
  4565. </thead>
  4566. <tbody>
  4567. <tr>
  4568. <td>
  4569. <code>privatekey</code></br>
  4570. <em>
  4571. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  4572. External Secrets meta/v1.SecretKeySelector
  4573. </a>
  4574. </em>
  4575. </td>
  4576. <td>
  4577. <p>PrivateKey is the user&rsquo;s API Signing Key in PEM format, used for authentication.</p>
  4578. </td>
  4579. </tr>
  4580. <tr>
  4581. <td>
  4582. <code>fingerprint</code></br>
  4583. <em>
  4584. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  4585. External Secrets meta/v1.SecretKeySelector
  4586. </a>
  4587. </em>
  4588. </td>
  4589. <td>
  4590. <p>Fingerprint is the fingerprint of the API private key.</p>
  4591. </td>
  4592. </tr>
  4593. </tbody>
  4594. </table>
  4595. <h3 id="external-secrets.io/v1beta1.Provider">Provider
  4596. </h3>
  4597. <p>
  4598. <p>Provider is a common interface for interacting with secret backends.</p>
  4599. </p>
  4600. <h3 id="external-secrets.io/v1beta1.PushRemoteRef">PushRemoteRef
  4601. </h3>
  4602. <p>
  4603. <p>This interface is to allow using v1alpha1 content in Provider registered in v1beta1.</p>
  4604. </p>
  4605. <h3 id="external-secrets.io/v1beta1.SecretStore">SecretStore
  4606. </h3>
  4607. <p>
  4608. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  4609. </p>
  4610. <table>
  4611. <thead>
  4612. <tr>
  4613. <th>Field</th>
  4614. <th>Description</th>
  4615. </tr>
  4616. </thead>
  4617. <tbody>
  4618. <tr>
  4619. <td>
  4620. <code>metadata</code></br>
  4621. <em>
  4622. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  4623. Kubernetes meta/v1.ObjectMeta
  4624. </a>
  4625. </em>
  4626. </td>
  4627. <td>
  4628. Refer to the Kubernetes API documentation for the fields of the
  4629. <code>metadata</code> field.
  4630. </td>
  4631. </tr>
  4632. <tr>
  4633. <td>
  4634. <code>spec</code></br>
  4635. <em>
  4636. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  4637. SecretStoreSpec
  4638. </a>
  4639. </em>
  4640. </td>
  4641. <td>
  4642. <br/>
  4643. <br/>
  4644. <table>
  4645. <tr>
  4646. <td>
  4647. <code>controller</code></br>
  4648. <em>
  4649. string
  4650. </em>
  4651. </td>
  4652. <td>
  4653. <em>(Optional)</em>
  4654. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  4655. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  4656. </td>
  4657. </tr>
  4658. <tr>
  4659. <td>
  4660. <code>provider</code></br>
  4661. <em>
  4662. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  4663. SecretStoreProvider
  4664. </a>
  4665. </em>
  4666. </td>
  4667. <td>
  4668. <p>Used to configure the provider. Only one provider may be set</p>
  4669. </td>
  4670. </tr>
  4671. <tr>
  4672. <td>
  4673. <code>retrySettings</code></br>
  4674. <em>
  4675. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  4676. SecretStoreRetrySettings
  4677. </a>
  4678. </em>
  4679. </td>
  4680. <td>
  4681. <em>(Optional)</em>
  4682. <p>Used to configure http retries if failed</p>
  4683. </td>
  4684. </tr>
  4685. <tr>
  4686. <td>
  4687. <code>refreshInterval</code></br>
  4688. <em>
  4689. int
  4690. </em>
  4691. </td>
  4692. <td>
  4693. <em>(Optional)</em>
  4694. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  4695. </td>
  4696. </tr>
  4697. <tr>
  4698. <td>
  4699. <code>conditions</code></br>
  4700. <em>
  4701. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  4702. []ClusterSecretStoreCondition
  4703. </a>
  4704. </em>
  4705. </td>
  4706. <td>
  4707. <em>(Optional)</em>
  4708. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  4709. </td>
  4710. </tr>
  4711. </table>
  4712. </td>
  4713. </tr>
  4714. <tr>
  4715. <td>
  4716. <code>status</code></br>
  4717. <em>
  4718. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  4719. SecretStoreStatus
  4720. </a>
  4721. </em>
  4722. </td>
  4723. <td>
  4724. </td>
  4725. </tr>
  4726. </tbody>
  4727. </table>
  4728. <h3 id="external-secrets.io/v1beta1.SecretStoreCapabilities">SecretStoreCapabilities
  4729. (<code>string</code> alias)</p></h3>
  4730. <p>
  4731. (<em>Appears on:</em>
  4732. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  4733. </p>
  4734. <p>
  4735. <p>SecretStoreCapabilities defines the possible operations a SecretStore can do.</p>
  4736. </p>
  4737. <table>
  4738. <thead>
  4739. <tr>
  4740. <th>Value</th>
  4741. <th>Description</th>
  4742. </tr>
  4743. </thead>
  4744. <tbody><tr><td><p>&#34;ReadOnly&#34;</p></td>
  4745. <td></td>
  4746. </tr><tr><td><p>&#34;ReadWrite&#34;</p></td>
  4747. <td></td>
  4748. </tr><tr><td><p>&#34;WriteOnly&#34;</p></td>
  4749. <td></td>
  4750. </tr></tbody>
  4751. </table>
  4752. <h3 id="external-secrets.io/v1beta1.SecretStoreConditionType">SecretStoreConditionType
  4753. (<code>string</code> alias)</p></h3>
  4754. <p>
  4755. (<em>Appears on:</em>
  4756. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  4757. </p>
  4758. <p>
  4759. </p>
  4760. <table>
  4761. <thead>
  4762. <tr>
  4763. <th>Value</th>
  4764. <th>Description</th>
  4765. </tr>
  4766. </thead>
  4767. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  4768. <td></td>
  4769. </tr></tbody>
  4770. </table>
  4771. <h3 id="external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider
  4772. </h3>
  4773. <p>
  4774. (<em>Appears on:</em>
  4775. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  4776. </p>
  4777. <p>
  4778. <p>SecretStoreProvider contains the provider-specific configuration.</p>
  4779. </p>
  4780. <table>
  4781. <thead>
  4782. <tr>
  4783. <th>Field</th>
  4784. <th>Description</th>
  4785. </tr>
  4786. </thead>
  4787. <tbody>
  4788. <tr>
  4789. <td>
  4790. <code>aws</code></br>
  4791. <em>
  4792. <a href="#external-secrets.io/v1beta1.AWSProvider">
  4793. AWSProvider
  4794. </a>
  4795. </em>
  4796. </td>
  4797. <td>
  4798. <em>(Optional)</em>
  4799. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  4800. </td>
  4801. </tr>
  4802. <tr>
  4803. <td>
  4804. <code>azurekv</code></br>
  4805. <em>
  4806. <a href="#external-secrets.io/v1beta1.AzureKVProvider">
  4807. AzureKVProvider
  4808. </a>
  4809. </em>
  4810. </td>
  4811. <td>
  4812. <em>(Optional)</em>
  4813. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  4814. </td>
  4815. </tr>
  4816. <tr>
  4817. <td>
  4818. <code>akeyless</code></br>
  4819. <em>
  4820. <a href="#external-secrets.io/v1beta1.AkeylessProvider">
  4821. AkeylessProvider
  4822. </a>
  4823. </em>
  4824. </td>
  4825. <td>
  4826. <em>(Optional)</em>
  4827. <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
  4828. </td>
  4829. </tr>
  4830. <tr>
  4831. <td>
  4832. <code>vault</code></br>
  4833. <em>
  4834. <a href="#external-secrets.io/v1beta1.VaultProvider">
  4835. VaultProvider
  4836. </a>
  4837. </em>
  4838. </td>
  4839. <td>
  4840. <em>(Optional)</em>
  4841. <p>Vault configures this store to sync secrets using Hashi provider</p>
  4842. </td>
  4843. </tr>
  4844. <tr>
  4845. <td>
  4846. <code>gcpsm</code></br>
  4847. <em>
  4848. <a href="#external-secrets.io/v1beta1.GCPSMProvider">
  4849. GCPSMProvider
  4850. </a>
  4851. </em>
  4852. </td>
  4853. <td>
  4854. <em>(Optional)</em>
  4855. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  4856. </td>
  4857. </tr>
  4858. <tr>
  4859. <td>
  4860. <code>oracle</code></br>
  4861. <em>
  4862. <a href="#external-secrets.io/v1beta1.OracleProvider">
  4863. OracleProvider
  4864. </a>
  4865. </em>
  4866. </td>
  4867. <td>
  4868. <em>(Optional)</em>
  4869. <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
  4870. </td>
  4871. </tr>
  4872. <tr>
  4873. <td>
  4874. <code>ibm</code></br>
  4875. <em>
  4876. <a href="#external-secrets.io/v1beta1.IBMProvider">
  4877. IBMProvider
  4878. </a>
  4879. </em>
  4880. </td>
  4881. <td>
  4882. <em>(Optional)</em>
  4883. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
  4884. </td>
  4885. </tr>
  4886. <tr>
  4887. <td>
  4888. <code>yandexcertificatemanager</code></br>
  4889. <em>
  4890. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">
  4891. YandexCertificateManagerProvider
  4892. </a>
  4893. </em>
  4894. </td>
  4895. <td>
  4896. <em>(Optional)</em>
  4897. <p>YandexCertificateManager configures this store to sync secrets using Yandex Certificate Manager provider</p>
  4898. </td>
  4899. </tr>
  4900. <tr>
  4901. <td>
  4902. <code>yandexlockbox</code></br>
  4903. <em>
  4904. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">
  4905. YandexLockboxProvider
  4906. </a>
  4907. </em>
  4908. </td>
  4909. <td>
  4910. <em>(Optional)</em>
  4911. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
  4912. </td>
  4913. </tr>
  4914. <tr>
  4915. <td>
  4916. <code>gitlab</code></br>
  4917. <em>
  4918. <a href="#external-secrets.io/v1beta1.GitlabProvider">
  4919. GitlabProvider
  4920. </a>
  4921. </em>
  4922. </td>
  4923. <td>
  4924. <em>(Optional)</em>
  4925. <p>Gitlab configures this store to sync secrets using Gitlab Variables provider</p>
  4926. </td>
  4927. </tr>
  4928. <tr>
  4929. <td>
  4930. <code>alibaba</code></br>
  4931. <em>
  4932. <a href="#external-secrets.io/v1beta1.AlibabaProvider">
  4933. AlibabaProvider
  4934. </a>
  4935. </em>
  4936. </td>
  4937. <td>
  4938. <em>(Optional)</em>
  4939. <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
  4940. </td>
  4941. </tr>
  4942. <tr>
  4943. <td>
  4944. <code>onepassword</code></br>
  4945. <em>
  4946. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">
  4947. OnePasswordProvider
  4948. </a>
  4949. </em>
  4950. </td>
  4951. <td>
  4952. <em>(Optional)</em>
  4953. <p>OnePassword configures this store to sync secrets using the 1Password Cloud provider</p>
  4954. </td>
  4955. </tr>
  4956. <tr>
  4957. <td>
  4958. <code>webhook</code></br>
  4959. <em>
  4960. <a href="#external-secrets.io/v1beta1.WebhookProvider">
  4961. WebhookProvider
  4962. </a>
  4963. </em>
  4964. </td>
  4965. <td>
  4966. <em>(Optional)</em>
  4967. <p>Webhook configures this store to sync secrets using a generic templated webhook</p>
  4968. </td>
  4969. </tr>
  4970. <tr>
  4971. <td>
  4972. <code>kubernetes</code></br>
  4973. <em>
  4974. <a href="#external-secrets.io/v1beta1.KubernetesProvider">
  4975. KubernetesProvider
  4976. </a>
  4977. </em>
  4978. </td>
  4979. <td>
  4980. <em>(Optional)</em>
  4981. <p>Kubernetes configures this store to sync secrets using a Kubernetes cluster provider</p>
  4982. </td>
  4983. </tr>
  4984. <tr>
  4985. <td>
  4986. <code>fake</code></br>
  4987. <em>
  4988. <a href="#external-secrets.io/v1beta1.FakeProvider">
  4989. FakeProvider
  4990. </a>
  4991. </em>
  4992. </td>
  4993. <td>
  4994. <em>(Optional)</em>
  4995. <p>Fake configures a store with static key/value pairs</p>
  4996. </td>
  4997. </tr>
  4998. <tr>
  4999. <td>
  5000. <code>senhasegura</code></br>
  5001. <em>
  5002. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">
  5003. SenhaseguraProvider
  5004. </a>
  5005. </em>
  5006. </td>
  5007. <td>
  5008. <em>(Optional)</em>
  5009. <p>Senhasegura configures this store to sync secrets using senhasegura provider</p>
  5010. </td>
  5011. </tr>
  5012. <tr>
  5013. <td>
  5014. <code>doppler</code></br>
  5015. <em>
  5016. <a href="#external-secrets.io/v1beta1.DopplerProvider">
  5017. DopplerProvider
  5018. </a>
  5019. </em>
  5020. </td>
  5021. <td>
  5022. <em>(Optional)</em>
  5023. <p>Doppler configures this store to sync secrets using the Doppler provider</p>
  5024. </td>
  5025. </tr>
  5026. <tr>
  5027. <td>
  5028. <code>keepersecurity</code></br>
  5029. <em>
  5030. <a href="#external-secrets.io/v1beta1.KeeperSecurityProvider">
  5031. KeeperSecurityProvider
  5032. </a>
  5033. </em>
  5034. </td>
  5035. <td>
  5036. <em>(Optional)</em>
  5037. <p>KeeperSecurity configures this store to sync secrets using the KeeperSecurity provider</p>
  5038. </td>
  5039. </tr>
  5040. </tbody>
  5041. </table>
  5042. <h3 id="external-secrets.io/v1beta1.SecretStoreRef">SecretStoreRef
  5043. </h3>
  5044. <p>
  5045. (<em>Appears on:</em>
  5046. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>,
  5047. <a href="#external-secrets.io/v1beta1.SourceRef">SourceRef</a>)
  5048. </p>
  5049. <p>
  5050. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  5051. </p>
  5052. <table>
  5053. <thead>
  5054. <tr>
  5055. <th>Field</th>
  5056. <th>Description</th>
  5057. </tr>
  5058. </thead>
  5059. <tbody>
  5060. <tr>
  5061. <td>
  5062. <code>name</code></br>
  5063. <em>
  5064. string
  5065. </em>
  5066. </td>
  5067. <td>
  5068. <p>Name of the SecretStore resource</p>
  5069. </td>
  5070. </tr>
  5071. <tr>
  5072. <td>
  5073. <code>kind</code></br>
  5074. <em>
  5075. string
  5076. </em>
  5077. </td>
  5078. <td>
  5079. <em>(Optional)</em>
  5080. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  5081. Defaults to <code>SecretStore</code></p>
  5082. </td>
  5083. </tr>
  5084. </tbody>
  5085. </table>
  5086. <h3 id="external-secrets.io/v1beta1.SecretStoreRetrySettings">SecretStoreRetrySettings
  5087. </h3>
  5088. <p>
  5089. (<em>Appears on:</em>
  5090. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  5091. </p>
  5092. <p>
  5093. </p>
  5094. <table>
  5095. <thead>
  5096. <tr>
  5097. <th>Field</th>
  5098. <th>Description</th>
  5099. </tr>
  5100. </thead>
  5101. <tbody>
  5102. <tr>
  5103. <td>
  5104. <code>maxRetries</code></br>
  5105. <em>
  5106. int32
  5107. </em>
  5108. </td>
  5109. <td>
  5110. </td>
  5111. </tr>
  5112. <tr>
  5113. <td>
  5114. <code>retryInterval</code></br>
  5115. <em>
  5116. string
  5117. </em>
  5118. </td>
  5119. <td>
  5120. </td>
  5121. </tr>
  5122. </tbody>
  5123. </table>
  5124. <h3 id="external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec
  5125. </h3>
  5126. <p>
  5127. (<em>Appears on:</em>
  5128. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  5129. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  5130. </p>
  5131. <p>
  5132. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  5133. </p>
  5134. <table>
  5135. <thead>
  5136. <tr>
  5137. <th>Field</th>
  5138. <th>Description</th>
  5139. </tr>
  5140. </thead>
  5141. <tbody>
  5142. <tr>
  5143. <td>
  5144. <code>controller</code></br>
  5145. <em>
  5146. string
  5147. </em>
  5148. </td>
  5149. <td>
  5150. <em>(Optional)</em>
  5151. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  5152. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  5153. </td>
  5154. </tr>
  5155. <tr>
  5156. <td>
  5157. <code>provider</code></br>
  5158. <em>
  5159. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  5160. SecretStoreProvider
  5161. </a>
  5162. </em>
  5163. </td>
  5164. <td>
  5165. <p>Used to configure the provider. Only one provider may be set</p>
  5166. </td>
  5167. </tr>
  5168. <tr>
  5169. <td>
  5170. <code>retrySettings</code></br>
  5171. <em>
  5172. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  5173. SecretStoreRetrySettings
  5174. </a>
  5175. </em>
  5176. </td>
  5177. <td>
  5178. <em>(Optional)</em>
  5179. <p>Used to configure http retries if failed</p>
  5180. </td>
  5181. </tr>
  5182. <tr>
  5183. <td>
  5184. <code>refreshInterval</code></br>
  5185. <em>
  5186. int
  5187. </em>
  5188. </td>
  5189. <td>
  5190. <em>(Optional)</em>
  5191. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  5192. </td>
  5193. </tr>
  5194. <tr>
  5195. <td>
  5196. <code>conditions</code></br>
  5197. <em>
  5198. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  5199. []ClusterSecretStoreCondition
  5200. </a>
  5201. </em>
  5202. </td>
  5203. <td>
  5204. <em>(Optional)</em>
  5205. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  5206. </td>
  5207. </tr>
  5208. </tbody>
  5209. </table>
  5210. <h3 id="external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus
  5211. </h3>
  5212. <p>
  5213. (<em>Appears on:</em>
  5214. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  5215. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  5216. </p>
  5217. <p>
  5218. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  5219. </p>
  5220. <table>
  5221. <thead>
  5222. <tr>
  5223. <th>Field</th>
  5224. <th>Description</th>
  5225. </tr>
  5226. </thead>
  5227. <tbody>
  5228. <tr>
  5229. <td>
  5230. <code>conditions</code></br>
  5231. <em>
  5232. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">
  5233. []SecretStoreStatusCondition
  5234. </a>
  5235. </em>
  5236. </td>
  5237. <td>
  5238. <em>(Optional)</em>
  5239. </td>
  5240. </tr>
  5241. <tr>
  5242. <td>
  5243. <code>capabilities</code></br>
  5244. <em>
  5245. <a href="#external-secrets.io/v1beta1.SecretStoreCapabilities">
  5246. SecretStoreCapabilities
  5247. </a>
  5248. </em>
  5249. </td>
  5250. <td>
  5251. <em>(Optional)</em>
  5252. </td>
  5253. </tr>
  5254. </tbody>
  5255. </table>
  5256. <h3 id="external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition
  5257. </h3>
  5258. <p>
  5259. (<em>Appears on:</em>
  5260. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  5261. </p>
  5262. <p>
  5263. </p>
  5264. <table>
  5265. <thead>
  5266. <tr>
  5267. <th>Field</th>
  5268. <th>Description</th>
  5269. </tr>
  5270. </thead>
  5271. <tbody>
  5272. <tr>
  5273. <td>
  5274. <code>type</code></br>
  5275. <em>
  5276. <a href="#external-secrets.io/v1beta1.SecretStoreConditionType">
  5277. SecretStoreConditionType
  5278. </a>
  5279. </em>
  5280. </td>
  5281. <td>
  5282. </td>
  5283. </tr>
  5284. <tr>
  5285. <td>
  5286. <code>status</code></br>
  5287. <em>
  5288. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  5289. Kubernetes core/v1.ConditionStatus
  5290. </a>
  5291. </em>
  5292. </td>
  5293. <td>
  5294. </td>
  5295. </tr>
  5296. <tr>
  5297. <td>
  5298. <code>reason</code></br>
  5299. <em>
  5300. string
  5301. </em>
  5302. </td>
  5303. <td>
  5304. <em>(Optional)</em>
  5305. </td>
  5306. </tr>
  5307. <tr>
  5308. <td>
  5309. <code>message</code></br>
  5310. <em>
  5311. string
  5312. </em>
  5313. </td>
  5314. <td>
  5315. <em>(Optional)</em>
  5316. </td>
  5317. </tr>
  5318. <tr>
  5319. <td>
  5320. <code>lastTransitionTime</code></br>
  5321. <em>
  5322. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  5323. Kubernetes meta/v1.Time
  5324. </a>
  5325. </em>
  5326. </td>
  5327. <td>
  5328. <em>(Optional)</em>
  5329. </td>
  5330. </tr>
  5331. </tbody>
  5332. </table>
  5333. <h3 id="external-secrets.io/v1beta1.SecretsClient">SecretsClient
  5334. </h3>
  5335. <p>
  5336. <p>SecretsClient provides access to secrets.</p>
  5337. </p>
  5338. <h3 id="external-secrets.io/v1beta1.SenhaseguraAuth">SenhaseguraAuth
  5339. </h3>
  5340. <p>
  5341. (<em>Appears on:</em>
  5342. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  5343. </p>
  5344. <p>
  5345. <p>SenhaseguraAuth tells the controller how to do auth in senhasegura.</p>
  5346. </p>
  5347. <table>
  5348. <thead>
  5349. <tr>
  5350. <th>Field</th>
  5351. <th>Description</th>
  5352. </tr>
  5353. </thead>
  5354. <tbody>
  5355. <tr>
  5356. <td>
  5357. <code>clientId</code></br>
  5358. <em>
  5359. string
  5360. </em>
  5361. </td>
  5362. <td>
  5363. </td>
  5364. </tr>
  5365. <tr>
  5366. <td>
  5367. <code>clientSecretSecretRef</code></br>
  5368. <em>
  5369. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5370. External Secrets meta/v1.SecretKeySelector
  5371. </a>
  5372. </em>
  5373. </td>
  5374. <td>
  5375. </td>
  5376. </tr>
  5377. </tbody>
  5378. </table>
  5379. <h3 id="external-secrets.io/v1beta1.SenhaseguraModuleType">SenhaseguraModuleType
  5380. (<code>string</code> alias)</p></h3>
  5381. <p>
  5382. (<em>Appears on:</em>
  5383. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  5384. </p>
  5385. <p>
  5386. <p>SenhaseguraModuleType enum defines senhasegura target module to fetch secrets</p>
  5387. </p>
  5388. <table>
  5389. <thead>
  5390. <tr>
  5391. <th>Value</th>
  5392. <th>Description</th>
  5393. </tr>
  5394. </thead>
  5395. <tbody><tr><td><p>&#34;DSM&#34;</p></td>
  5396. <td><pre><code> SenhaseguraModuleDSM is the senhasegura DevOps Secrets Management module
  5397. see: https://senhasegura.com/devops
  5398. </code></pre>
  5399. </td>
  5400. </tr></tbody>
  5401. </table>
  5402. <h3 id="external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider
  5403. </h3>
  5404. <p>
  5405. (<em>Appears on:</em>
  5406. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5407. </p>
  5408. <p>
  5409. <p>SenhaseguraProvider setup a store to sync secrets with senhasegura.</p>
  5410. </p>
  5411. <table>
  5412. <thead>
  5413. <tr>
  5414. <th>Field</th>
  5415. <th>Description</th>
  5416. </tr>
  5417. </thead>
  5418. <tbody>
  5419. <tr>
  5420. <td>
  5421. <code>url</code></br>
  5422. <em>
  5423. string
  5424. </em>
  5425. </td>
  5426. <td>
  5427. <p>URL of senhasegura</p>
  5428. </td>
  5429. </tr>
  5430. <tr>
  5431. <td>
  5432. <code>module</code></br>
  5433. <em>
  5434. <a href="#external-secrets.io/v1beta1.SenhaseguraModuleType">
  5435. SenhaseguraModuleType
  5436. </a>
  5437. </em>
  5438. </td>
  5439. <td>
  5440. <p>Module defines which senhasegura module should be used to get secrets</p>
  5441. </td>
  5442. </tr>
  5443. <tr>
  5444. <td>
  5445. <code>auth</code></br>
  5446. <em>
  5447. <a href="#external-secrets.io/v1beta1.SenhaseguraAuth">
  5448. SenhaseguraAuth
  5449. </a>
  5450. </em>
  5451. </td>
  5452. <td>
  5453. <p>Auth defines parameters to authenticate in senhasegura</p>
  5454. </td>
  5455. </tr>
  5456. <tr>
  5457. <td>
  5458. <code>ignoreSslCertificate</code></br>
  5459. <em>
  5460. bool
  5461. </em>
  5462. </td>
  5463. <td>
  5464. <p>IgnoreSslCertificate defines if SSL certificate must be ignored</p>
  5465. </td>
  5466. </tr>
  5467. </tbody>
  5468. </table>
  5469. <h3 id="external-secrets.io/v1beta1.SourceRef">SourceRef
  5470. </h3>
  5471. <p>
  5472. (<em>Appears on:</em>
  5473. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>,
  5474. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  5475. </p>
  5476. <p>
  5477. <p>SourceRef allows you to override the source
  5478. from which the secret will be pulled from.
  5479. You can define at maximum one property.</p>
  5480. </p>
  5481. <table>
  5482. <thead>
  5483. <tr>
  5484. <th>Field</th>
  5485. <th>Description</th>
  5486. </tr>
  5487. </thead>
  5488. <tbody>
  5489. <tr>
  5490. <td>
  5491. <code>storeRef</code></br>
  5492. <em>
  5493. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  5494. SecretStoreRef
  5495. </a>
  5496. </em>
  5497. </td>
  5498. <td>
  5499. <em>(Optional)</em>
  5500. </td>
  5501. </tr>
  5502. <tr>
  5503. <td>
  5504. <code>generatorRef</code></br>
  5505. <em>
  5506. <a href="#external-secrets.io/v1beta1.GeneratorRef">
  5507. GeneratorRef
  5508. </a>
  5509. </em>
  5510. </td>
  5511. <td>
  5512. <em>(Optional)</em>
  5513. <p>GeneratorRef points to a generator custom resource in</p>
  5514. </td>
  5515. </tr>
  5516. </tbody>
  5517. </table>
  5518. <h3 id="external-secrets.io/v1beta1.TemplateEngineVersion">TemplateEngineVersion
  5519. (<code>string</code> alias)</p></h3>
  5520. <p>
  5521. (<em>Appears on:</em>
  5522. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  5523. </p>
  5524. <p>
  5525. </p>
  5526. <table>
  5527. <thead>
  5528. <tr>
  5529. <th>Value</th>
  5530. <th>Description</th>
  5531. </tr>
  5532. </thead>
  5533. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  5534. <td></td>
  5535. </tr><tr><td><p>&#34;v2&#34;</p></td>
  5536. <td></td>
  5537. </tr></tbody>
  5538. </table>
  5539. <h3 id="external-secrets.io/v1beta1.TemplateFrom">TemplateFrom
  5540. </h3>
  5541. <p>
  5542. (<em>Appears on:</em>
  5543. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  5544. </p>
  5545. <p>
  5546. </p>
  5547. <table>
  5548. <thead>
  5549. <tr>
  5550. <th>Field</th>
  5551. <th>Description</th>
  5552. </tr>
  5553. </thead>
  5554. <tbody>
  5555. <tr>
  5556. <td>
  5557. <code>configMap</code></br>
  5558. <em>
  5559. <a href="#external-secrets.io/v1beta1.TemplateRef">
  5560. TemplateRef
  5561. </a>
  5562. </em>
  5563. </td>
  5564. <td>
  5565. </td>
  5566. </tr>
  5567. <tr>
  5568. <td>
  5569. <code>secret</code></br>
  5570. <em>
  5571. <a href="#external-secrets.io/v1beta1.TemplateRef">
  5572. TemplateRef
  5573. </a>
  5574. </em>
  5575. </td>
  5576. <td>
  5577. </td>
  5578. </tr>
  5579. <tr>
  5580. <td>
  5581. <code>target</code></br>
  5582. <em>
  5583. <a href="#external-secrets.io/v1beta1.TemplateTarget">
  5584. TemplateTarget
  5585. </a>
  5586. </em>
  5587. </td>
  5588. <td>
  5589. <em>(Optional)</em>
  5590. </td>
  5591. </tr>
  5592. <tr>
  5593. <td>
  5594. <code>literal</code></br>
  5595. <em>
  5596. string
  5597. </em>
  5598. </td>
  5599. <td>
  5600. <em>(Optional)</em>
  5601. </td>
  5602. </tr>
  5603. </tbody>
  5604. </table>
  5605. <h3 id="external-secrets.io/v1beta1.TemplateRef">TemplateRef
  5606. </h3>
  5607. <p>
  5608. (<em>Appears on:</em>
  5609. <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
  5610. </p>
  5611. <p>
  5612. </p>
  5613. <table>
  5614. <thead>
  5615. <tr>
  5616. <th>Field</th>
  5617. <th>Description</th>
  5618. </tr>
  5619. </thead>
  5620. <tbody>
  5621. <tr>
  5622. <td>
  5623. <code>name</code></br>
  5624. <em>
  5625. string
  5626. </em>
  5627. </td>
  5628. <td>
  5629. </td>
  5630. </tr>
  5631. <tr>
  5632. <td>
  5633. <code>items</code></br>
  5634. <em>
  5635. <a href="#external-secrets.io/v1beta1.TemplateRefItem">
  5636. []TemplateRefItem
  5637. </a>
  5638. </em>
  5639. </td>
  5640. <td>
  5641. </td>
  5642. </tr>
  5643. </tbody>
  5644. </table>
  5645. <h3 id="external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem
  5646. </h3>
  5647. <p>
  5648. (<em>Appears on:</em>
  5649. <a href="#external-secrets.io/v1beta1.TemplateRef">TemplateRef</a>)
  5650. </p>
  5651. <p>
  5652. </p>
  5653. <table>
  5654. <thead>
  5655. <tr>
  5656. <th>Field</th>
  5657. <th>Description</th>
  5658. </tr>
  5659. </thead>
  5660. <tbody>
  5661. <tr>
  5662. <td>
  5663. <code>key</code></br>
  5664. <em>
  5665. string
  5666. </em>
  5667. </td>
  5668. <td>
  5669. </td>
  5670. </tr>
  5671. <tr>
  5672. <td>
  5673. <code>templateAs</code></br>
  5674. <em>
  5675. <a href="#external-secrets.io/v1beta1.TemplateScope">
  5676. TemplateScope
  5677. </a>
  5678. </em>
  5679. </td>
  5680. <td>
  5681. </td>
  5682. </tr>
  5683. </tbody>
  5684. </table>
  5685. <h3 id="external-secrets.io/v1beta1.TemplateScope">TemplateScope
  5686. (<code>string</code> alias)</p></h3>
  5687. <p>
  5688. (<em>Appears on:</em>
  5689. <a href="#external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem</a>)
  5690. </p>
  5691. <p>
  5692. </p>
  5693. <table>
  5694. <thead>
  5695. <tr>
  5696. <th>Value</th>
  5697. <th>Description</th>
  5698. </tr>
  5699. </thead>
  5700. <tbody><tr><td><p>&#34;KeysAndValues&#34;</p></td>
  5701. <td></td>
  5702. </tr><tr><td><p>&#34;Values&#34;</p></td>
  5703. <td></td>
  5704. </tr></tbody>
  5705. </table>
  5706. <h3 id="external-secrets.io/v1beta1.TemplateTarget">TemplateTarget
  5707. (<code>string</code> alias)</p></h3>
  5708. <p>
  5709. (<em>Appears on:</em>
  5710. <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
  5711. </p>
  5712. <p>
  5713. </p>
  5714. <table>
  5715. <thead>
  5716. <tr>
  5717. <th>Value</th>
  5718. <th>Description</th>
  5719. </tr>
  5720. </thead>
  5721. <tbody><tr><td><p>&#34;Annotations&#34;</p></td>
  5722. <td></td>
  5723. </tr><tr><td><p>&#34;Data&#34;</p></td>
  5724. <td></td>
  5725. </tr><tr><td><p>&#34;Labels&#34;</p></td>
  5726. <td></td>
  5727. </tr></tbody>
  5728. </table>
  5729. <h3 id="external-secrets.io/v1beta1.TokenAuth">TokenAuth
  5730. </h3>
  5731. <p>
  5732. (<em>Appears on:</em>
  5733. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  5734. </p>
  5735. <p>
  5736. </p>
  5737. <table>
  5738. <thead>
  5739. <tr>
  5740. <th>Field</th>
  5741. <th>Description</th>
  5742. </tr>
  5743. </thead>
  5744. <tbody>
  5745. <tr>
  5746. <td>
  5747. <code>bearerToken</code></br>
  5748. <em>
  5749. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5750. External Secrets meta/v1.SecretKeySelector
  5751. </a>
  5752. </em>
  5753. </td>
  5754. <td>
  5755. </td>
  5756. </tr>
  5757. </tbody>
  5758. </table>
  5759. <h3 id="external-secrets.io/v1beta1.ValidationResult">ValidationResult
  5760. (<code>byte</code> alias)</p></h3>
  5761. <p>
  5762. </p>
  5763. <table>
  5764. <thead>
  5765. <tr>
  5766. <th>Value</th>
  5767. <th>Description</th>
  5768. </tr>
  5769. </thead>
  5770. <tbody><tr><td><p>2</p></td>
  5771. <td><p>Error indicates that there is a misconfiguration.</p>
  5772. </td>
  5773. </tr><tr><td><p>0</p></td>
  5774. <td><p>Ready indicates that the client is configured correctly
  5775. and can be used.</p>
  5776. </td>
  5777. </tr><tr><td><p>1</p></td>
  5778. <td><p>Unknown indicates that the client can be used
  5779. but information is missing and it can not be validated.</p>
  5780. </td>
  5781. </tr></tbody>
  5782. </table>
  5783. <h3 id="external-secrets.io/v1beta1.VaultAppRole">VaultAppRole
  5784. </h3>
  5785. <p>
  5786. (<em>Appears on:</em>
  5787. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  5788. </p>
  5789. <p>
  5790. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  5791. with the role and secret stored in a Kubernetes Secret resource.</p>
  5792. </p>
  5793. <table>
  5794. <thead>
  5795. <tr>
  5796. <th>Field</th>
  5797. <th>Description</th>
  5798. </tr>
  5799. </thead>
  5800. <tbody>
  5801. <tr>
  5802. <td>
  5803. <code>path</code></br>
  5804. <em>
  5805. string
  5806. </em>
  5807. </td>
  5808. <td>
  5809. <p>Path where the App Role authentication backend is mounted
  5810. in Vault, e.g: &ldquo;approle&rdquo;</p>
  5811. </td>
  5812. </tr>
  5813. <tr>
  5814. <td>
  5815. <code>roleId</code></br>
  5816. <em>
  5817. string
  5818. </em>
  5819. </td>
  5820. <td>
  5821. <p>RoleID configured in the App Role authentication backend when setting
  5822. up the authentication backend in Vault.</p>
  5823. </td>
  5824. </tr>
  5825. <tr>
  5826. <td>
  5827. <code>secretRef</code></br>
  5828. <em>
  5829. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5830. External Secrets meta/v1.SecretKeySelector
  5831. </a>
  5832. </em>
  5833. </td>
  5834. <td>
  5835. <p>Reference to a key in a Secret that contains the App Role secret used
  5836. to authenticate with Vault.
  5837. The <code>key</code> field must be specified and denotes which entry within the Secret
  5838. resource is used as the app role secret.</p>
  5839. </td>
  5840. </tr>
  5841. </tbody>
  5842. </table>
  5843. <h3 id="external-secrets.io/v1beta1.VaultAuth">VaultAuth
  5844. </h3>
  5845. <p>
  5846. (<em>Appears on:</em>
  5847. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  5848. </p>
  5849. <p>
  5850. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  5851. Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>jwt</code> or <code>cert</code>
  5852. can be specified.</p>
  5853. </p>
  5854. <table>
  5855. <thead>
  5856. <tr>
  5857. <th>Field</th>
  5858. <th>Description</th>
  5859. </tr>
  5860. </thead>
  5861. <tbody>
  5862. <tr>
  5863. <td>
  5864. <code>tokenSecretRef</code></br>
  5865. <em>
  5866. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5867. External Secrets meta/v1.SecretKeySelector
  5868. </a>
  5869. </em>
  5870. </td>
  5871. <td>
  5872. <em>(Optional)</em>
  5873. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  5874. </td>
  5875. </tr>
  5876. <tr>
  5877. <td>
  5878. <code>appRole</code></br>
  5879. <em>
  5880. <a href="#external-secrets.io/v1beta1.VaultAppRole">
  5881. VaultAppRole
  5882. </a>
  5883. </em>
  5884. </td>
  5885. <td>
  5886. <em>(Optional)</em>
  5887. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  5888. with the role and secret stored in a Kubernetes Secret resource.</p>
  5889. </td>
  5890. </tr>
  5891. <tr>
  5892. <td>
  5893. <code>kubernetes</code></br>
  5894. <em>
  5895. <a href="#external-secrets.io/v1beta1.VaultKubernetesAuth">
  5896. VaultKubernetesAuth
  5897. </a>
  5898. </em>
  5899. </td>
  5900. <td>
  5901. <em>(Optional)</em>
  5902. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  5903. token stored in the named Secret resource to the Vault server.</p>
  5904. </td>
  5905. </tr>
  5906. <tr>
  5907. <td>
  5908. <code>ldap</code></br>
  5909. <em>
  5910. <a href="#external-secrets.io/v1beta1.VaultLdapAuth">
  5911. VaultLdapAuth
  5912. </a>
  5913. </em>
  5914. </td>
  5915. <td>
  5916. <em>(Optional)</em>
  5917. <p>Ldap authenticates with Vault by passing username/password pair using
  5918. the LDAP authentication method</p>
  5919. </td>
  5920. </tr>
  5921. <tr>
  5922. <td>
  5923. <code>jwt</code></br>
  5924. <em>
  5925. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">
  5926. VaultJwtAuth
  5927. </a>
  5928. </em>
  5929. </td>
  5930. <td>
  5931. <em>(Optional)</em>
  5932. <p>Jwt authenticates with Vault by passing role and JWT token using the
  5933. JWT/OIDC authentication method</p>
  5934. </td>
  5935. </tr>
  5936. <tr>
  5937. <td>
  5938. <code>cert</code></br>
  5939. <em>
  5940. <a href="#external-secrets.io/v1beta1.VaultCertAuth">
  5941. VaultCertAuth
  5942. </a>
  5943. </em>
  5944. </td>
  5945. <td>
  5946. <em>(Optional)</em>
  5947. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  5948. Cert authentication method</p>
  5949. </td>
  5950. </tr>
  5951. </tbody>
  5952. </table>
  5953. <h3 id="external-secrets.io/v1beta1.VaultCertAuth">VaultCertAuth
  5954. </h3>
  5955. <p>
  5956. (<em>Appears on:</em>
  5957. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  5958. </p>
  5959. <p>
  5960. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  5961. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  5962. </p>
  5963. <table>
  5964. <thead>
  5965. <tr>
  5966. <th>Field</th>
  5967. <th>Description</th>
  5968. </tr>
  5969. </thead>
  5970. <tbody>
  5971. <tr>
  5972. <td>
  5973. <code>clientCert</code></br>
  5974. <em>
  5975. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5976. External Secrets meta/v1.SecretKeySelector
  5977. </a>
  5978. </em>
  5979. </td>
  5980. <td>
  5981. <em>(Optional)</em>
  5982. <p>ClientCert is a certificate to authenticate using the Cert Vault
  5983. authentication method</p>
  5984. </td>
  5985. </tr>
  5986. <tr>
  5987. <td>
  5988. <code>secretRef</code></br>
  5989. <em>
  5990. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5991. External Secrets meta/v1.SecretKeySelector
  5992. </a>
  5993. </em>
  5994. </td>
  5995. <td>
  5996. <p>SecretRef to a key in a Secret resource containing client private key to
  5997. authenticate with Vault using the Cert authentication method</p>
  5998. </td>
  5999. </tr>
  6000. </tbody>
  6001. </table>
  6002. <h3 id="external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth
  6003. </h3>
  6004. <p>
  6005. (<em>Appears on:</em>
  6006. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  6007. </p>
  6008. <p>
  6009. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  6010. method, with the role name and a token stored in a Kubernetes Secret resource or
  6011. a Kubernetes service account token retrieved via <code>TokenRequest</code>.</p>
  6012. </p>
  6013. <table>
  6014. <thead>
  6015. <tr>
  6016. <th>Field</th>
  6017. <th>Description</th>
  6018. </tr>
  6019. </thead>
  6020. <tbody>
  6021. <tr>
  6022. <td>
  6023. <code>path</code></br>
  6024. <em>
  6025. string
  6026. </em>
  6027. </td>
  6028. <td>
  6029. <p>Path where the JWT authentication backend is mounted
  6030. in Vault, e.g: &ldquo;jwt&rdquo;</p>
  6031. </td>
  6032. </tr>
  6033. <tr>
  6034. <td>
  6035. <code>role</code></br>
  6036. <em>
  6037. string
  6038. </em>
  6039. </td>
  6040. <td>
  6041. <em>(Optional)</em>
  6042. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  6043. authentication method</p>
  6044. </td>
  6045. </tr>
  6046. <tr>
  6047. <td>
  6048. <code>secretRef</code></br>
  6049. <em>
  6050. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6051. External Secrets meta/v1.SecretKeySelector
  6052. </a>
  6053. </em>
  6054. </td>
  6055. <td>
  6056. <em>(Optional)</em>
  6057. <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  6058. authenticate with Vault using the JWT/OIDC authentication method.</p>
  6059. </td>
  6060. </tr>
  6061. <tr>
  6062. <td>
  6063. <code>kubernetesServiceAccountToken</code></br>
  6064. <em>
  6065. <a href="#external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">
  6066. VaultKubernetesServiceAccountTokenAuth
  6067. </a>
  6068. </em>
  6069. </td>
  6070. <td>
  6071. <em>(Optional)</em>
  6072. <p>Optional ServiceAccountToken specifies the Kubernetes service account for which to request
  6073. a token for with the <code>TokenRequest</code> API.</p>
  6074. </td>
  6075. </tr>
  6076. </tbody>
  6077. </table>
  6078. <h3 id="external-secrets.io/v1beta1.VaultKVStoreVersion">VaultKVStoreVersion
  6079. (<code>string</code> alias)</p></h3>
  6080. <p>
  6081. (<em>Appears on:</em>
  6082. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  6083. </p>
  6084. <p>
  6085. </p>
  6086. <table>
  6087. <thead>
  6088. <tr>
  6089. <th>Value</th>
  6090. <th>Description</th>
  6091. </tr>
  6092. </thead>
  6093. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  6094. <td></td>
  6095. </tr><tr><td><p>&#34;v2&#34;</p></td>
  6096. <td></td>
  6097. </tr></tbody>
  6098. </table>
  6099. <h3 id="external-secrets.io/v1beta1.VaultKubernetesAuth">VaultKubernetesAuth
  6100. </h3>
  6101. <p>
  6102. (<em>Appears on:</em>
  6103. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  6104. </p>
  6105. <p>
  6106. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  6107. a Secret.</p>
  6108. </p>
  6109. <table>
  6110. <thead>
  6111. <tr>
  6112. <th>Field</th>
  6113. <th>Description</th>
  6114. </tr>
  6115. </thead>
  6116. <tbody>
  6117. <tr>
  6118. <td>
  6119. <code>mountPath</code></br>
  6120. <em>
  6121. string
  6122. </em>
  6123. </td>
  6124. <td>
  6125. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  6126. &ldquo;kubernetes&rdquo;</p>
  6127. </td>
  6128. </tr>
  6129. <tr>
  6130. <td>
  6131. <code>serviceAccountRef</code></br>
  6132. <em>
  6133. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  6134. External Secrets meta/v1.ServiceAccountSelector
  6135. </a>
  6136. </em>
  6137. </td>
  6138. <td>
  6139. <em>(Optional)</em>
  6140. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  6141. If the service account is specified, the service account secret token JWT will be used
  6142. for authenticating with Vault. If the service account selector is not supplied,
  6143. the secretRef will be used instead.</p>
  6144. </td>
  6145. </tr>
  6146. <tr>
  6147. <td>
  6148. <code>secretRef</code></br>
  6149. <em>
  6150. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6151. External Secrets meta/v1.SecretKeySelector
  6152. </a>
  6153. </em>
  6154. </td>
  6155. <td>
  6156. <em>(Optional)</em>
  6157. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  6158. for authenticating with Vault. If a name is specified without a key,
  6159. <code>token</code> is the default. If one is not specified, the one bound to
  6160. the controller will be used.</p>
  6161. </td>
  6162. </tr>
  6163. <tr>
  6164. <td>
  6165. <code>role</code></br>
  6166. <em>
  6167. string
  6168. </em>
  6169. </td>
  6170. <td>
  6171. <p>A required field containing the Vault Role to assume. A Role binds a
  6172. Kubernetes ServiceAccount with a set of Vault policies.</p>
  6173. </td>
  6174. </tr>
  6175. </tbody>
  6176. </table>
  6177. <h3 id="external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">VaultKubernetesServiceAccountTokenAuth
  6178. </h3>
  6179. <p>
  6180. (<em>Appears on:</em>
  6181. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth</a>)
  6182. </p>
  6183. <p>
  6184. <p>VaultKubernetesServiceAccountTokenAuth authenticates with Vault using a temporary
  6185. Kubernetes service account token retrieved by the <code>TokenRequest</code> API.</p>
  6186. </p>
  6187. <table>
  6188. <thead>
  6189. <tr>
  6190. <th>Field</th>
  6191. <th>Description</th>
  6192. </tr>
  6193. </thead>
  6194. <tbody>
  6195. <tr>
  6196. <td>
  6197. <code>serviceAccountRef</code></br>
  6198. <em>
  6199. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  6200. External Secrets meta/v1.ServiceAccountSelector
  6201. </a>
  6202. </em>
  6203. </td>
  6204. <td>
  6205. <p>Service account field containing the name of a kubernetes ServiceAccount.</p>
  6206. </td>
  6207. </tr>
  6208. <tr>
  6209. <td>
  6210. <code>audiences</code></br>
  6211. <em>
  6212. []string
  6213. </em>
  6214. </td>
  6215. <td>
  6216. <em>(Optional)</em>
  6217. <p>Optional audiences field that will be used to request a temporary Kubernetes service
  6218. account token for the service account referenced by <code>serviceAccountRef</code>.
  6219. Defaults to a single audience <code>vault</code> it not specified.
  6220. Deprecated: use serviceAccountRef.Audiences instead</p>
  6221. </td>
  6222. </tr>
  6223. <tr>
  6224. <td>
  6225. <code>expirationSeconds</code></br>
  6226. <em>
  6227. int64
  6228. </em>
  6229. </td>
  6230. <td>
  6231. <em>(Optional)</em>
  6232. <p>Optional expiration time in seconds that will be used to request a temporary
  6233. Kubernetes service account token for the service account referenced by
  6234. <code>serviceAccountRef</code>.
  6235. Deprecated: this will be removed in the future.
  6236. Defaults to 10 minutes.</p>
  6237. </td>
  6238. </tr>
  6239. </tbody>
  6240. </table>
  6241. <h3 id="external-secrets.io/v1beta1.VaultLdapAuth">VaultLdapAuth
  6242. </h3>
  6243. <p>
  6244. (<em>Appears on:</em>
  6245. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  6246. </p>
  6247. <p>
  6248. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  6249. with the username and password stored in a Kubernetes Secret resource.</p>
  6250. </p>
  6251. <table>
  6252. <thead>
  6253. <tr>
  6254. <th>Field</th>
  6255. <th>Description</th>
  6256. </tr>
  6257. </thead>
  6258. <tbody>
  6259. <tr>
  6260. <td>
  6261. <code>path</code></br>
  6262. <em>
  6263. string
  6264. </em>
  6265. </td>
  6266. <td>
  6267. <p>Path where the LDAP authentication backend is mounted
  6268. in Vault, e.g: &ldquo;ldap&rdquo;</p>
  6269. </td>
  6270. </tr>
  6271. <tr>
  6272. <td>
  6273. <code>username</code></br>
  6274. <em>
  6275. string
  6276. </em>
  6277. </td>
  6278. <td>
  6279. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  6280. authentication method</p>
  6281. </td>
  6282. </tr>
  6283. <tr>
  6284. <td>
  6285. <code>secretRef</code></br>
  6286. <em>
  6287. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6288. External Secrets meta/v1.SecretKeySelector
  6289. </a>
  6290. </em>
  6291. </td>
  6292. <td>
  6293. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  6294. user used to authenticate with Vault using the LDAP authentication
  6295. method</p>
  6296. </td>
  6297. </tr>
  6298. </tbody>
  6299. </table>
  6300. <h3 id="external-secrets.io/v1beta1.VaultProvider">VaultProvider
  6301. </h3>
  6302. <p>
  6303. (<em>Appears on:</em>
  6304. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6305. </p>
  6306. <p>
  6307. <p>Configures an store to sync secrets using a HashiCorp Vault
  6308. KV backend.</p>
  6309. </p>
  6310. <table>
  6311. <thead>
  6312. <tr>
  6313. <th>Field</th>
  6314. <th>Description</th>
  6315. </tr>
  6316. </thead>
  6317. <tbody>
  6318. <tr>
  6319. <td>
  6320. <code>auth</code></br>
  6321. <em>
  6322. <a href="#external-secrets.io/v1beta1.VaultAuth">
  6323. VaultAuth
  6324. </a>
  6325. </em>
  6326. </td>
  6327. <td>
  6328. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  6329. </td>
  6330. </tr>
  6331. <tr>
  6332. <td>
  6333. <code>server</code></br>
  6334. <em>
  6335. string
  6336. </em>
  6337. </td>
  6338. <td>
  6339. <p>Server is the connection address for the Vault server, e.g: &ldquo;<a href="https://vault.example.com:8200&quot;">https://vault.example.com:8200&rdquo;</a>.</p>
  6340. </td>
  6341. </tr>
  6342. <tr>
  6343. <td>
  6344. <code>path</code></br>
  6345. <em>
  6346. string
  6347. </em>
  6348. </td>
  6349. <td>
  6350. <em>(Optional)</em>
  6351. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  6352. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  6353. for fetching secrets from Vault is optional and will be appended
  6354. if not present in specified path.</p>
  6355. </td>
  6356. </tr>
  6357. <tr>
  6358. <td>
  6359. <code>version</code></br>
  6360. <em>
  6361. <a href="#external-secrets.io/v1beta1.VaultKVStoreVersion">
  6362. VaultKVStoreVersion
  6363. </a>
  6364. </em>
  6365. </td>
  6366. <td>
  6367. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  6368. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  6369. </td>
  6370. </tr>
  6371. <tr>
  6372. <td>
  6373. <code>namespace</code></br>
  6374. <em>
  6375. string
  6376. </em>
  6377. </td>
  6378. <td>
  6379. <em>(Optional)</em>
  6380. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  6381. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  6382. 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>
  6383. </td>
  6384. </tr>
  6385. <tr>
  6386. <td>
  6387. <code>caBundle</code></br>
  6388. <em>
  6389. []byte
  6390. </em>
  6391. </td>
  6392. <td>
  6393. <em>(Optional)</em>
  6394. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  6395. if the Server URL is using HTTPS protocol. This parameter is ignored for
  6396. plain HTTP protocol connection. If not set the system root certificates
  6397. are used to validate the TLS connection.</p>
  6398. </td>
  6399. </tr>
  6400. <tr>
  6401. <td>
  6402. <code>caProvider</code></br>
  6403. <em>
  6404. <a href="#external-secrets.io/v1beta1.CAProvider">
  6405. CAProvider
  6406. </a>
  6407. </em>
  6408. </td>
  6409. <td>
  6410. <em>(Optional)</em>
  6411. <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
  6412. </td>
  6413. </tr>
  6414. <tr>
  6415. <td>
  6416. <code>readYourWrites</code></br>
  6417. <em>
  6418. bool
  6419. </em>
  6420. </td>
  6421. <td>
  6422. <em>(Optional)</em>
  6423. <p>ReadYourWrites ensures isolated read-after-write semantics by
  6424. providing discovered cluster replication states in each request.
  6425. More information about eventual consistency in Vault can be found here
  6426. <a href="https://www.vaultproject.io/docs/enterprise/consistency">https://www.vaultproject.io/docs/enterprise/consistency</a></p>
  6427. </td>
  6428. </tr>
  6429. <tr>
  6430. <td>
  6431. <code>forwardInconsistent</code></br>
  6432. <em>
  6433. bool
  6434. </em>
  6435. </td>
  6436. <td>
  6437. <em>(Optional)</em>
  6438. <p>ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
  6439. leader instead of simply retrying within a loop. This can increase performance if
  6440. the option is enabled serverside.
  6441. <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>
  6442. </td>
  6443. </tr>
  6444. </tbody>
  6445. </table>
  6446. <h3 id="external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider
  6447. </h3>
  6448. <p>
  6449. (<em>Appears on:</em>
  6450. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  6451. </p>
  6452. <p>
  6453. <p>Defines a location to fetch the cert for the webhook provider from.</p>
  6454. </p>
  6455. <table>
  6456. <thead>
  6457. <tr>
  6458. <th>Field</th>
  6459. <th>Description</th>
  6460. </tr>
  6461. </thead>
  6462. <tbody>
  6463. <tr>
  6464. <td>
  6465. <code>type</code></br>
  6466. <em>
  6467. <a href="#external-secrets.io/v1beta1.WebhookCAProviderType">
  6468. WebhookCAProviderType
  6469. </a>
  6470. </em>
  6471. </td>
  6472. <td>
  6473. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  6474. </td>
  6475. </tr>
  6476. <tr>
  6477. <td>
  6478. <code>name</code></br>
  6479. <em>
  6480. string
  6481. </em>
  6482. </td>
  6483. <td>
  6484. <p>The name of the object located at the provider type.</p>
  6485. </td>
  6486. </tr>
  6487. <tr>
  6488. <td>
  6489. <code>key</code></br>
  6490. <em>
  6491. string
  6492. </em>
  6493. </td>
  6494. <td>
  6495. <p>The key the value inside of the provider type to use, only used with &ldquo;Secret&rdquo; type</p>
  6496. </td>
  6497. </tr>
  6498. <tr>
  6499. <td>
  6500. <code>namespace</code></br>
  6501. <em>
  6502. string
  6503. </em>
  6504. </td>
  6505. <td>
  6506. <em>(Optional)</em>
  6507. <p>The namespace the Provider type is in.</p>
  6508. </td>
  6509. </tr>
  6510. </tbody>
  6511. </table>
  6512. <h3 id="external-secrets.io/v1beta1.WebhookCAProviderType">WebhookCAProviderType
  6513. (<code>string</code> alias)</p></h3>
  6514. <p>
  6515. (<em>Appears on:</em>
  6516. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider</a>)
  6517. </p>
  6518. <p>
  6519. </p>
  6520. <table>
  6521. <thead>
  6522. <tr>
  6523. <th>Value</th>
  6524. <th>Description</th>
  6525. </tr>
  6526. </thead>
  6527. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  6528. <td></td>
  6529. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  6530. <td></td>
  6531. </tr></tbody>
  6532. </table>
  6533. <h3 id="external-secrets.io/v1beta1.WebhookProvider">WebhookProvider
  6534. </h3>
  6535. <p>
  6536. (<em>Appears on:</em>
  6537. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6538. </p>
  6539. <p>
  6540. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  6541. </p>
  6542. <table>
  6543. <thead>
  6544. <tr>
  6545. <th>Field</th>
  6546. <th>Description</th>
  6547. </tr>
  6548. </thead>
  6549. <tbody>
  6550. <tr>
  6551. <td>
  6552. <code>method</code></br>
  6553. <em>
  6554. string
  6555. </em>
  6556. </td>
  6557. <td>
  6558. <p>Webhook Method</p>
  6559. </td>
  6560. </tr>
  6561. <tr>
  6562. <td>
  6563. <code>url</code></br>
  6564. <em>
  6565. string
  6566. </em>
  6567. </td>
  6568. <td>
  6569. <p>Webhook url to call</p>
  6570. </td>
  6571. </tr>
  6572. <tr>
  6573. <td>
  6574. <code>headers</code></br>
  6575. <em>
  6576. map[string]string
  6577. </em>
  6578. </td>
  6579. <td>
  6580. <em>(Optional)</em>
  6581. <p>Headers</p>
  6582. </td>
  6583. </tr>
  6584. <tr>
  6585. <td>
  6586. <code>body</code></br>
  6587. <em>
  6588. string
  6589. </em>
  6590. </td>
  6591. <td>
  6592. <em>(Optional)</em>
  6593. <p>Body</p>
  6594. </td>
  6595. </tr>
  6596. <tr>
  6597. <td>
  6598. <code>timeout</code></br>
  6599. <em>
  6600. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  6601. Kubernetes meta/v1.Duration
  6602. </a>
  6603. </em>
  6604. </td>
  6605. <td>
  6606. <em>(Optional)</em>
  6607. <p>Timeout</p>
  6608. </td>
  6609. </tr>
  6610. <tr>
  6611. <td>
  6612. <code>result</code></br>
  6613. <em>
  6614. <a href="#external-secrets.io/v1beta1.WebhookResult">
  6615. WebhookResult
  6616. </a>
  6617. </em>
  6618. </td>
  6619. <td>
  6620. <p>Result formatting</p>
  6621. </td>
  6622. </tr>
  6623. <tr>
  6624. <td>
  6625. <code>secrets</code></br>
  6626. <em>
  6627. <a href="#external-secrets.io/v1beta1.WebhookSecret">
  6628. []WebhookSecret
  6629. </a>
  6630. </em>
  6631. </td>
  6632. <td>
  6633. <em>(Optional)</em>
  6634. <p>Secrets to fill in templates
  6635. These secrets will be passed to the templating function as key value pairs under the given name</p>
  6636. </td>
  6637. </tr>
  6638. <tr>
  6639. <td>
  6640. <code>caBundle</code></br>
  6641. <em>
  6642. []byte
  6643. </em>
  6644. </td>
  6645. <td>
  6646. <em>(Optional)</em>
  6647. <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
  6648. if the Server URL is using HTTPS protocol. This parameter is ignored for
  6649. plain HTTP protocol connection. If not set the system root certificates
  6650. are used to validate the TLS connection.</p>
  6651. </td>
  6652. </tr>
  6653. <tr>
  6654. <td>
  6655. <code>caProvider</code></br>
  6656. <em>
  6657. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">
  6658. WebhookCAProvider
  6659. </a>
  6660. </em>
  6661. </td>
  6662. <td>
  6663. <em>(Optional)</em>
  6664. <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
  6665. </td>
  6666. </tr>
  6667. </tbody>
  6668. </table>
  6669. <h3 id="external-secrets.io/v1beta1.WebhookResult">WebhookResult
  6670. </h3>
  6671. <p>
  6672. (<em>Appears on:</em>
  6673. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  6674. </p>
  6675. <p>
  6676. </p>
  6677. <table>
  6678. <thead>
  6679. <tr>
  6680. <th>Field</th>
  6681. <th>Description</th>
  6682. </tr>
  6683. </thead>
  6684. <tbody>
  6685. <tr>
  6686. <td>
  6687. <code>jsonPath</code></br>
  6688. <em>
  6689. string
  6690. </em>
  6691. </td>
  6692. <td>
  6693. <em>(Optional)</em>
  6694. <p>Json path of return value</p>
  6695. </td>
  6696. </tr>
  6697. </tbody>
  6698. </table>
  6699. <h3 id="external-secrets.io/v1beta1.WebhookSecret">WebhookSecret
  6700. </h3>
  6701. <p>
  6702. (<em>Appears on:</em>
  6703. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  6704. </p>
  6705. <p>
  6706. </p>
  6707. <table>
  6708. <thead>
  6709. <tr>
  6710. <th>Field</th>
  6711. <th>Description</th>
  6712. </tr>
  6713. </thead>
  6714. <tbody>
  6715. <tr>
  6716. <td>
  6717. <code>name</code></br>
  6718. <em>
  6719. string
  6720. </em>
  6721. </td>
  6722. <td>
  6723. <p>Name of this secret in templates</p>
  6724. </td>
  6725. </tr>
  6726. <tr>
  6727. <td>
  6728. <code>secretRef</code></br>
  6729. <em>
  6730. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6731. External Secrets meta/v1.SecretKeySelector
  6732. </a>
  6733. </em>
  6734. </td>
  6735. <td>
  6736. <p>Secret ref to fill in credentials</p>
  6737. </td>
  6738. </tr>
  6739. </tbody>
  6740. </table>
  6741. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerAuth">YandexCertificateManagerAuth
  6742. </h3>
  6743. <p>
  6744. (<em>Appears on:</em>
  6745. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  6746. </p>
  6747. <p>
  6748. </p>
  6749. <table>
  6750. <thead>
  6751. <tr>
  6752. <th>Field</th>
  6753. <th>Description</th>
  6754. </tr>
  6755. </thead>
  6756. <tbody>
  6757. <tr>
  6758. <td>
  6759. <code>authorizedKeySecretRef</code></br>
  6760. <em>
  6761. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6762. External Secrets meta/v1.SecretKeySelector
  6763. </a>
  6764. </em>
  6765. </td>
  6766. <td>
  6767. <em>(Optional)</em>
  6768. <p>The authorized key used for authentication</p>
  6769. </td>
  6770. </tr>
  6771. </tbody>
  6772. </table>
  6773. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">YandexCertificateManagerCAProvider
  6774. </h3>
  6775. <p>
  6776. (<em>Appears on:</em>
  6777. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  6778. </p>
  6779. <p>
  6780. </p>
  6781. <table>
  6782. <thead>
  6783. <tr>
  6784. <th>Field</th>
  6785. <th>Description</th>
  6786. </tr>
  6787. </thead>
  6788. <tbody>
  6789. <tr>
  6790. <td>
  6791. <code>certSecretRef</code></br>
  6792. <em>
  6793. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6794. External Secrets meta/v1.SecretKeySelector
  6795. </a>
  6796. </em>
  6797. </td>
  6798. <td>
  6799. </td>
  6800. </tr>
  6801. </tbody>
  6802. </table>
  6803. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider
  6804. </h3>
  6805. <p>
  6806. (<em>Appears on:</em>
  6807. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6808. </p>
  6809. <p>
  6810. <p>YandexCertificateManagerProvider Configures a store to sync secrets using the Yandex Certificate Manager provider.</p>
  6811. </p>
  6812. <table>
  6813. <thead>
  6814. <tr>
  6815. <th>Field</th>
  6816. <th>Description</th>
  6817. </tr>
  6818. </thead>
  6819. <tbody>
  6820. <tr>
  6821. <td>
  6822. <code>apiEndpoint</code></br>
  6823. <em>
  6824. string
  6825. </em>
  6826. </td>
  6827. <td>
  6828. <em>(Optional)</em>
  6829. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  6830. </td>
  6831. </tr>
  6832. <tr>
  6833. <td>
  6834. <code>auth</code></br>
  6835. <em>
  6836. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerAuth">
  6837. YandexCertificateManagerAuth
  6838. </a>
  6839. </em>
  6840. </td>
  6841. <td>
  6842. <p>Auth defines the information necessary to authenticate against Yandex Certificate Manager</p>
  6843. </td>
  6844. </tr>
  6845. <tr>
  6846. <td>
  6847. <code>caProvider</code></br>
  6848. <em>
  6849. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">
  6850. YandexCertificateManagerCAProvider
  6851. </a>
  6852. </em>
  6853. </td>
  6854. <td>
  6855. <em>(Optional)</em>
  6856. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  6857. </td>
  6858. </tr>
  6859. </tbody>
  6860. </table>
  6861. <h3 id="external-secrets.io/v1beta1.YandexLockboxAuth">YandexLockboxAuth
  6862. </h3>
  6863. <p>
  6864. (<em>Appears on:</em>
  6865. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  6866. </p>
  6867. <p>
  6868. </p>
  6869. <table>
  6870. <thead>
  6871. <tr>
  6872. <th>Field</th>
  6873. <th>Description</th>
  6874. </tr>
  6875. </thead>
  6876. <tbody>
  6877. <tr>
  6878. <td>
  6879. <code>authorizedKeySecretRef</code></br>
  6880. <em>
  6881. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6882. External Secrets meta/v1.SecretKeySelector
  6883. </a>
  6884. </em>
  6885. </td>
  6886. <td>
  6887. <em>(Optional)</em>
  6888. <p>The authorized key used for authentication</p>
  6889. </td>
  6890. </tr>
  6891. </tbody>
  6892. </table>
  6893. <h3 id="external-secrets.io/v1beta1.YandexLockboxCAProvider">YandexLockboxCAProvider
  6894. </h3>
  6895. <p>
  6896. (<em>Appears on:</em>
  6897. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  6898. </p>
  6899. <p>
  6900. </p>
  6901. <table>
  6902. <thead>
  6903. <tr>
  6904. <th>Field</th>
  6905. <th>Description</th>
  6906. </tr>
  6907. </thead>
  6908. <tbody>
  6909. <tr>
  6910. <td>
  6911. <code>certSecretRef</code></br>
  6912. <em>
  6913. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6914. External Secrets meta/v1.SecretKeySelector
  6915. </a>
  6916. </em>
  6917. </td>
  6918. <td>
  6919. </td>
  6920. </tr>
  6921. </tbody>
  6922. </table>
  6923. <h3 id="external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider
  6924. </h3>
  6925. <p>
  6926. (<em>Appears on:</em>
  6927. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6928. </p>
  6929. <p>
  6930. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
  6931. </p>
  6932. <table>
  6933. <thead>
  6934. <tr>
  6935. <th>Field</th>
  6936. <th>Description</th>
  6937. </tr>
  6938. </thead>
  6939. <tbody>
  6940. <tr>
  6941. <td>
  6942. <code>apiEndpoint</code></br>
  6943. <em>
  6944. string
  6945. </em>
  6946. </td>
  6947. <td>
  6948. <em>(Optional)</em>
  6949. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  6950. </td>
  6951. </tr>
  6952. <tr>
  6953. <td>
  6954. <code>auth</code></br>
  6955. <em>
  6956. <a href="#external-secrets.io/v1beta1.YandexLockboxAuth">
  6957. YandexLockboxAuth
  6958. </a>
  6959. </em>
  6960. </td>
  6961. <td>
  6962. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
  6963. </td>
  6964. </tr>
  6965. <tr>
  6966. <td>
  6967. <code>caProvider</code></br>
  6968. <em>
  6969. <a href="#external-secrets.io/v1beta1.YandexLockboxCAProvider">
  6970. YandexLockboxCAProvider
  6971. </a>
  6972. </em>
  6973. </td>
  6974. <td>
  6975. <em>(Optional)</em>
  6976. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  6977. </td>
  6978. </tr>
  6979. </tbody>
  6980. </table>
  6981. <hr/>
  6982. <p><em>
  6983. Generated with <code>gen-crd-api-reference-docs</code>.
  6984. </em></p>
  6985. </article>
  6986. </div>
  6987. </div>
  6988. </main>
  6989. <footer class="md-footer">
  6990. <nav class="md-footer__inner md-grid" aria-label="Footer">
  6991. <a href="../generator/fake/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Fake" rel="prev">
  6992. <div class="md-footer__button md-icon">
  6993. <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 11h12z"/></svg>
  6994. </div>
  6995. <div class="md-footer__title">
  6996. <div class="md-ellipsis">
  6997. <span class="md-footer__direction">
  6998. Previous
  6999. </span>
  7000. Fake
  7001. </div>
  7002. </div>
  7003. </a>
  7004. <a href="../controller-options/" class="md-footer__link md-footer__link--next" aria-label="Next: Controller Options" rel="next">
  7005. <div class="md-footer__title">
  7006. <div class="md-ellipsis">
  7007. <span class="md-footer__direction">
  7008. Next
  7009. </span>
  7010. Controller Options
  7011. </div>
  7012. </div>
  7013. <div class="md-footer__button md-icon">
  7014. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  7015. </div>
  7016. </a>
  7017. </nav>
  7018. <div class="md-footer-meta md-typeset">
  7019. <div class="md-footer-meta__inner md-grid">
  7020. <div class="md-copyright">
  7021. <div class="md-copyright__highlight">
  7022. &copy; 2022 The external-secrets Authors.<br/>
  7023. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  7024. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  7025. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  7026. </div>
  7027. Made with
  7028. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  7029. Material for MkDocs
  7030. </a>
  7031. </div>
  7032. </div>
  7033. </div>
  7034. </footer>
  7035. </div>
  7036. <div class="md-dialog" data-md-component="dialog">
  7037. <div class="md-dialog__inner md-typeset"></div>
  7038. </div>
  7039. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  7040. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  7041. </body>
  7042. </html>