index.html 162 KB

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