index.html 148 KB

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