index.html 155 KB

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