index.html 148 KB

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