index.html 162 KB

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