index.html 221 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313
  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="prev" href="../generator/webhook/">
  7. <link rel="next" href="../controller-options/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">
  10. <title>API specification - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.bcfcd587.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <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">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <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>
  16. <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>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. </div>
  25. <div data-md-component="announce">
  26. </div>
  27. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  28. <aside class="md-banner md-banner--warning">
  29. <div class="md-banner__inner md-grid md-typeset">
  30. You're not viewing the latest version.
  31. <a href="../../..">
  32. <strong>Click here to go to latest.</strong>
  33. </a>
  34. </div>
  35. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  36. </aside>
  37. </div>
  38. <header class="md-header" data-md-component="header">
  39. <nav class="md-header__inner md-grid" aria-label="Header">
  40. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  41. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  42. </a>
  43. <label class="md-header__button md-icon" for="__drawer">
  44. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  45. </label>
  46. <div class="md-header__title" data-md-component="header-title">
  47. <div class="md-header__ellipsis">
  48. <div class="md-header__topic">
  49. <span class="md-ellipsis">
  50. External Secrets Operator
  51. </span>
  52. </div>
  53. <div class="md-header__topic" data-md-component="header-topic">
  54. <span class="md-ellipsis">
  55. API specification
  56. </span>
  57. </div>
  58. </div>
  59. </div>
  60. <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>
  61. <label class="md-header__button md-icon" for="__search">
  62. <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>
  63. </label>
  64. <div class="md-search" data-md-component="search" role="dialog">
  65. <label class="md-search__overlay" for="__search"></label>
  66. <div class="md-search__inner" role="search">
  67. <form class="md-search__form" name="search">
  68. <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>
  69. <label class="md-search__icon md-icon" for="__search">
  70. <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>
  71. <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>
  72. </label>
  73. <nav class="md-search__options" aria-label="Search">
  74. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  75. <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>
  76. </button>
  77. </nav>
  78. </form>
  79. <div class="md-search__output">
  80. <div class="md-search__scrollwrap" data-md-scrollfix>
  81. <div class="md-search-result" data-md-component="search-result">
  82. <div class="md-search-result__meta">
  83. Initializing search
  84. </div>
  85. <ol class="md-search-result__list" role="presentation"></ol>
  86. </div>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. <div class="md-header__source">
  92. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  93. <div class="md-source__icon md-icon">
  94. <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>
  95. </div>
  96. <div class="md-source__repository">
  97. External Secrets Operator
  98. </div>
  99. </a>
  100. </div>
  101. </nav>
  102. </header>
  103. <div class="md-container" data-md-component="container">
  104. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  105. <div class="md-grid">
  106. <ul class="md-tabs__list">
  107. <li class="md-tabs__item">
  108. <a href="../.." class="md-tabs__link">
  109. Introduction
  110. </a>
  111. </li>
  112. <li class="md-tabs__item md-tabs__item--active">
  113. <a href="../components/" class="md-tabs__link">
  114. API
  115. </a>
  116. </li>
  117. <li class="md-tabs__item">
  118. <a href="../../guides/introduction/" class="md-tabs__link">
  119. Guides
  120. </a>
  121. </li>
  122. <li class="md-tabs__item">
  123. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  124. Provider
  125. </a>
  126. </li>
  127. <li class="md-tabs__item">
  128. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  129. Examples
  130. </a>
  131. </li>
  132. <li class="md-tabs__item">
  133. <a href="../../contributing/devguide/" class="md-tabs__link">
  134. Community
  135. </a>
  136. </li>
  137. <li class="md-tabs__item">
  138. <a href="../../spec/" class="md-tabs__link">
  139. References
  140. </a>
  141. </li>
  142. <li class="md-tabs__item">
  143. <a href="../../contributing-devguide.md" class="md-tabs__link">
  144. Contributing
  145. </a>
  146. </li>
  147. <li class="md-tabs__item">
  148. <a href="../../deprecation-policy.md" class="md-tabs__link">
  149. Deprecation Policy
  150. </a>
  151. </li>
  152. </ul>
  153. </div>
  154. </nav>
  155. <main class="md-main" data-md-component="main">
  156. <div class="md-main__inner md-grid">
  157. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  158. <div class="md-sidebar__scrollwrap">
  159. <div class="md-sidebar__inner">
  160. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  161. <label class="md-nav__title" for="__drawer">
  162. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  163. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  164. </a>
  165. External Secrets Operator
  166. </label>
  167. <div class="md-nav__source">
  168. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  169. <div class="md-source__icon md-icon">
  170. <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>
  171. </div>
  172. <div class="md-source__repository">
  173. External Secrets Operator
  174. </div>
  175. </a>
  176. </div>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item md-nav__item--nested">
  179. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  180. <div class="md-nav__link md-nav__container">
  181. <a href="../.." class="md-nav__link ">
  182. <span class="md-ellipsis">
  183. Introduction
  184. </span>
  185. </a>
  186. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  187. <span class="md-nav__icon md-icon"></span>
  188. </label>
  189. </div>
  190. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  191. <label class="md-nav__title" for="__nav_1">
  192. <span class="md-nav__icon md-icon"></span>
  193. Introduction
  194. </label>
  195. <ul class="md-nav__list" data-md-scrollfix>
  196. <li class="md-nav__item">
  197. <a href="../../introduction/overview/" class="md-nav__link">
  198. <span class="md-ellipsis">
  199. Overview
  200. </span>
  201. </a>
  202. </li>
  203. <li class="md-nav__item">
  204. <a href="../../introduction/getting-started/" class="md-nav__link">
  205. <span class="md-ellipsis">
  206. Getting started
  207. </span>
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../../introduction/faq/" class="md-nav__link">
  212. <span class="md-ellipsis">
  213. FAQ
  214. </span>
  215. </a>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="../../introduction/stability-support/" class="md-nav__link">
  219. <span class="md-ellipsis">
  220. Stability and Support
  221. </span>
  222. </a>
  223. </li>
  224. <li class="md-nav__item">
  225. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  226. <span class="md-ellipsis">
  227. Deprecation Policy
  228. </span>
  229. </a>
  230. </li>
  231. </ul>
  232. </nav>
  233. </li>
  234. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  235. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  236. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  237. <span class="md-ellipsis">
  238. API
  239. </span>
  240. <span class="md-nav__icon md-icon"></span>
  241. </label>
  242. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  243. <label class="md-nav__title" for="__nav_2">
  244. <span class="md-nav__icon md-icon"></span>
  245. API
  246. </label>
  247. <ul class="md-nav__list" data-md-scrollfix>
  248. <li class="md-nav__item">
  249. <a href="../components/" class="md-nav__link">
  250. <span class="md-ellipsis">
  251. Components
  252. </span>
  253. </a>
  254. </li>
  255. <li class="md-nav__item md-nav__item--nested">
  256. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  257. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  258. <span class="md-ellipsis">
  259. Core Resources
  260. </span>
  261. <span class="md-nav__icon md-icon"></span>
  262. </label>
  263. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  264. <label class="md-nav__title" for="__nav_2_2">
  265. <span class="md-nav__icon md-icon"></span>
  266. Core Resources
  267. </label>
  268. <ul class="md-nav__list" data-md-scrollfix>
  269. <li class="md-nav__item">
  270. <a href="../externalsecret/" class="md-nav__link">
  271. <span class="md-ellipsis">
  272. ExternalSecret
  273. </span>
  274. </a>
  275. </li>
  276. <li class="md-nav__item">
  277. <a href="../secretstore/" class="md-nav__link">
  278. <span class="md-ellipsis">
  279. SecretStore
  280. </span>
  281. </a>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="../clustersecretstore/" class="md-nav__link">
  285. <span class="md-ellipsis">
  286. ClusterSecretStore
  287. </span>
  288. </a>
  289. </li>
  290. <li class="md-nav__item">
  291. <a href="../clusterexternalsecret/" class="md-nav__link">
  292. <span class="md-ellipsis">
  293. ClusterExternalSecret
  294. </span>
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../pushsecret/" class="md-nav__link">
  299. <span class="md-ellipsis">
  300. PushSecret
  301. </span>
  302. </a>
  303. </li>
  304. </ul>
  305. </nav>
  306. </li>
  307. <li class="md-nav__item md-nav__item--nested">
  308. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  309. <div class="md-nav__link md-nav__container">
  310. <a href="../generator/" class="md-nav__link ">
  311. <span class="md-ellipsis">
  312. Generators
  313. </span>
  314. </a>
  315. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  316. <span class="md-nav__icon md-icon"></span>
  317. </label>
  318. </div>
  319. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  320. <label class="md-nav__title" for="__nav_2_3">
  321. <span class="md-nav__icon md-icon"></span>
  322. Generators
  323. </label>
  324. <ul class="md-nav__list" data-md-scrollfix>
  325. <li class="md-nav__item">
  326. <a href="../generator/acr/" class="md-nav__link">
  327. <span class="md-ellipsis">
  328. Azure Container Registry
  329. </span>
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../generator/ecr/" class="md-nav__link">
  334. <span class="md-ellipsis">
  335. AWS Elastic Container Registry
  336. </span>
  337. </a>
  338. </li>
  339. <li class="md-nav__item">
  340. <a href="../generator/gcr/" class="md-nav__link">
  341. <span class="md-ellipsis">
  342. Google Container Registry
  343. </span>
  344. </a>
  345. </li>
  346. <li class="md-nav__item">
  347. <a href="../generator/vault/" class="md-nav__link">
  348. <span class="md-ellipsis">
  349. Vault Dynamic Secret
  350. </span>
  351. </a>
  352. </li>
  353. <li class="md-nav__item">
  354. <a href="../generator/password/" class="md-nav__link">
  355. <span class="md-ellipsis">
  356. Password
  357. </span>
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="../generator/fake/" class="md-nav__link">
  362. <span class="md-ellipsis">
  363. Fake
  364. </span>
  365. </a>
  366. </li>
  367. <li class="md-nav__item">
  368. <a href="../generator/webhook/" class="md-nav__link">
  369. <span class="md-ellipsis">
  370. Webhook
  371. </span>
  372. </a>
  373. </li>
  374. </ul>
  375. </nav>
  376. </li>
  377. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  378. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" checked>
  379. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  380. <span class="md-ellipsis">
  381. Reference Docs
  382. </span>
  383. <span class="md-nav__icon md-icon"></span>
  384. </label>
  385. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="true">
  386. <label class="md-nav__title" for="__nav_2_4">
  387. <span class="md-nav__icon md-icon"></span>
  388. Reference Docs
  389. </label>
  390. <ul class="md-nav__list" data-md-scrollfix>
  391. <li class="md-nav__item md-nav__item--active">
  392. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  393. <a href="./" class="md-nav__link md-nav__link--active">
  394. <span class="md-ellipsis">
  395. API specification
  396. </span>
  397. </a>
  398. </li>
  399. <li class="md-nav__item">
  400. <a href="../controller-options/" class="md-nav__link">
  401. <span class="md-ellipsis">
  402. Controller Options
  403. </span>
  404. </a>
  405. </li>
  406. <li class="md-nav__item">
  407. <a href="../metrics/" class="md-nav__link">
  408. <span class="md-ellipsis">
  409. Metrics
  410. </span>
  411. </a>
  412. </li>
  413. </ul>
  414. </nav>
  415. </li>
  416. </ul>
  417. </nav>
  418. </li>
  419. <li class="md-nav__item md-nav__item--nested">
  420. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  421. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  422. <span class="md-ellipsis">
  423. Guides
  424. </span>
  425. <span class="md-nav__icon md-icon"></span>
  426. </label>
  427. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  428. <label class="md-nav__title" for="__nav_3">
  429. <span class="md-nav__icon md-icon"></span>
  430. Guides
  431. </label>
  432. <ul class="md-nav__list" data-md-scrollfix>
  433. <li class="md-nav__item">
  434. <a href="../../guides/introduction/" class="md-nav__link">
  435. <span class="md-ellipsis">
  436. Introduction
  437. </span>
  438. </a>
  439. </li>
  440. <li class="md-nav__item md-nav__item--nested">
  441. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  442. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  443. <span class="md-ellipsis">
  444. External Secrets
  445. </span>
  446. <span class="md-nav__icon md-icon"></span>
  447. </label>
  448. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  449. <label class="md-nav__title" for="__nav_3_2">
  450. <span class="md-nav__icon md-icon"></span>
  451. External Secrets
  452. </label>
  453. <ul class="md-nav__list" data-md-scrollfix>
  454. <li class="md-nav__item">
  455. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  456. <span class="md-ellipsis">
  457. Extract structured data
  458. </span>
  459. </a>
  460. </li>
  461. <li class="md-nav__item">
  462. <a href="../../guides/getallsecrets/" class="md-nav__link">
  463. <span class="md-ellipsis">
  464. Find Secrets by Name or Metadata
  465. </span>
  466. </a>
  467. </li>
  468. <li class="md-nav__item">
  469. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  470. <span class="md-ellipsis">
  471. Rewriting Keys
  472. </span>
  473. </a>
  474. </li>
  475. <li class="md-nav__item md-nav__item--nested">
  476. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  477. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  478. <span class="md-ellipsis">
  479. Advanced Templating
  480. </span>
  481. <span class="md-nav__icon md-icon"></span>
  482. </label>
  483. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  484. <label class="md-nav__title" for="__nav_3_2_4">
  485. <span class="md-nav__icon md-icon"></span>
  486. Advanced Templating
  487. </label>
  488. <ul class="md-nav__list" data-md-scrollfix>
  489. <li class="md-nav__item">
  490. <a href="../../guides/templating/" class="md-nav__link">
  491. <span class="md-ellipsis">
  492. v2
  493. </span>
  494. </a>
  495. </li>
  496. <li class="md-nav__item">
  497. <a href="../../guides/templating-v1/" class="md-nav__link">
  498. <span class="md-ellipsis">
  499. v1
  500. </span>
  501. </a>
  502. </li>
  503. </ul>
  504. </nav>
  505. </li>
  506. <li class="md-nav__item">
  507. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  508. <span class="md-ellipsis">
  509. Kubernetes Secret Types
  510. </span>
  511. </a>
  512. </li>
  513. <li class="md-nav__item">
  514. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  515. <span class="md-ellipsis">
  516. Lifecycle: ownership & deletion
  517. </span>
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  522. <span class="md-ellipsis">
  523. Decoding Strategies
  524. </span>
  525. </a>
  526. </li>
  527. <li class="md-nav__item">
  528. <a href="../../guides/controller-class/" class="md-nav__link">
  529. <span class="md-ellipsis">
  530. Controller Classes
  531. </span>
  532. </a>
  533. </li>
  534. </ul>
  535. </nav>
  536. </li>
  537. <li class="md-nav__item">
  538. <a href="../../guides/generator/" class="md-nav__link">
  539. <span class="md-ellipsis">
  540. Generators
  541. </span>
  542. </a>
  543. </li>
  544. <li class="md-nav__item">
  545. <a href="../../guides/pushsecrets/" class="md-nav__link">
  546. <span class="md-ellipsis">
  547. Push Secrets
  548. </span>
  549. </a>
  550. </li>
  551. <li class="md-nav__item md-nav__item--nested">
  552. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  553. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  554. <span class="md-ellipsis">
  555. Operations
  556. </span>
  557. <span class="md-nav__icon md-icon"></span>
  558. </label>
  559. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  560. <label class="md-nav__title" for="__nav_3_5">
  561. <span class="md-nav__icon md-icon"></span>
  562. Operations
  563. </label>
  564. <ul class="md-nav__list" data-md-scrollfix>
  565. <li class="md-nav__item">
  566. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  567. <span class="md-ellipsis">
  568. Multi Tenancy
  569. </span>
  570. </a>
  571. </li>
  572. <li class="md-nav__item">
  573. <a href="../../guides/security-best-practices/" class="md-nav__link">
  574. <span class="md-ellipsis">
  575. Security Best Practices
  576. </span>
  577. </a>
  578. </li>
  579. <li class="md-nav__item">
  580. <a href="../../guides/threat-model/" class="md-nav__link">
  581. <span class="md-ellipsis">
  582. Threat Model
  583. </span>
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../../guides/v1beta1/" class="md-nav__link">
  588. <span class="md-ellipsis">
  589. Upgrading to v1beta1
  590. </span>
  591. </a>
  592. </li>
  593. <li class="md-nav__item">
  594. <a href="../../guides/using-latest-image/" class="md-nav__link">
  595. <span class="md-ellipsis">
  596. Using Latest Image
  597. </span>
  598. </a>
  599. </li>
  600. <li class="md-nav__item">
  601. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  602. <span class="md-ellipsis">
  603. Disable Cluster Features
  604. </span>
  605. </a>
  606. </li>
  607. </ul>
  608. </nav>
  609. </li>
  610. </ul>
  611. </nav>
  612. </li>
  613. <li class="md-nav__item md-nav__item--nested">
  614. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  615. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  616. <span class="md-ellipsis">
  617. Provider
  618. </span>
  619. <span class="md-nav__icon md-icon"></span>
  620. </label>
  621. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  622. <label class="md-nav__title" for="__nav_4">
  623. <span class="md-nav__icon md-icon"></span>
  624. Provider
  625. </label>
  626. <ul class="md-nav__list" data-md-scrollfix>
  627. <li class="md-nav__item">
  628. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  629. <span class="md-ellipsis">
  630. AWS Secrets Manager
  631. </span>
  632. </a>
  633. </li>
  634. <li class="md-nav__item">
  635. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  636. <span class="md-ellipsis">
  637. AWS Parameter Store
  638. </span>
  639. </a>
  640. </li>
  641. <li class="md-nav__item">
  642. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  643. <span class="md-ellipsis">
  644. Azure Key Vault
  645. </span>
  646. </a>
  647. </li>
  648. <li class="md-nav__item">
  649. <a href="../../provider/chef/" class="md-nav__link">
  650. <span class="md-ellipsis">
  651. Chef
  652. </span>
  653. </a>
  654. </li>
  655. <li class="md-nav__item">
  656. <a href="../../provider/conjur/" class="md-nav__link">
  657. <span class="md-ellipsis">
  658. CyberArk Conjur
  659. </span>
  660. </a>
  661. </li>
  662. <li class="md-nav__item">
  663. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  664. <span class="md-ellipsis">
  665. Google Cloud Secret Manager
  666. </span>
  667. </a>
  668. </li>
  669. <li class="md-nav__item">
  670. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  671. <span class="md-ellipsis">
  672. HashiCorp Vault
  673. </span>
  674. </a>
  675. </li>
  676. <li class="md-nav__item">
  677. <a href="../../provider/kubernetes/" class="md-nav__link">
  678. <span class="md-ellipsis">
  679. Kubernetes
  680. </span>
  681. </a>
  682. </li>
  683. <li class="md-nav__item">
  684. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  685. <span class="md-ellipsis">
  686. IBM Secrets Manager
  687. </span>
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="../../provider/akeyless/" class="md-nav__link">
  692. <span class="md-ellipsis">
  693. Akeyless
  694. </span>
  695. </a>
  696. </li>
  697. <li class="md-nav__item">
  698. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  699. <span class="md-ellipsis">
  700. Yandex Certificate Manager
  701. </span>
  702. </a>
  703. </li>
  704. <li class="md-nav__item">
  705. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  706. <span class="md-ellipsis">
  707. Yandex Lockbox
  708. </span>
  709. </a>
  710. </li>
  711. <li class="md-nav__item">
  712. <a href="../../provider/alibaba/" class="md-nav__link">
  713. <span class="md-ellipsis">
  714. Alibaba Cloud
  715. </span>
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  720. <span class="md-ellipsis">
  721. GitLab Variables
  722. </span>
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="../../provider/oracle-vault/" class="md-nav__link">
  727. <span class="md-ellipsis">
  728. Oracle Vault
  729. </span>
  730. </a>
  731. </li>
  732. <li class="md-nav__item">
  733. <a href="../../provider/1password-automation/" class="md-nav__link">
  734. <span class="md-ellipsis">
  735. 1Password Secrets Automation
  736. </span>
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="../../provider/webhook/" class="md-nav__link">
  741. <span class="md-ellipsis">
  742. Webhook
  743. </span>
  744. </a>
  745. </li>
  746. <li class="md-nav__item">
  747. <a href="../../provider/fake/" class="md-nav__link">
  748. <span class="md-ellipsis">
  749. Fake
  750. </span>
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. senhasegura DevOps Secrets Management (DSM)
  757. </span>
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="../../provider/doppler/" class="md-nav__link">
  762. <span class="md-ellipsis">
  763. Doppler
  764. </span>
  765. </a>
  766. </li>
  767. <li class="md-nav__item">
  768. <a href="../../provider/keeper-security/" class="md-nav__link">
  769. <span class="md-ellipsis">
  770. Keeper Security
  771. </span>
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="../../provider/cloak/" class="md-nav__link">
  776. <span class="md-ellipsis">
  777. Cloak End 2 End Encrypted Secrets
  778. </span>
  779. </a>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="../../provider/scaleway/" class="md-nav__link">
  783. <span class="md-ellipsis">
  784. Scaleway
  785. </span>
  786. </a>
  787. </li>
  788. <li class="md-nav__item">
  789. <a href="../../provider/delinea/" class="md-nav__link">
  790. <span class="md-ellipsis">
  791. Delinea
  792. </span>
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="../../provider/pulumi/" class="md-nav__link">
  797. <span class="md-ellipsis">
  798. Pulumi ESC
  799. </span>
  800. </a>
  801. </li>
  802. <li class="md-nav__item">
  803. <a href="../../provider/onboardbase/" class="md-nav__link">
  804. <span class="md-ellipsis">
  805. Onboardbase
  806. </span>
  807. </a>
  808. </li>
  809. </ul>
  810. </nav>
  811. </li>
  812. <li class="md-nav__item md-nav__item--nested">
  813. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  814. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  815. <span class="md-ellipsis">
  816. Examples
  817. </span>
  818. <span class="md-nav__icon md-icon"></span>
  819. </label>
  820. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  821. <label class="md-nav__title" for="__nav_5">
  822. <span class="md-nav__icon md-icon"></span>
  823. Examples
  824. </label>
  825. <ul class="md-nav__list" data-md-scrollfix>
  826. <li class="md-nav__item">
  827. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  828. <span class="md-ellipsis">
  829. FluxCD
  830. </span>
  831. </a>
  832. </li>
  833. <li class="md-nav__item">
  834. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  835. <span class="md-ellipsis">
  836. Anchore Engine
  837. </span>
  838. </a>
  839. </li>
  840. <li class="md-nav__item">
  841. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  842. <span class="md-ellipsis">
  843. Jenkins
  844. </span>
  845. </a>
  846. </li>
  847. <li class="md-nav__item">
  848. <a href="../../examples/bitwarden/" class="md-nav__link">
  849. <span class="md-ellipsis">
  850. BitWarden
  851. </span>
  852. </a>
  853. </li>
  854. </ul>
  855. </nav>
  856. </li>
  857. <li class="md-nav__item md-nav__item--nested">
  858. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  859. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  860. <span class="md-ellipsis">
  861. Community
  862. </span>
  863. <span class="md-nav__icon md-icon"></span>
  864. </label>
  865. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  866. <label class="md-nav__title" for="__nav_6">
  867. <span class="md-nav__icon md-icon"></span>
  868. Community
  869. </label>
  870. <ul class="md-nav__list" data-md-scrollfix>
  871. <li class="md-nav__item md-nav__item--nested">
  872. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  873. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  874. <span class="md-ellipsis">
  875. Contributing
  876. </span>
  877. <span class="md-nav__icon md-icon"></span>
  878. </label>
  879. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  880. <label class="md-nav__title" for="__nav_6_1">
  881. <span class="md-nav__icon md-icon"></span>
  882. Contributing
  883. </label>
  884. <ul class="md-nav__list" data-md-scrollfix>
  885. <li class="md-nav__item">
  886. <a href="../../contributing/devguide/" class="md-nav__link">
  887. <span class="md-ellipsis">
  888. Developer guide
  889. </span>
  890. </a>
  891. </li>
  892. <li class="md-nav__item">
  893. <a href="../../contributing/process/" class="md-nav__link">
  894. <span class="md-ellipsis">
  895. Contributing Process
  896. </span>
  897. </a>
  898. </li>
  899. <li class="md-nav__item">
  900. <a href="../../contributing/release/" class="md-nav__link">
  901. <span class="md-ellipsis">
  902. Release Process
  903. </span>
  904. </a>
  905. </li>
  906. <li class="md-nav__item">
  907. <a href="../../contributing/coc/" class="md-nav__link">
  908. <span class="md-ellipsis">
  909. Code of Conduct
  910. </span>
  911. </a>
  912. </li>
  913. <li class="md-nav__item">
  914. <a href="../../contributing/roadmap/" class="md-nav__link">
  915. <span class="md-ellipsis">
  916. Roadmap
  917. </span>
  918. </a>
  919. </li>
  920. </ul>
  921. </nav>
  922. </li>
  923. <li class="md-nav__item md-nav__item--nested">
  924. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  925. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  926. <span class="md-ellipsis">
  927. External Resources
  928. </span>
  929. <span class="md-nav__icon md-icon"></span>
  930. </label>
  931. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  932. <label class="md-nav__title" for="__nav_6_2">
  933. <span class="md-nav__icon md-icon"></span>
  934. External Resources
  935. </label>
  936. <ul class="md-nav__list" data-md-scrollfix>
  937. <li class="md-nav__item">
  938. <a href="../../eso-talks/" class="md-nav__link">
  939. <span class="md-ellipsis">
  940. Talks
  941. </span>
  942. </a>
  943. </li>
  944. <li class="md-nav__item">
  945. <a href="../../eso-demos/" class="md-nav__link">
  946. <span class="md-ellipsis">
  947. Demos
  948. </span>
  949. </a>
  950. </li>
  951. <li class="md-nav__item">
  952. <a href="../../eso-blogs/" class="md-nav__link">
  953. <span class="md-ellipsis">
  954. Blogs
  955. </span>
  956. </a>
  957. </li>
  958. </ul>
  959. </nav>
  960. </li>
  961. <li class="md-nav__item md-nav__item--nested">
  962. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_3" >
  963. <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
  964. <span class="md-ellipsis">
  965. AWS
  966. </span>
  967. <span class="md-nav__icon md-icon"></span>
  968. </label>
  969. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
  970. <label class="md-nav__title" for="__nav_6_3">
  971. <span class="md-nav__icon md-icon"></span>
  972. AWS
  973. </label>
  974. <ul class="md-nav__list" data-md-scrollfix>
  975. <li class="md-nav__item">
  976. <a href="../../provider-aws-secrets-manager.md" class="md-nav__link">
  977. <span class="md-ellipsis">
  978. Secrets Manager
  979. </span>
  980. </a>
  981. </li>
  982. <li class="md-nav__item">
  983. <a href="../../provider-aws-parameter-store.md" class="md-nav__link">
  984. <span class="md-ellipsis">
  985. Parameter Store
  986. </span>
  987. </a>
  988. </li>
  989. </ul>
  990. </nav>
  991. </li>
  992. <li class="md-nav__item md-nav__item--nested">
  993. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_4" >
  994. <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
  995. <span class="md-ellipsis">
  996. Azure
  997. </span>
  998. <span class="md-nav__icon md-icon"></span>
  999. </label>
  1000. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
  1001. <label class="md-nav__title" for="__nav_6_4">
  1002. <span class="md-nav__icon md-icon"></span>
  1003. Azure
  1004. </label>
  1005. <ul class="md-nav__list" data-md-scrollfix>
  1006. <li class="md-nav__item">
  1007. <a href="../../provider-azure-key-vault.md" class="md-nav__link">
  1008. <span class="md-ellipsis">
  1009. Key Vault
  1010. </span>
  1011. </a>
  1012. </li>
  1013. </ul>
  1014. </nav>
  1015. </li>
  1016. <li class="md-nav__item md-nav__item--nested">
  1017. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_5" >
  1018. <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
  1019. <span class="md-ellipsis">
  1020. Google
  1021. </span>
  1022. <span class="md-nav__icon md-icon"></span>
  1023. </label>
  1024. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
  1025. <label class="md-nav__title" for="__nav_6_5">
  1026. <span class="md-nav__icon md-icon"></span>
  1027. Google
  1028. </label>
  1029. <ul class="md-nav__list" data-md-scrollfix>
  1030. <li class="md-nav__item">
  1031. <a href="../../provider-google-secrets-manager.md" class="md-nav__link">
  1032. <span class="md-ellipsis">
  1033. Secrets Manager
  1034. </span>
  1035. </a>
  1036. </li>
  1037. </ul>
  1038. </nav>
  1039. </li>
  1040. <li class="md-nav__item md-nav__item--nested">
  1041. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_6" >
  1042. <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
  1043. <span class="md-ellipsis">
  1044. IBM
  1045. </span>
  1046. <span class="md-nav__icon md-icon"></span>
  1047. </label>
  1048. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
  1049. <label class="md-nav__title" for="__nav_6_6">
  1050. <span class="md-nav__icon md-icon"></span>
  1051. IBM
  1052. </label>
  1053. <ul class="md-nav__list" data-md-scrollfix>
  1054. <li class="md-nav__item">
  1055. <a href="../../provider-ibm-secrets-manager.md" class="md-nav__link">
  1056. <span class="md-ellipsis">
  1057. Secrets Manager
  1058. </span>
  1059. </a>
  1060. </li>
  1061. </ul>
  1062. </nav>
  1063. </li>
  1064. <li class="md-nav__item">
  1065. <a href="../../provider-hashicorp-vault.md" class="md-nav__link">
  1066. <span class="md-ellipsis">
  1067. HashiCorp Vault
  1068. </span>
  1069. </a>
  1070. </li>
  1071. <li class="md-nav__item md-nav__item--nested">
  1072. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_8" >
  1073. <label class="md-nav__link" for="__nav_6_8" id="__nav_6_8_label" tabindex="0">
  1074. <span class="md-ellipsis">
  1075. Yandex
  1076. </span>
  1077. <span class="md-nav__icon md-icon"></span>
  1078. </label>
  1079. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_8_label" aria-expanded="false">
  1080. <label class="md-nav__title" for="__nav_6_8">
  1081. <span class="md-nav__icon md-icon"></span>
  1082. Yandex
  1083. </label>
  1084. <ul class="md-nav__list" data-md-scrollfix>
  1085. <li class="md-nav__item">
  1086. <a href="../../provider-yandex-lockbox.md" class="md-nav__link">
  1087. <span class="md-ellipsis">
  1088. Lockbox
  1089. </span>
  1090. </a>
  1091. </li>
  1092. </ul>
  1093. </nav>
  1094. </li>
  1095. <li class="md-nav__item">
  1096. <a href="../../provider-passworddepot/" class="md-nav__link">
  1097. <span class="md-ellipsis">
  1098. Password Depot
  1099. </span>
  1100. </a>
  1101. </li>
  1102. <li class="md-nav__item md-nav__item--nested">
  1103. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_10" >
  1104. <label class="md-nav__link" for="__nav_6_10" id="__nav_6_10_label" tabindex="0">
  1105. <span class="md-ellipsis">
  1106. Gitlab
  1107. </span>
  1108. <span class="md-nav__icon md-icon"></span>
  1109. </label>
  1110. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_10_label" aria-expanded="false">
  1111. <label class="md-nav__title" for="__nav_6_10">
  1112. <span class="md-nav__icon md-icon"></span>
  1113. Gitlab
  1114. </label>
  1115. <ul class="md-nav__list" data-md-scrollfix>
  1116. <li class="md-nav__item">
  1117. <a href="../../provider-gitlab-project-variables.md" class="md-nav__link">
  1118. <span class="md-ellipsis">
  1119. Gitlab Project Variables
  1120. </span>
  1121. </a>
  1122. </li>
  1123. </ul>
  1124. </nav>
  1125. </li>
  1126. <li class="md-nav__item md-nav__item--nested">
  1127. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_11" >
  1128. <label class="md-nav__link" for="__nav_6_11" id="__nav_6_11_label" tabindex="0">
  1129. <span class="md-ellipsis">
  1130. Oracle
  1131. </span>
  1132. <span class="md-nav__icon md-icon"></span>
  1133. </label>
  1134. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_11_label" aria-expanded="false">
  1135. <label class="md-nav__title" for="__nav_6_11">
  1136. <span class="md-nav__icon md-icon"></span>
  1137. Oracle
  1138. </label>
  1139. <ul class="md-nav__list" data-md-scrollfix>
  1140. <li class="md-nav__item">
  1141. <a href="../../provider-oracle-vault.md" class="md-nav__link">
  1142. <span class="md-ellipsis">
  1143. Oracle Vault
  1144. </span>
  1145. </a>
  1146. </li>
  1147. </ul>
  1148. </nav>
  1149. </li>
  1150. </ul>
  1151. </nav>
  1152. </li>
  1153. <li class="md-nav__item md-nav__item--nested">
  1154. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1155. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1156. <span class="md-ellipsis">
  1157. References
  1158. </span>
  1159. <span class="md-nav__icon md-icon"></span>
  1160. </label>
  1161. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1162. <label class="md-nav__title" for="__nav_7">
  1163. <span class="md-nav__icon md-icon"></span>
  1164. References
  1165. </label>
  1166. <ul class="md-nav__list" data-md-scrollfix>
  1167. <li class="md-nav__item">
  1168. <a href="../../spec/" class="md-nav__link">
  1169. <span class="md-ellipsis">
  1170. API specification
  1171. </span>
  1172. </a>
  1173. </li>
  1174. </ul>
  1175. </nav>
  1176. </li>
  1177. <li class="md-nav__item md-nav__item--nested">
  1178. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
  1179. <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
  1180. <span class="md-ellipsis">
  1181. Contributing
  1182. </span>
  1183. <span class="md-nav__icon md-icon"></span>
  1184. </label>
  1185. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
  1186. <label class="md-nav__title" for="__nav_8">
  1187. <span class="md-nav__icon md-icon"></span>
  1188. Contributing
  1189. </label>
  1190. <ul class="md-nav__list" data-md-scrollfix>
  1191. <li class="md-nav__item">
  1192. <a href="../../contributing-devguide.md" class="md-nav__link">
  1193. <span class="md-ellipsis">
  1194. Developer guide
  1195. </span>
  1196. </a>
  1197. </li>
  1198. <li class="md-nav__item">
  1199. <a href="../../contributing-process.md" class="md-nav__link">
  1200. <span class="md-ellipsis">
  1201. Contributing Process
  1202. </span>
  1203. </a>
  1204. </li>
  1205. <li class="md-nav__item">
  1206. <a href="../../contributing-coc.md" class="md-nav__link">
  1207. <span class="md-ellipsis">
  1208. Code of Conduct
  1209. </span>
  1210. </a>
  1211. </li>
  1212. </ul>
  1213. </nav>
  1214. </li>
  1215. <li class="md-nav__item">
  1216. <a href="../../deprecation-policy.md" class="md-nav__link">
  1217. <span class="md-ellipsis">
  1218. Deprecation Policy
  1219. </span>
  1220. </a>
  1221. </li>
  1222. </ul>
  1223. </nav>
  1224. </div>
  1225. </div>
  1226. </div>
  1227. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1228. <div class="md-sidebar__scrollwrap">
  1229. <div class="md-sidebar__inner">
  1230. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1231. </nav>
  1232. </div>
  1233. </div>
  1234. </div>
  1235. <div class="md-content" data-md-component="content">
  1236. <article class="md-content__inner md-typeset">
  1237. <h1>API specification</h1>
  1238. <p>Packages:</p>
  1239. <ul>
  1240. <li>
  1241. <a href="#external-secrets.io%2fv1beta1">external-secrets.io/v1beta1</a>
  1242. </li>
  1243. </ul>
  1244. <h2 id="external-secrets.io/v1beta1">external-secrets.io/v1beta1</h2>
  1245. <p>
  1246. <p>Package v1beta1 contains resources for external-secrets</p>
  1247. </p>
  1248. <p>Resource Types:</p>
  1249. <ul></ul>
  1250. <h3 id="external-secrets.io/v1beta1.AWSAuth">AWSAuth
  1251. </h3>
  1252. <p>
  1253. (<em>Appears on:</em>
  1254. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  1255. </p>
  1256. <p>
  1257. <p>AWSAuth tells the controller how to do authentication with aws.
  1258. Only one of secretRef or jwt can be specified.
  1259. if none is specified the controller will load credentials using the aws sdk defaults.</p>
  1260. </p>
  1261. <table>
  1262. <thead>
  1263. <tr>
  1264. <th>Field</th>
  1265. <th>Description</th>
  1266. </tr>
  1267. </thead>
  1268. <tbody>
  1269. <tr>
  1270. <td>
  1271. <code>secretRef</code></br>
  1272. <em>
  1273. <a href="#external-secrets.io/v1beta1.AWSAuthSecretRef">
  1274. AWSAuthSecretRef
  1275. </a>
  1276. </em>
  1277. </td>
  1278. <td>
  1279. <em>(Optional)</em>
  1280. </td>
  1281. </tr>
  1282. <tr>
  1283. <td>
  1284. <code>jwt</code></br>
  1285. <em>
  1286. <a href="#external-secrets.io/v1beta1.AWSJWTAuth">
  1287. AWSJWTAuth
  1288. </a>
  1289. </em>
  1290. </td>
  1291. <td>
  1292. <em>(Optional)</em>
  1293. </td>
  1294. </tr>
  1295. </tbody>
  1296. </table>
  1297. <h3 id="external-secrets.io/v1beta1.AWSAuthSecretRef">AWSAuthSecretRef
  1298. </h3>
  1299. <p>
  1300. (<em>Appears on:</em>
  1301. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  1302. </p>
  1303. <p>
  1304. <p>AWSAuthSecretRef holds secret references for AWS credentials
  1305. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  1306. </p>
  1307. <table>
  1308. <thead>
  1309. <tr>
  1310. <th>Field</th>
  1311. <th>Description</th>
  1312. </tr>
  1313. </thead>
  1314. <tbody>
  1315. <tr>
  1316. <td>
  1317. <code>accessKeyIDSecretRef</code></br>
  1318. <em>
  1319. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1320. External Secrets meta/v1.SecretKeySelector
  1321. </a>
  1322. </em>
  1323. </td>
  1324. <td>
  1325. <p>The AccessKeyID is used for authentication</p>
  1326. </td>
  1327. </tr>
  1328. <tr>
  1329. <td>
  1330. <code>secretAccessKeySecretRef</code></br>
  1331. <em>
  1332. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1333. External Secrets meta/v1.SecretKeySelector
  1334. </a>
  1335. </em>
  1336. </td>
  1337. <td>
  1338. <p>The SecretAccessKey is used for authentication</p>
  1339. </td>
  1340. </tr>
  1341. <tr>
  1342. <td>
  1343. <code>sessionTokenSecretRef</code></br>
  1344. <em>
  1345. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1346. External Secrets meta/v1.SecretKeySelector
  1347. </a>
  1348. </em>
  1349. </td>
  1350. <td>
  1351. <p>The SessionToken used for authentication
  1352. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  1353. 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>
  1354. </td>
  1355. </tr>
  1356. </tbody>
  1357. </table>
  1358. <h3 id="external-secrets.io/v1beta1.AWSJWTAuth">AWSJWTAuth
  1359. </h3>
  1360. <p>
  1361. (<em>Appears on:</em>
  1362. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  1363. </p>
  1364. <p>
  1365. <p>Authenticate against AWS using service account tokens.</p>
  1366. </p>
  1367. <table>
  1368. <thead>
  1369. <tr>
  1370. <th>Field</th>
  1371. <th>Description</th>
  1372. </tr>
  1373. </thead>
  1374. <tbody>
  1375. <tr>
  1376. <td>
  1377. <code>serviceAccountRef</code></br>
  1378. <em>
  1379. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  1380. External Secrets meta/v1.ServiceAccountSelector
  1381. </a>
  1382. </em>
  1383. </td>
  1384. <td>
  1385. </td>
  1386. </tr>
  1387. </tbody>
  1388. </table>
  1389. <h3 id="external-secrets.io/v1beta1.AWSProvider">AWSProvider
  1390. </h3>
  1391. <p>
  1392. (<em>Appears on:</em>
  1393. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1394. </p>
  1395. <p>
  1396. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  1397. </p>
  1398. <table>
  1399. <thead>
  1400. <tr>
  1401. <th>Field</th>
  1402. <th>Description</th>
  1403. </tr>
  1404. </thead>
  1405. <tbody>
  1406. <tr>
  1407. <td>
  1408. <code>service</code></br>
  1409. <em>
  1410. <a href="#external-secrets.io/v1beta1.AWSServiceType">
  1411. AWSServiceType
  1412. </a>
  1413. </em>
  1414. </td>
  1415. <td>
  1416. <p>Service defines which service should be used to fetch the secrets</p>
  1417. </td>
  1418. </tr>
  1419. <tr>
  1420. <td>
  1421. <code>auth</code></br>
  1422. <em>
  1423. <a href="#external-secrets.io/v1beta1.AWSAuth">
  1424. AWSAuth
  1425. </a>
  1426. </em>
  1427. </td>
  1428. <td>
  1429. <em>(Optional)</em>
  1430. <p>Auth defines the information necessary to authenticate against AWS
  1431. if not set aws sdk will infer credentials from your environment
  1432. 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>
  1433. </td>
  1434. </tr>
  1435. <tr>
  1436. <td>
  1437. <code>role</code></br>
  1438. <em>
  1439. string
  1440. </em>
  1441. </td>
  1442. <td>
  1443. <em>(Optional)</em>
  1444. <p>Role is a Role ARN which the provider will assume</p>
  1445. </td>
  1446. </tr>
  1447. <tr>
  1448. <td>
  1449. <code>region</code></br>
  1450. <em>
  1451. string
  1452. </em>
  1453. </td>
  1454. <td>
  1455. <p>AWS Region to be used for the provider</p>
  1456. </td>
  1457. </tr>
  1458. <tr>
  1459. <td>
  1460. <code>additionalRoles</code></br>
  1461. <em>
  1462. []string
  1463. </em>
  1464. </td>
  1465. <td>
  1466. <em>(Optional)</em>
  1467. <p>AdditionalRoles is a chained list of Role ARNs which the provider will sequentially assume before assuming the Role</p>
  1468. </td>
  1469. </tr>
  1470. <tr>
  1471. <td>
  1472. <code>externalID</code></br>
  1473. <em>
  1474. string
  1475. </em>
  1476. </td>
  1477. <td>
  1478. <p>AWS External ID set on assumed IAM roles</p>
  1479. </td>
  1480. </tr>
  1481. <tr>
  1482. <td>
  1483. <code>sessionTags</code></br>
  1484. <em>
  1485. <a href="#external-secrets.io/v1beta1.*github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1.Tag">
  1486. []*github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1.Tag
  1487. </a>
  1488. </em>
  1489. </td>
  1490. <td>
  1491. <em>(Optional)</em>
  1492. <p>AWS STS assume role session tags</p>
  1493. </td>
  1494. </tr>
  1495. <tr>
  1496. <td>
  1497. <code>secretsManager</code></br>
  1498. <em>
  1499. <a href="#external-secrets.io/v1beta1.SecretsManager">
  1500. SecretsManager
  1501. </a>
  1502. </em>
  1503. </td>
  1504. <td>
  1505. <em>(Optional)</em>
  1506. <p>SecretsManager defines how the provider behaves when interacting with AWS SecretsManager</p>
  1507. </td>
  1508. </tr>
  1509. <tr>
  1510. <td>
  1511. <code>transitiveTagKeys</code></br>
  1512. <em>
  1513. []*string
  1514. </em>
  1515. </td>
  1516. <td>
  1517. <em>(Optional)</em>
  1518. <p>AWS STS assume role transitive session tags. Required when multiple rules are used with the provider</p>
  1519. </td>
  1520. </tr>
  1521. </tbody>
  1522. </table>
  1523. <h3 id="external-secrets.io/v1beta1.AWSServiceType">AWSServiceType
  1524. (<code>string</code> alias)</p></h3>
  1525. <p>
  1526. (<em>Appears on:</em>
  1527. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  1528. </p>
  1529. <p>
  1530. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  1531. </p>
  1532. <table>
  1533. <thead>
  1534. <tr>
  1535. <th>Value</th>
  1536. <th>Description</th>
  1537. </tr>
  1538. </thead>
  1539. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  1540. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore service.
  1541. 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>
  1542. </td>
  1543. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  1544. <td><p>AWSServiceSecretsManager is the AWS SecretsManager service.
  1545. 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>
  1546. </td>
  1547. </tr></tbody>
  1548. </table>
  1549. <h3 id="external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth
  1550. </h3>
  1551. <p>
  1552. (<em>Appears on:</em>
  1553. <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>)
  1554. </p>
  1555. <p>
  1556. </p>
  1557. <table>
  1558. <thead>
  1559. <tr>
  1560. <th>Field</th>
  1561. <th>Description</th>
  1562. </tr>
  1563. </thead>
  1564. <tbody>
  1565. <tr>
  1566. <td>
  1567. <code>secretRef</code></br>
  1568. <em>
  1569. <a href="#external-secrets.io/v1beta1.AkeylessAuthSecretRef">
  1570. AkeylessAuthSecretRef
  1571. </a>
  1572. </em>
  1573. </td>
  1574. <td>
  1575. <em>(Optional)</em>
  1576. <p>Reference to a Secret that contains the details
  1577. to authenticate with Akeyless.</p>
  1578. </td>
  1579. </tr>
  1580. <tr>
  1581. <td>
  1582. <code>kubernetesAuth</code></br>
  1583. <em>
  1584. <a href="#external-secrets.io/v1beta1.AkeylessKubernetesAuth">
  1585. AkeylessKubernetesAuth
  1586. </a>
  1587. </em>
  1588. </td>
  1589. <td>
  1590. <em>(Optional)</em>
  1591. <p>Kubernetes authenticates with Akeyless by passing the ServiceAccount
  1592. token stored in the named Secret resource.</p>
  1593. </td>
  1594. </tr>
  1595. </tbody>
  1596. </table>
  1597. <h3 id="external-secrets.io/v1beta1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
  1598. </h3>
  1599. <p>
  1600. (<em>Appears on:</em>
  1601. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  1602. </p>
  1603. <p>
  1604. <p>AkeylessAuthSecretRef
  1605. AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
  1606. </p>
  1607. <table>
  1608. <thead>
  1609. <tr>
  1610. <th>Field</th>
  1611. <th>Description</th>
  1612. </tr>
  1613. </thead>
  1614. <tbody>
  1615. <tr>
  1616. <td>
  1617. <code>accessID</code></br>
  1618. <em>
  1619. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1620. External Secrets meta/v1.SecretKeySelector
  1621. </a>
  1622. </em>
  1623. </td>
  1624. <td>
  1625. <p>The SecretAccessID is used for authentication</p>
  1626. </td>
  1627. </tr>
  1628. <tr>
  1629. <td>
  1630. <code>accessType</code></br>
  1631. <em>
  1632. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1633. External Secrets meta/v1.SecretKeySelector
  1634. </a>
  1635. </em>
  1636. </td>
  1637. <td>
  1638. </td>
  1639. </tr>
  1640. <tr>
  1641. <td>
  1642. <code>accessTypeParam</code></br>
  1643. <em>
  1644. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1645. External Secrets meta/v1.SecretKeySelector
  1646. </a>
  1647. </em>
  1648. </td>
  1649. <td>
  1650. </td>
  1651. </tr>
  1652. </tbody>
  1653. </table>
  1654. <h3 id="external-secrets.io/v1beta1.AkeylessKubernetesAuth">AkeylessKubernetesAuth
  1655. </h3>
  1656. <p>
  1657. (<em>Appears on:</em>
  1658. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  1659. </p>
  1660. <p>
  1661. <p>Authenticate with Kubernetes ServiceAccount token stored.</p>
  1662. </p>
  1663. <table>
  1664. <thead>
  1665. <tr>
  1666. <th>Field</th>
  1667. <th>Description</th>
  1668. </tr>
  1669. </thead>
  1670. <tbody>
  1671. <tr>
  1672. <td>
  1673. <code>accessID</code></br>
  1674. <em>
  1675. string
  1676. </em>
  1677. </td>
  1678. <td>
  1679. <p>the Akeyless Kubernetes auth-method access-id</p>
  1680. </td>
  1681. </tr>
  1682. <tr>
  1683. <td>
  1684. <code>k8sConfName</code></br>
  1685. <em>
  1686. string
  1687. </em>
  1688. </td>
  1689. <td>
  1690. <p>Kubernetes-auth configuration name in Akeyless-Gateway</p>
  1691. </td>
  1692. </tr>
  1693. <tr>
  1694. <td>
  1695. <code>serviceAccountRef</code></br>
  1696. <em>
  1697. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  1698. External Secrets meta/v1.ServiceAccountSelector
  1699. </a>
  1700. </em>
  1701. </td>
  1702. <td>
  1703. <em>(Optional)</em>
  1704. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  1705. If the service account is specified, the service account secret token JWT will be used
  1706. for authenticating with Akeyless. If the service account selector is not supplied,
  1707. the secretRef will be used instead.</p>
  1708. </td>
  1709. </tr>
  1710. <tr>
  1711. <td>
  1712. <code>secretRef</code></br>
  1713. <em>
  1714. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1715. External Secrets meta/v1.SecretKeySelector
  1716. </a>
  1717. </em>
  1718. </td>
  1719. <td>
  1720. <em>(Optional)</em>
  1721. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  1722. for authenticating with Akeyless. If a name is specified without a key,
  1723. <code>token</code> is the default. If one is not specified, the one bound to
  1724. the controller will be used.</p>
  1725. </td>
  1726. </tr>
  1727. </tbody>
  1728. </table>
  1729. <h3 id="external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider
  1730. </h3>
  1731. <p>
  1732. (<em>Appears on:</em>
  1733. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1734. </p>
  1735. <p>
  1736. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  1737. </p>
  1738. <table>
  1739. <thead>
  1740. <tr>
  1741. <th>Field</th>
  1742. <th>Description</th>
  1743. </tr>
  1744. </thead>
  1745. <tbody>
  1746. <tr>
  1747. <td>
  1748. <code>akeylessGWApiURL</code></br>
  1749. <em>
  1750. string
  1751. </em>
  1752. </td>
  1753. <td>
  1754. <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
  1755. </td>
  1756. </tr>
  1757. <tr>
  1758. <td>
  1759. <code>authSecretRef</code></br>
  1760. <em>
  1761. <a href="#external-secrets.io/v1beta1.AkeylessAuth">
  1762. AkeylessAuth
  1763. </a>
  1764. </em>
  1765. </td>
  1766. <td>
  1767. <p>Auth configures how the operator authenticates with Akeyless.</p>
  1768. </td>
  1769. </tr>
  1770. <tr>
  1771. <td>
  1772. <code>caBundle</code></br>
  1773. <em>
  1774. []byte
  1775. </em>
  1776. </td>
  1777. <td>
  1778. <em>(Optional)</em>
  1779. <p>PEM/base64 encoded CA bundle used to validate Akeyless Gateway certificate. Only used
  1780. if the AkeylessGWApiURL URL is using HTTPS protocol. If not set the system root certificates
  1781. are used to validate the TLS connection.</p>
  1782. </td>
  1783. </tr>
  1784. <tr>
  1785. <td>
  1786. <code>caProvider</code></br>
  1787. <em>
  1788. <a href="#external-secrets.io/v1beta1.CAProvider">
  1789. CAProvider
  1790. </a>
  1791. </em>
  1792. </td>
  1793. <td>
  1794. <em>(Optional)</em>
  1795. <p>The provider for the CA bundle to use to validate Akeyless Gateway certificate.</p>
  1796. </td>
  1797. </tr>
  1798. </tbody>
  1799. </table>
  1800. <h3 id="external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth
  1801. </h3>
  1802. <p>
  1803. (<em>Appears on:</em>
  1804. <a href="#external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider</a>)
  1805. </p>
  1806. <p>
  1807. <p>AlibabaAuth contains a secretRef for credentials.</p>
  1808. </p>
  1809. <table>
  1810. <thead>
  1811. <tr>
  1812. <th>Field</th>
  1813. <th>Description</th>
  1814. </tr>
  1815. </thead>
  1816. <tbody>
  1817. <tr>
  1818. <td>
  1819. <code>secretRef</code></br>
  1820. <em>
  1821. <a href="#external-secrets.io/v1beta1.AlibabaAuthSecretRef">
  1822. AlibabaAuthSecretRef
  1823. </a>
  1824. </em>
  1825. </td>
  1826. <td>
  1827. <em>(Optional)</em>
  1828. </td>
  1829. </tr>
  1830. <tr>
  1831. <td>
  1832. <code>rrsa</code></br>
  1833. <em>
  1834. <a href="#external-secrets.io/v1beta1.AlibabaRRSAAuth">
  1835. AlibabaRRSAAuth
  1836. </a>
  1837. </em>
  1838. </td>
  1839. <td>
  1840. <em>(Optional)</em>
  1841. </td>
  1842. </tr>
  1843. </tbody>
  1844. </table>
  1845. <h3 id="external-secrets.io/v1beta1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
  1846. </h3>
  1847. <p>
  1848. (<em>Appears on:</em>
  1849. <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
  1850. </p>
  1851. <p>
  1852. <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
  1853. </p>
  1854. <table>
  1855. <thead>
  1856. <tr>
  1857. <th>Field</th>
  1858. <th>Description</th>
  1859. </tr>
  1860. </thead>
  1861. <tbody>
  1862. <tr>
  1863. <td>
  1864. <code>accessKeyIDSecretRef</code></br>
  1865. <em>
  1866. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1867. External Secrets meta/v1.SecretKeySelector
  1868. </a>
  1869. </em>
  1870. </td>
  1871. <td>
  1872. <p>The AccessKeyID is used for authentication</p>
  1873. </td>
  1874. </tr>
  1875. <tr>
  1876. <td>
  1877. <code>accessKeySecretSecretRef</code></br>
  1878. <em>
  1879. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1880. External Secrets meta/v1.SecretKeySelector
  1881. </a>
  1882. </em>
  1883. </td>
  1884. <td>
  1885. <p>The AccessKeySecret is used for authentication</p>
  1886. </td>
  1887. </tr>
  1888. </tbody>
  1889. </table>
  1890. <h3 id="external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider
  1891. </h3>
  1892. <p>
  1893. (<em>Appears on:</em>
  1894. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1895. </p>
  1896. <p>
  1897. <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
  1898. </p>
  1899. <table>
  1900. <thead>
  1901. <tr>
  1902. <th>Field</th>
  1903. <th>Description</th>
  1904. </tr>
  1905. </thead>
  1906. <tbody>
  1907. <tr>
  1908. <td>
  1909. <code>auth</code></br>
  1910. <em>
  1911. <a href="#external-secrets.io/v1beta1.AlibabaAuth">
  1912. AlibabaAuth
  1913. </a>
  1914. </em>
  1915. </td>
  1916. <td>
  1917. </td>
  1918. </tr>
  1919. <tr>
  1920. <td>
  1921. <code>regionID</code></br>
  1922. <em>
  1923. string
  1924. </em>
  1925. </td>
  1926. <td>
  1927. <p>Alibaba Region to be used for the provider</p>
  1928. </td>
  1929. </tr>
  1930. </tbody>
  1931. </table>
  1932. <h3 id="external-secrets.io/v1beta1.AlibabaRRSAAuth">AlibabaRRSAAuth
  1933. </h3>
  1934. <p>
  1935. (<em>Appears on:</em>
  1936. <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
  1937. </p>
  1938. <p>
  1939. <p>Authenticate against Alibaba using RRSA.</p>
  1940. </p>
  1941. <table>
  1942. <thead>
  1943. <tr>
  1944. <th>Field</th>
  1945. <th>Description</th>
  1946. </tr>
  1947. </thead>
  1948. <tbody>
  1949. <tr>
  1950. <td>
  1951. <code>oidcProviderArn</code></br>
  1952. <em>
  1953. string
  1954. </em>
  1955. </td>
  1956. <td>
  1957. </td>
  1958. </tr>
  1959. <tr>
  1960. <td>
  1961. <code>oidcTokenFilePath</code></br>
  1962. <em>
  1963. string
  1964. </em>
  1965. </td>
  1966. <td>
  1967. </td>
  1968. </tr>
  1969. <tr>
  1970. <td>
  1971. <code>roleArn</code></br>
  1972. <em>
  1973. string
  1974. </em>
  1975. </td>
  1976. <td>
  1977. </td>
  1978. </tr>
  1979. <tr>
  1980. <td>
  1981. <code>sessionName</code></br>
  1982. <em>
  1983. string
  1984. </em>
  1985. </td>
  1986. <td>
  1987. </td>
  1988. </tr>
  1989. </tbody>
  1990. </table>
  1991. <h3 id="external-secrets.io/v1beta1.AzureAuthType">AzureAuthType
  1992. (<code>string</code> alias)</p></h3>
  1993. <p>
  1994. (<em>Appears on:</em>
  1995. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1996. </p>
  1997. <p>
  1998. <p>AuthType describes how to authenticate to the Azure Keyvault
  1999. Only one of the following auth types may be specified.
  2000. If none of the following auth type is specified, the default one
  2001. is ServicePrincipal.</p>
  2002. </p>
  2003. <table>
  2004. <thead>
  2005. <tr>
  2006. <th>Value</th>
  2007. <th>Description</th>
  2008. </tr>
  2009. </thead>
  2010. <tbody><tr><td><p>&#34;ManagedIdentity&#34;</p></td>
  2011. <td><p>Using Managed Identity to authenticate. Used with aad-pod-identity installed in the cluster.</p>
  2012. </td>
  2013. </tr><tr><td><p>&#34;ServicePrincipal&#34;</p></td>
  2014. <td><p>Using service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.</p>
  2015. </td>
  2016. </tr><tr><td><p>&#34;WorkloadIdentity&#34;</p></td>
  2017. <td><p>Using Workload Identity service accounts to authenticate.</p>
  2018. </td>
  2019. </tr></tbody>
  2020. </table>
  2021. <h3 id="external-secrets.io/v1beta1.AzureEnvironmentType">AzureEnvironmentType
  2022. (<code>string</code> alias)</p></h3>
  2023. <p>
  2024. (<em>Appears on:</em>
  2025. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  2026. </p>
  2027. <p>
  2028. <p>AzureEnvironmentType specifies the Azure cloud environment endpoints to use for
  2029. connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
  2030. 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>
  2031. PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
  2032. </p>
  2033. <table>
  2034. <thead>
  2035. <tr>
  2036. <th>Value</th>
  2037. <th>Description</th>
  2038. </tr>
  2039. </thead>
  2040. <tbody><tr><td><p>&#34;ChinaCloud&#34;</p></td>
  2041. <td></td>
  2042. </tr><tr><td><p>&#34;GermanCloud&#34;</p></td>
  2043. <td></td>
  2044. </tr><tr><td><p>&#34;PublicCloud&#34;</p></td>
  2045. <td></td>
  2046. </tr><tr><td><p>&#34;USGovernmentCloud&#34;</p></td>
  2047. <td></td>
  2048. </tr></tbody>
  2049. </table>
  2050. <h3 id="external-secrets.io/v1beta1.AzureKVAuth">AzureKVAuth
  2051. </h3>
  2052. <p>
  2053. (<em>Appears on:</em>
  2054. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  2055. </p>
  2056. <p>
  2057. <p>Configuration used to authenticate with Azure.</p>
  2058. </p>
  2059. <table>
  2060. <thead>
  2061. <tr>
  2062. <th>Field</th>
  2063. <th>Description</th>
  2064. </tr>
  2065. </thead>
  2066. <tbody>
  2067. <tr>
  2068. <td>
  2069. <code>clientId</code></br>
  2070. <em>
  2071. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2072. External Secrets meta/v1.SecretKeySelector
  2073. </a>
  2074. </em>
  2075. </td>
  2076. <td>
  2077. <em>(Optional)</em>
  2078. <p>The Azure clientId of the service principle used for authentication.</p>
  2079. </td>
  2080. </tr>
  2081. <tr>
  2082. <td>
  2083. <code>clientSecret</code></br>
  2084. <em>
  2085. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2086. External Secrets meta/v1.SecretKeySelector
  2087. </a>
  2088. </em>
  2089. </td>
  2090. <td>
  2091. <em>(Optional)</em>
  2092. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  2093. </td>
  2094. </tr>
  2095. </tbody>
  2096. </table>
  2097. <h3 id="external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider
  2098. </h3>
  2099. <p>
  2100. (<em>Appears on:</em>
  2101. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2102. </p>
  2103. <p>
  2104. <p>Configures an store to sync secrets using Azure KV.</p>
  2105. </p>
  2106. <table>
  2107. <thead>
  2108. <tr>
  2109. <th>Field</th>
  2110. <th>Description</th>
  2111. </tr>
  2112. </thead>
  2113. <tbody>
  2114. <tr>
  2115. <td>
  2116. <code>authType</code></br>
  2117. <em>
  2118. <a href="#external-secrets.io/v1beta1.AzureAuthType">
  2119. AzureAuthType
  2120. </a>
  2121. </em>
  2122. </td>
  2123. <td>
  2124. <em>(Optional)</em>
  2125. <p>Auth type defines how to authenticate to the keyvault service.
  2126. Valid values are:
  2127. - &ldquo;ServicePrincipal&rdquo; (default): Using a service principal (tenantId, clientId, clientSecret)
  2128. - &ldquo;ManagedIdentity&rdquo;: Using Managed Identity assigned to the pod (see aad-pod-identity)</p>
  2129. </td>
  2130. </tr>
  2131. <tr>
  2132. <td>
  2133. <code>vaultUrl</code></br>
  2134. <em>
  2135. string
  2136. </em>
  2137. </td>
  2138. <td>
  2139. <p>Vault Url from which the secrets to be fetched from.</p>
  2140. </td>
  2141. </tr>
  2142. <tr>
  2143. <td>
  2144. <code>tenantId</code></br>
  2145. <em>
  2146. string
  2147. </em>
  2148. </td>
  2149. <td>
  2150. <em>(Optional)</em>
  2151. <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type.</p>
  2152. </td>
  2153. </tr>
  2154. <tr>
  2155. <td>
  2156. <code>environmentType</code></br>
  2157. <em>
  2158. <a href="#external-secrets.io/v1beta1.AzureEnvironmentType">
  2159. AzureEnvironmentType
  2160. </a>
  2161. </em>
  2162. </td>
  2163. <td>
  2164. <p>EnvironmentType specifies the Azure cloud environment endpoints to use for
  2165. connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
  2166. 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>
  2167. PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
  2168. </td>
  2169. </tr>
  2170. <tr>
  2171. <td>
  2172. <code>authSecretRef</code></br>
  2173. <em>
  2174. <a href="#external-secrets.io/v1beta1.AzureKVAuth">
  2175. AzureKVAuth
  2176. </a>
  2177. </em>
  2178. </td>
  2179. <td>
  2180. <em>(Optional)</em>
  2181. <p>Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type.</p>
  2182. </td>
  2183. </tr>
  2184. <tr>
  2185. <td>
  2186. <code>serviceAccountRef</code></br>
  2187. <em>
  2188. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  2189. External Secrets meta/v1.ServiceAccountSelector
  2190. </a>
  2191. </em>
  2192. </td>
  2193. <td>
  2194. <em>(Optional)</em>
  2195. <p>ServiceAccountRef specified the service account
  2196. that should be used when authenticating with WorkloadIdentity.</p>
  2197. </td>
  2198. </tr>
  2199. <tr>
  2200. <td>
  2201. <code>identityId</code></br>
  2202. <em>
  2203. string
  2204. </em>
  2205. </td>
  2206. <td>
  2207. <em>(Optional)</em>
  2208. <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
  2209. </td>
  2210. </tr>
  2211. </tbody>
  2212. </table>
  2213. <h3 id="external-secrets.io/v1beta1.CAProvider">CAProvider
  2214. </h3>
  2215. <p>
  2216. (<em>Appears on:</em>
  2217. <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>,
  2218. <a href="#external-secrets.io/v1beta1.ConjurProvider">ConjurProvider</a>,
  2219. <a href="#external-secrets.io/v1beta1.KubernetesServer">KubernetesServer</a>,
  2220. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  2221. </p>
  2222. <p>
  2223. <p>Used to provide custom certificate authority (CA) certificates
  2224. for a secret store. The CAProvider points to a Secret or ConfigMap resource
  2225. that contains a PEM-encoded certificate.</p>
  2226. </p>
  2227. <table>
  2228. <thead>
  2229. <tr>
  2230. <th>Field</th>
  2231. <th>Description</th>
  2232. </tr>
  2233. </thead>
  2234. <tbody>
  2235. <tr>
  2236. <td>
  2237. <code>type</code></br>
  2238. <em>
  2239. <a href="#external-secrets.io/v1beta1.CAProviderType">
  2240. CAProviderType
  2241. </a>
  2242. </em>
  2243. </td>
  2244. <td>
  2245. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  2246. </td>
  2247. </tr>
  2248. <tr>
  2249. <td>
  2250. <code>name</code></br>
  2251. <em>
  2252. string
  2253. </em>
  2254. </td>
  2255. <td>
  2256. <p>The name of the object located at the provider type.</p>
  2257. </td>
  2258. </tr>
  2259. <tr>
  2260. <td>
  2261. <code>key</code></br>
  2262. <em>
  2263. string
  2264. </em>
  2265. </td>
  2266. <td>
  2267. <p>The key where the CA certificate can be found in the Secret or ConfigMap.</p>
  2268. </td>
  2269. </tr>
  2270. <tr>
  2271. <td>
  2272. <code>namespace</code></br>
  2273. <em>
  2274. string
  2275. </em>
  2276. </td>
  2277. <td>
  2278. <em>(Optional)</em>
  2279. <p>The namespace the Provider type is in.
  2280. Can only be defined when used in a ClusterSecretStore.</p>
  2281. </td>
  2282. </tr>
  2283. </tbody>
  2284. </table>
  2285. <h3 id="external-secrets.io/v1beta1.CAProviderType">CAProviderType
  2286. (<code>string</code> alias)</p></h3>
  2287. <p>
  2288. (<em>Appears on:</em>
  2289. <a href="#external-secrets.io/v1beta1.CAProvider">CAProvider</a>)
  2290. </p>
  2291. <p>
  2292. </p>
  2293. <table>
  2294. <thead>
  2295. <tr>
  2296. <th>Value</th>
  2297. <th>Description</th>
  2298. </tr>
  2299. </thead>
  2300. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  2301. <td></td>
  2302. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  2303. <td></td>
  2304. </tr></tbody>
  2305. </table>
  2306. <h3 id="external-secrets.io/v1beta1.CertAuth">CertAuth
  2307. </h3>
  2308. <p>
  2309. (<em>Appears on:</em>
  2310. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  2311. </p>
  2312. <p>
  2313. </p>
  2314. <table>
  2315. <thead>
  2316. <tr>
  2317. <th>Field</th>
  2318. <th>Description</th>
  2319. </tr>
  2320. </thead>
  2321. <tbody>
  2322. <tr>
  2323. <td>
  2324. <code>clientCert</code></br>
  2325. <em>
  2326. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2327. External Secrets meta/v1.SecretKeySelector
  2328. </a>
  2329. </em>
  2330. </td>
  2331. <td>
  2332. </td>
  2333. </tr>
  2334. <tr>
  2335. <td>
  2336. <code>clientKey</code></br>
  2337. <em>
  2338. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2339. External Secrets meta/v1.SecretKeySelector
  2340. </a>
  2341. </em>
  2342. </td>
  2343. <td>
  2344. </td>
  2345. </tr>
  2346. </tbody>
  2347. </table>
  2348. <h3 id="external-secrets.io/v1beta1.ChefAuth">ChefAuth
  2349. </h3>
  2350. <p>
  2351. (<em>Appears on:</em>
  2352. <a href="#external-secrets.io/v1beta1.ChefProvider">ChefProvider</a>)
  2353. </p>
  2354. <p>
  2355. <p>ChefAuth contains a secretRef for credentials.</p>
  2356. </p>
  2357. <table>
  2358. <thead>
  2359. <tr>
  2360. <th>Field</th>
  2361. <th>Description</th>
  2362. </tr>
  2363. </thead>
  2364. <tbody>
  2365. <tr>
  2366. <td>
  2367. <code>secretRef</code></br>
  2368. <em>
  2369. <a href="#external-secrets.io/v1beta1.ChefAuthSecretRef">
  2370. ChefAuthSecretRef
  2371. </a>
  2372. </em>
  2373. </td>
  2374. <td>
  2375. </td>
  2376. </tr>
  2377. </tbody>
  2378. </table>
  2379. <h3 id="external-secrets.io/v1beta1.ChefAuthSecretRef">ChefAuthSecretRef
  2380. </h3>
  2381. <p>
  2382. (<em>Appears on:</em>
  2383. <a href="#external-secrets.io/v1beta1.ChefAuth">ChefAuth</a>)
  2384. </p>
  2385. <p>
  2386. <p>ChefAuthSecretRef holds secret references for chef server login credentials.</p>
  2387. </p>
  2388. <table>
  2389. <thead>
  2390. <tr>
  2391. <th>Field</th>
  2392. <th>Description</th>
  2393. </tr>
  2394. </thead>
  2395. <tbody>
  2396. <tr>
  2397. <td>
  2398. <code>privateKeySecretRef</code></br>
  2399. <em>
  2400. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2401. External Secrets meta/v1.SecretKeySelector
  2402. </a>
  2403. </em>
  2404. </td>
  2405. <td>
  2406. <p>SecretKey is the Signing Key in PEM format, used for authentication.</p>
  2407. </td>
  2408. </tr>
  2409. </tbody>
  2410. </table>
  2411. <h3 id="external-secrets.io/v1beta1.ChefProvider">ChefProvider
  2412. </h3>
  2413. <p>
  2414. (<em>Appears on:</em>
  2415. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2416. </p>
  2417. <p>
  2418. <p>ChefProvider configures a store to sync secrets using basic chef server connection credentials.</p>
  2419. </p>
  2420. <table>
  2421. <thead>
  2422. <tr>
  2423. <th>Field</th>
  2424. <th>Description</th>
  2425. </tr>
  2426. </thead>
  2427. <tbody>
  2428. <tr>
  2429. <td>
  2430. <code>auth</code></br>
  2431. <em>
  2432. <a href="#external-secrets.io/v1beta1.ChefAuth">
  2433. ChefAuth
  2434. </a>
  2435. </em>
  2436. </td>
  2437. <td>
  2438. <p>Auth defines the information necessary to authenticate against chef Server</p>
  2439. </td>
  2440. </tr>
  2441. <tr>
  2442. <td>
  2443. <code>username</code></br>
  2444. <em>
  2445. string
  2446. </em>
  2447. </td>
  2448. <td>
  2449. <p>UserName should be the user ID on the chef server</p>
  2450. </td>
  2451. </tr>
  2452. <tr>
  2453. <td>
  2454. <code>serverUrl</code></br>
  2455. <em>
  2456. string
  2457. </em>
  2458. </td>
  2459. <td>
  2460. <p>ServerURL is the chef server URL used to connect to. If using orgs you should include your org in the url and terminate the url with a &ldquo;/&rdquo;</p>
  2461. </td>
  2462. </tr>
  2463. </tbody>
  2464. </table>
  2465. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret
  2466. </h3>
  2467. <p>
  2468. <p>ClusterExternalSecret is the Schema for the clusterexternalsecrets API.</p>
  2469. </p>
  2470. <table>
  2471. <thead>
  2472. <tr>
  2473. <th>Field</th>
  2474. <th>Description</th>
  2475. </tr>
  2476. </thead>
  2477. <tbody>
  2478. <tr>
  2479. <td>
  2480. <code>metadata</code></br>
  2481. <em>
  2482. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  2483. Kubernetes meta/v1.ObjectMeta
  2484. </a>
  2485. </em>
  2486. </td>
  2487. <td>
  2488. Refer to the Kubernetes API documentation for the fields of the
  2489. <code>metadata</code> field.
  2490. </td>
  2491. </tr>
  2492. <tr>
  2493. <td>
  2494. <code>spec</code></br>
  2495. <em>
  2496. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">
  2497. ClusterExternalSecretSpec
  2498. </a>
  2499. </em>
  2500. </td>
  2501. <td>
  2502. <br/>
  2503. <br/>
  2504. <table>
  2505. <tr>
  2506. <td>
  2507. <code>externalSecretSpec</code></br>
  2508. <em>
  2509. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  2510. ExternalSecretSpec
  2511. </a>
  2512. </em>
  2513. </td>
  2514. <td>
  2515. <p>The spec for the ExternalSecrets to be created</p>
  2516. </td>
  2517. </tr>
  2518. <tr>
  2519. <td>
  2520. <code>externalSecretName</code></br>
  2521. <em>
  2522. string
  2523. </em>
  2524. </td>
  2525. <td>
  2526. <em>(Optional)</em>
  2527. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  2528. </td>
  2529. </tr>
  2530. <tr>
  2531. <td>
  2532. <code>externalSecretMetadata</code></br>
  2533. <em>
  2534. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadata">
  2535. ExternalSecretMetadata
  2536. </a>
  2537. </em>
  2538. </td>
  2539. <td>
  2540. <em>(Optional)</em>
  2541. <p>The metadata of the external secrets to be created</p>
  2542. </td>
  2543. </tr>
  2544. <tr>
  2545. <td>
  2546. <code>namespaceSelector</code></br>
  2547. <em>
  2548. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  2549. Kubernetes meta/v1.LabelSelector
  2550. </a>
  2551. </em>
  2552. </td>
  2553. <td>
  2554. <em>(Optional)</em>
  2555. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.
  2556. Deprecated: Use NamespaceSelectors instead.</p>
  2557. </td>
  2558. </tr>
  2559. <tr>
  2560. <td>
  2561. <code>namespaceSelectors</code></br>
  2562. <em>
  2563. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#*k8s.io/apimachinery/pkg/apis/meta/v1.labelselector--">
  2564. []*k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector
  2565. </a>
  2566. </em>
  2567. </td>
  2568. <td>
  2569. <em>(Optional)</em>
  2570. <p>A list of labels to select by to find the Namespaces to create the ExternalSecrets in. The selectors are ORed.</p>
  2571. </td>
  2572. </tr>
  2573. <tr>
  2574. <td>
  2575. <code>namespaces</code></br>
  2576. <em>
  2577. []string
  2578. </em>
  2579. </td>
  2580. <td>
  2581. <em>(Optional)</em>
  2582. <p>Choose namespaces by name. This field is ORed with anything that NamespaceSelector ends up choosing.</p>
  2583. </td>
  2584. </tr>
  2585. <tr>
  2586. <td>
  2587. <code>refreshTime</code></br>
  2588. <em>
  2589. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  2590. Kubernetes meta/v1.Duration
  2591. </a>
  2592. </em>
  2593. </td>
  2594. <td>
  2595. <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
  2596. </td>
  2597. </tr>
  2598. </table>
  2599. </td>
  2600. </tr>
  2601. <tr>
  2602. <td>
  2603. <code>status</code></br>
  2604. <em>
  2605. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">
  2606. ClusterExternalSecretStatus
  2607. </a>
  2608. </em>
  2609. </td>
  2610. <td>
  2611. </td>
  2612. </tr>
  2613. </tbody>
  2614. </table>
  2615. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretConditionType">ClusterExternalSecretConditionType
  2616. (<code>string</code> alias)</p></h3>
  2617. <p>
  2618. (<em>Appears on:</em>
  2619. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition</a>)
  2620. </p>
  2621. <p>
  2622. </p>
  2623. <table>
  2624. <thead>
  2625. <tr>
  2626. <th>Value</th>
  2627. <th>Description</th>
  2628. </tr>
  2629. </thead>
  2630. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  2631. <td></td>
  2632. </tr></tbody>
  2633. </table>
  2634. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">ClusterExternalSecretNamespaceFailure
  2635. </h3>
  2636. <p>
  2637. (<em>Appears on:</em>
  2638. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  2639. </p>
  2640. <p>
  2641. <p>ClusterExternalSecretNamespaceFailure represents a failed namespace deployment and it&rsquo;s reason.</p>
  2642. </p>
  2643. <table>
  2644. <thead>
  2645. <tr>
  2646. <th>Field</th>
  2647. <th>Description</th>
  2648. </tr>
  2649. </thead>
  2650. <tbody>
  2651. <tr>
  2652. <td>
  2653. <code>namespace</code></br>
  2654. <em>
  2655. string
  2656. </em>
  2657. </td>
  2658. <td>
  2659. <p>Namespace is the namespace that failed when trying to apply an ExternalSecret</p>
  2660. </td>
  2661. </tr>
  2662. <tr>
  2663. <td>
  2664. <code>reason</code></br>
  2665. <em>
  2666. string
  2667. </em>
  2668. </td>
  2669. <td>
  2670. <em>(Optional)</em>
  2671. <p>Reason is why the ExternalSecret failed to apply to the namespace</p>
  2672. </td>
  2673. </tr>
  2674. </tbody>
  2675. </table>
  2676. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec
  2677. </h3>
  2678. <p>
  2679. (<em>Appears on:</em>
  2680. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  2681. </p>
  2682. <p>
  2683. <p>ClusterExternalSecretSpec defines the desired state of ClusterExternalSecret.</p>
  2684. </p>
  2685. <table>
  2686. <thead>
  2687. <tr>
  2688. <th>Field</th>
  2689. <th>Description</th>
  2690. </tr>
  2691. </thead>
  2692. <tbody>
  2693. <tr>
  2694. <td>
  2695. <code>externalSecretSpec</code></br>
  2696. <em>
  2697. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  2698. ExternalSecretSpec
  2699. </a>
  2700. </em>
  2701. </td>
  2702. <td>
  2703. <p>The spec for the ExternalSecrets to be created</p>
  2704. </td>
  2705. </tr>
  2706. <tr>
  2707. <td>
  2708. <code>externalSecretName</code></br>
  2709. <em>
  2710. string
  2711. </em>
  2712. </td>
  2713. <td>
  2714. <em>(Optional)</em>
  2715. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  2716. </td>
  2717. </tr>
  2718. <tr>
  2719. <td>
  2720. <code>externalSecretMetadata</code></br>
  2721. <em>
  2722. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadata">
  2723. ExternalSecretMetadata
  2724. </a>
  2725. </em>
  2726. </td>
  2727. <td>
  2728. <em>(Optional)</em>
  2729. <p>The metadata of the external secrets to be created</p>
  2730. </td>
  2731. </tr>
  2732. <tr>
  2733. <td>
  2734. <code>namespaceSelector</code></br>
  2735. <em>
  2736. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  2737. Kubernetes meta/v1.LabelSelector
  2738. </a>
  2739. </em>
  2740. </td>
  2741. <td>
  2742. <em>(Optional)</em>
  2743. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.
  2744. Deprecated: Use NamespaceSelectors instead.</p>
  2745. </td>
  2746. </tr>
  2747. <tr>
  2748. <td>
  2749. <code>namespaceSelectors</code></br>
  2750. <em>
  2751. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#*k8s.io/apimachinery/pkg/apis/meta/v1.labelselector--">
  2752. []*k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector
  2753. </a>
  2754. </em>
  2755. </td>
  2756. <td>
  2757. <em>(Optional)</em>
  2758. <p>A list of labels to select by to find the Namespaces to create the ExternalSecrets in. The selectors are ORed.</p>
  2759. </td>
  2760. </tr>
  2761. <tr>
  2762. <td>
  2763. <code>namespaces</code></br>
  2764. <em>
  2765. []string
  2766. </em>
  2767. </td>
  2768. <td>
  2769. <em>(Optional)</em>
  2770. <p>Choose namespaces by name. This field is ORed with anything that NamespaceSelector ends up choosing.</p>
  2771. </td>
  2772. </tr>
  2773. <tr>
  2774. <td>
  2775. <code>refreshTime</code></br>
  2776. <em>
  2777. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  2778. Kubernetes meta/v1.Duration
  2779. </a>
  2780. </em>
  2781. </td>
  2782. <td>
  2783. <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
  2784. </td>
  2785. </tr>
  2786. </tbody>
  2787. </table>
  2788. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus
  2789. </h3>
  2790. <p>
  2791. (<em>Appears on:</em>
  2792. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  2793. </p>
  2794. <p>
  2795. <p>ClusterExternalSecretStatus defines the observed state of ClusterExternalSecret.</p>
  2796. </p>
  2797. <table>
  2798. <thead>
  2799. <tr>
  2800. <th>Field</th>
  2801. <th>Description</th>
  2802. </tr>
  2803. </thead>
  2804. <tbody>
  2805. <tr>
  2806. <td>
  2807. <code>externalSecretName</code></br>
  2808. <em>
  2809. string
  2810. </em>
  2811. </td>
  2812. <td>
  2813. <p>ExternalSecretName is the name of the ExternalSecrets created by the ClusterExternalSecret</p>
  2814. </td>
  2815. </tr>
  2816. <tr>
  2817. <td>
  2818. <code>failedNamespaces</code></br>
  2819. <em>
  2820. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">
  2821. []ClusterExternalSecretNamespaceFailure
  2822. </a>
  2823. </em>
  2824. </td>
  2825. <td>
  2826. <em>(Optional)</em>
  2827. <p>Failed namespaces are the namespaces that failed to apply an ExternalSecret</p>
  2828. </td>
  2829. </tr>
  2830. <tr>
  2831. <td>
  2832. <code>provisionedNamespaces</code></br>
  2833. <em>
  2834. []string
  2835. </em>
  2836. </td>
  2837. <td>
  2838. <em>(Optional)</em>
  2839. <p>ProvisionedNamespaces are the namespaces where the ClusterExternalSecret has secrets</p>
  2840. </td>
  2841. </tr>
  2842. <tr>
  2843. <td>
  2844. <code>conditions</code></br>
  2845. <em>
  2846. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">
  2847. []ClusterExternalSecretStatusCondition
  2848. </a>
  2849. </em>
  2850. </td>
  2851. <td>
  2852. <em>(Optional)</em>
  2853. </td>
  2854. </tr>
  2855. </tbody>
  2856. </table>
  2857. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition
  2858. </h3>
  2859. <p>
  2860. (<em>Appears on:</em>
  2861. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  2862. </p>
  2863. <p>
  2864. </p>
  2865. <table>
  2866. <thead>
  2867. <tr>
  2868. <th>Field</th>
  2869. <th>Description</th>
  2870. </tr>
  2871. </thead>
  2872. <tbody>
  2873. <tr>
  2874. <td>
  2875. <code>type</code></br>
  2876. <em>
  2877. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretConditionType">
  2878. ClusterExternalSecretConditionType
  2879. </a>
  2880. </em>
  2881. </td>
  2882. <td>
  2883. </td>
  2884. </tr>
  2885. <tr>
  2886. <td>
  2887. <code>status</code></br>
  2888. <em>
  2889. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  2890. Kubernetes core/v1.ConditionStatus
  2891. </a>
  2892. </em>
  2893. </td>
  2894. <td>
  2895. </td>
  2896. </tr>
  2897. <tr>
  2898. <td>
  2899. <code>message</code></br>
  2900. <em>
  2901. string
  2902. </em>
  2903. </td>
  2904. <td>
  2905. <em>(Optional)</em>
  2906. </td>
  2907. </tr>
  2908. </tbody>
  2909. </table>
  2910. <h3 id="external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore
  2911. </h3>
  2912. <p>
  2913. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  2914. </p>
  2915. <table>
  2916. <thead>
  2917. <tr>
  2918. <th>Field</th>
  2919. <th>Description</th>
  2920. </tr>
  2921. </thead>
  2922. <tbody>
  2923. <tr>
  2924. <td>
  2925. <code>metadata</code></br>
  2926. <em>
  2927. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  2928. Kubernetes meta/v1.ObjectMeta
  2929. </a>
  2930. </em>
  2931. </td>
  2932. <td>
  2933. Refer to the Kubernetes API documentation for the fields of the
  2934. <code>metadata</code> field.
  2935. </td>
  2936. </tr>
  2937. <tr>
  2938. <td>
  2939. <code>spec</code></br>
  2940. <em>
  2941. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  2942. SecretStoreSpec
  2943. </a>
  2944. </em>
  2945. </td>
  2946. <td>
  2947. <br/>
  2948. <br/>
  2949. <table>
  2950. <tr>
  2951. <td>
  2952. <code>controller</code></br>
  2953. <em>
  2954. string
  2955. </em>
  2956. </td>
  2957. <td>
  2958. <em>(Optional)</em>
  2959. <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
  2960. The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
  2961. </td>
  2962. </tr>
  2963. <tr>
  2964. <td>
  2965. <code>provider</code></br>
  2966. <em>
  2967. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  2968. SecretStoreProvider
  2969. </a>
  2970. </em>
  2971. </td>
  2972. <td>
  2973. <p>Used to configure the provider. Only one provider may be set</p>
  2974. </td>
  2975. </tr>
  2976. <tr>
  2977. <td>
  2978. <code>retrySettings</code></br>
  2979. <em>
  2980. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  2981. SecretStoreRetrySettings
  2982. </a>
  2983. </em>
  2984. </td>
  2985. <td>
  2986. <em>(Optional)</em>
  2987. <p>Used to configure http retries if failed</p>
  2988. </td>
  2989. </tr>
  2990. <tr>
  2991. <td>
  2992. <code>refreshInterval</code></br>
  2993. <em>
  2994. int
  2995. </em>
  2996. </td>
  2997. <td>
  2998. <em>(Optional)</em>
  2999. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  3000. </td>
  3001. </tr>
  3002. <tr>
  3003. <td>
  3004. <code>conditions</code></br>
  3005. <em>
  3006. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  3007. []ClusterSecretStoreCondition
  3008. </a>
  3009. </em>
  3010. </td>
  3011. <td>
  3012. <em>(Optional)</em>
  3013. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  3014. </td>
  3015. </tr>
  3016. </table>
  3017. </td>
  3018. </tr>
  3019. <tr>
  3020. <td>
  3021. <code>status</code></br>
  3022. <em>
  3023. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  3024. SecretStoreStatus
  3025. </a>
  3026. </em>
  3027. </td>
  3028. <td>
  3029. </td>
  3030. </tr>
  3031. </tbody>
  3032. </table>
  3033. <h3 id="external-secrets.io/v1beta1.ClusterSecretStoreCondition">ClusterSecretStoreCondition
  3034. </h3>
  3035. <p>
  3036. (<em>Appears on:</em>
  3037. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  3038. </p>
  3039. <p>
  3040. <p>ClusterSecretStoreCondition describes a condition by which to choose namespaces to process ExternalSecrets in
  3041. for a ClusterSecretStore instance.</p>
  3042. </p>
  3043. <table>
  3044. <thead>
  3045. <tr>
  3046. <th>Field</th>
  3047. <th>Description</th>
  3048. </tr>
  3049. </thead>
  3050. <tbody>
  3051. <tr>
  3052. <td>
  3053. <code>namespaceSelector</code></br>
  3054. <em>
  3055. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  3056. Kubernetes meta/v1.LabelSelector
  3057. </a>
  3058. </em>
  3059. </td>
  3060. <td>
  3061. <em>(Optional)</em>
  3062. <p>Choose namespace using a labelSelector</p>
  3063. </td>
  3064. </tr>
  3065. <tr>
  3066. <td>
  3067. <code>namespaces</code></br>
  3068. <em>
  3069. []string
  3070. </em>
  3071. </td>
  3072. <td>
  3073. <p>Choose namespaces by name</p>
  3074. </td>
  3075. </tr>
  3076. </tbody>
  3077. </table>
  3078. <h3 id="external-secrets.io/v1beta1.ConjurAPIKey">ConjurAPIKey
  3079. </h3>
  3080. <p>
  3081. (<em>Appears on:</em>
  3082. <a href="#external-secrets.io/v1beta1.ConjurAuth">ConjurAuth</a>)
  3083. </p>
  3084. <p>
  3085. </p>
  3086. <table>
  3087. <thead>
  3088. <tr>
  3089. <th>Field</th>
  3090. <th>Description</th>
  3091. </tr>
  3092. </thead>
  3093. <tbody>
  3094. <tr>
  3095. <td>
  3096. <code>account</code></br>
  3097. <em>
  3098. string
  3099. </em>
  3100. </td>
  3101. <td>
  3102. </td>
  3103. </tr>
  3104. <tr>
  3105. <td>
  3106. <code>userRef</code></br>
  3107. <em>
  3108. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3109. External Secrets meta/v1.SecretKeySelector
  3110. </a>
  3111. </em>
  3112. </td>
  3113. <td>
  3114. </td>
  3115. </tr>
  3116. <tr>
  3117. <td>
  3118. <code>apiKeyRef</code></br>
  3119. <em>
  3120. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3121. External Secrets meta/v1.SecretKeySelector
  3122. </a>
  3123. </em>
  3124. </td>
  3125. <td>
  3126. </td>
  3127. </tr>
  3128. </tbody>
  3129. </table>
  3130. <h3 id="external-secrets.io/v1beta1.ConjurAuth">ConjurAuth
  3131. </h3>
  3132. <p>
  3133. (<em>Appears on:</em>
  3134. <a href="#external-secrets.io/v1beta1.ConjurProvider">ConjurProvider</a>)
  3135. </p>
  3136. <p>
  3137. </p>
  3138. <table>
  3139. <thead>
  3140. <tr>
  3141. <th>Field</th>
  3142. <th>Description</th>
  3143. </tr>
  3144. </thead>
  3145. <tbody>
  3146. <tr>
  3147. <td>
  3148. <code>apikey</code></br>
  3149. <em>
  3150. <a href="#external-secrets.io/v1beta1.ConjurAPIKey">
  3151. ConjurAPIKey
  3152. </a>
  3153. </em>
  3154. </td>
  3155. <td>
  3156. <em>(Optional)</em>
  3157. </td>
  3158. </tr>
  3159. <tr>
  3160. <td>
  3161. <code>jwt</code></br>
  3162. <em>
  3163. <a href="#external-secrets.io/v1beta1.ConjurJWT">
  3164. ConjurJWT
  3165. </a>
  3166. </em>
  3167. </td>
  3168. <td>
  3169. <em>(Optional)</em>
  3170. </td>
  3171. </tr>
  3172. </tbody>
  3173. </table>
  3174. <h3 id="external-secrets.io/v1beta1.ConjurJWT">ConjurJWT
  3175. </h3>
  3176. <p>
  3177. (<em>Appears on:</em>
  3178. <a href="#external-secrets.io/v1beta1.ConjurAuth">ConjurAuth</a>)
  3179. </p>
  3180. <p>
  3181. </p>
  3182. <table>
  3183. <thead>
  3184. <tr>
  3185. <th>Field</th>
  3186. <th>Description</th>
  3187. </tr>
  3188. </thead>
  3189. <tbody>
  3190. <tr>
  3191. <td>
  3192. <code>account</code></br>
  3193. <em>
  3194. string
  3195. </em>
  3196. </td>
  3197. <td>
  3198. </td>
  3199. </tr>
  3200. <tr>
  3201. <td>
  3202. <code>serviceID</code></br>
  3203. <em>
  3204. string
  3205. </em>
  3206. </td>
  3207. <td>
  3208. <p>The conjur authn jwt webservice id</p>
  3209. </td>
  3210. </tr>
  3211. <tr>
  3212. <td>
  3213. <code>hostId</code></br>
  3214. <em>
  3215. string
  3216. </em>
  3217. </td>
  3218. <td>
  3219. <em>(Optional)</em>
  3220. <p>Optional HostID for JWT authentication. This may be used depending
  3221. on how the Conjur JWT authenticator policy is configured.</p>
  3222. </td>
  3223. </tr>
  3224. <tr>
  3225. <td>
  3226. <code>secretRef</code></br>
  3227. <em>
  3228. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3229. External Secrets meta/v1.SecretKeySelector
  3230. </a>
  3231. </em>
  3232. </td>
  3233. <td>
  3234. <em>(Optional)</em>
  3235. <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  3236. authenticate with Conjur using the JWT authentication method.</p>
  3237. </td>
  3238. </tr>
  3239. <tr>
  3240. <td>
  3241. <code>serviceAccountRef</code></br>
  3242. <em>
  3243. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  3244. External Secrets meta/v1.ServiceAccountSelector
  3245. </a>
  3246. </em>
  3247. </td>
  3248. <td>
  3249. <em>(Optional)</em>
  3250. <p>Optional ServiceAccountRef specifies the Kubernetes service account for which to request
  3251. a token for with the <code>TokenRequest</code> API.</p>
  3252. </td>
  3253. </tr>
  3254. </tbody>
  3255. </table>
  3256. <h3 id="external-secrets.io/v1beta1.ConjurProvider">ConjurProvider
  3257. </h3>
  3258. <p>
  3259. (<em>Appears on:</em>
  3260. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3261. </p>
  3262. <p>
  3263. </p>
  3264. <table>
  3265. <thead>
  3266. <tr>
  3267. <th>Field</th>
  3268. <th>Description</th>
  3269. </tr>
  3270. </thead>
  3271. <tbody>
  3272. <tr>
  3273. <td>
  3274. <code>url</code></br>
  3275. <em>
  3276. string
  3277. </em>
  3278. </td>
  3279. <td>
  3280. </td>
  3281. </tr>
  3282. <tr>
  3283. <td>
  3284. <code>caBundle</code></br>
  3285. <em>
  3286. string
  3287. </em>
  3288. </td>
  3289. <td>
  3290. <em>(Optional)</em>
  3291. </td>
  3292. </tr>
  3293. <tr>
  3294. <td>
  3295. <code>caProvider</code></br>
  3296. <em>
  3297. <a href="#external-secrets.io/v1beta1.CAProvider">
  3298. CAProvider
  3299. </a>
  3300. </em>
  3301. </td>
  3302. <td>
  3303. <em>(Optional)</em>
  3304. </td>
  3305. </tr>
  3306. <tr>
  3307. <td>
  3308. <code>auth</code></br>
  3309. <em>
  3310. <a href="#external-secrets.io/v1beta1.ConjurAuth">
  3311. ConjurAuth
  3312. </a>
  3313. </em>
  3314. </td>
  3315. <td>
  3316. </td>
  3317. </tr>
  3318. </tbody>
  3319. </table>
  3320. <h3 id="external-secrets.io/v1beta1.DelineaProvider">DelineaProvider
  3321. </h3>
  3322. <p>
  3323. (<em>Appears on:</em>
  3324. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3325. </p>
  3326. <p>
  3327. <p>See <a href="https://github.com/DelineaXPM/dsv-sdk-go/blob/main/vault/vault.go">https://github.com/DelineaXPM/dsv-sdk-go/blob/main/vault/vault.go</a>.</p>
  3328. </p>
  3329. <table>
  3330. <thead>
  3331. <tr>
  3332. <th>Field</th>
  3333. <th>Description</th>
  3334. </tr>
  3335. </thead>
  3336. <tbody>
  3337. <tr>
  3338. <td>
  3339. <code>clientId</code></br>
  3340. <em>
  3341. <a href="#external-secrets.io/v1beta1.DelineaProviderSecretRef">
  3342. DelineaProviderSecretRef
  3343. </a>
  3344. </em>
  3345. </td>
  3346. <td>
  3347. <p>ClientID is the non-secret part of the credential.</p>
  3348. </td>
  3349. </tr>
  3350. <tr>
  3351. <td>
  3352. <code>clientSecret</code></br>
  3353. <em>
  3354. <a href="#external-secrets.io/v1beta1.DelineaProviderSecretRef">
  3355. DelineaProviderSecretRef
  3356. </a>
  3357. </em>
  3358. </td>
  3359. <td>
  3360. <p>ClientSecret is the secret part of the credential.</p>
  3361. </td>
  3362. </tr>
  3363. <tr>
  3364. <td>
  3365. <code>tenant</code></br>
  3366. <em>
  3367. string
  3368. </em>
  3369. </td>
  3370. <td>
  3371. <p>Tenant is the chosen hostname / site name.</p>
  3372. </td>
  3373. </tr>
  3374. <tr>
  3375. <td>
  3376. <code>urlTemplate</code></br>
  3377. <em>
  3378. string
  3379. </em>
  3380. </td>
  3381. <td>
  3382. <em>(Optional)</em>
  3383. <p>URLTemplate
  3384. If unset, defaults to &ldquo;https://%s.secretsvaultcloud.%s/v1/%s%s&rdquo;.</p>
  3385. </td>
  3386. </tr>
  3387. <tr>
  3388. <td>
  3389. <code>tld</code></br>
  3390. <em>
  3391. string
  3392. </em>
  3393. </td>
  3394. <td>
  3395. <em>(Optional)</em>
  3396. <p>TLD is based on the server location that was chosen during provisioning.
  3397. If unset, defaults to &ldquo;com&rdquo;.</p>
  3398. </td>
  3399. </tr>
  3400. </tbody>
  3401. </table>
  3402. <h3 id="external-secrets.io/v1beta1.DelineaProviderSecretRef">DelineaProviderSecretRef
  3403. </h3>
  3404. <p>
  3405. (<em>Appears on:</em>
  3406. <a href="#external-secrets.io/v1beta1.DelineaProvider">DelineaProvider</a>)
  3407. </p>
  3408. <p>
  3409. </p>
  3410. <table>
  3411. <thead>
  3412. <tr>
  3413. <th>Field</th>
  3414. <th>Description</th>
  3415. </tr>
  3416. </thead>
  3417. <tbody>
  3418. <tr>
  3419. <td>
  3420. <code>value</code></br>
  3421. <em>
  3422. string
  3423. </em>
  3424. </td>
  3425. <td>
  3426. <em>(Optional)</em>
  3427. <p>Value can be specified directly to set a value without using a secret.</p>
  3428. </td>
  3429. </tr>
  3430. <tr>
  3431. <td>
  3432. <code>secretRef</code></br>
  3433. <em>
  3434. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3435. External Secrets meta/v1.SecretKeySelector
  3436. </a>
  3437. </em>
  3438. </td>
  3439. <td>
  3440. <em>(Optional)</em>
  3441. <p>SecretRef references a key in a secret that will be used as value.</p>
  3442. </td>
  3443. </tr>
  3444. </tbody>
  3445. </table>
  3446. <h3 id="external-secrets.io/v1beta1.DopplerAuth">DopplerAuth
  3447. </h3>
  3448. <p>
  3449. (<em>Appears on:</em>
  3450. <a href="#external-secrets.io/v1beta1.DopplerProvider">DopplerProvider</a>)
  3451. </p>
  3452. <p>
  3453. </p>
  3454. <table>
  3455. <thead>
  3456. <tr>
  3457. <th>Field</th>
  3458. <th>Description</th>
  3459. </tr>
  3460. </thead>
  3461. <tbody>
  3462. <tr>
  3463. <td>
  3464. <code>secretRef</code></br>
  3465. <em>
  3466. <a href="#external-secrets.io/v1beta1.DopplerAuthSecretRef">
  3467. DopplerAuthSecretRef
  3468. </a>
  3469. </em>
  3470. </td>
  3471. <td>
  3472. </td>
  3473. </tr>
  3474. </tbody>
  3475. </table>
  3476. <h3 id="external-secrets.io/v1beta1.DopplerAuthSecretRef">DopplerAuthSecretRef
  3477. </h3>
  3478. <p>
  3479. (<em>Appears on:</em>
  3480. <a href="#external-secrets.io/v1beta1.DopplerAuth">DopplerAuth</a>)
  3481. </p>
  3482. <p>
  3483. </p>
  3484. <table>
  3485. <thead>
  3486. <tr>
  3487. <th>Field</th>
  3488. <th>Description</th>
  3489. </tr>
  3490. </thead>
  3491. <tbody>
  3492. <tr>
  3493. <td>
  3494. <code>dopplerToken</code></br>
  3495. <em>
  3496. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3497. External Secrets meta/v1.SecretKeySelector
  3498. </a>
  3499. </em>
  3500. </td>
  3501. <td>
  3502. <p>The DopplerToken is used for authentication.
  3503. See <a href="https://docs.doppler.com/reference/api#authentication">https://docs.doppler.com/reference/api#authentication</a> for auth token types.
  3504. The Key attribute defaults to dopplerToken if not specified.</p>
  3505. </td>
  3506. </tr>
  3507. </tbody>
  3508. </table>
  3509. <h3 id="external-secrets.io/v1beta1.DopplerProvider">DopplerProvider
  3510. </h3>
  3511. <p>
  3512. (<em>Appears on:</em>
  3513. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3514. </p>
  3515. <p>
  3516. <p>DopplerProvider configures a store to sync secrets using the Doppler provider.
  3517. Project and Config are required if not using a Service Token.</p>
  3518. </p>
  3519. <table>
  3520. <thead>
  3521. <tr>
  3522. <th>Field</th>
  3523. <th>Description</th>
  3524. </tr>
  3525. </thead>
  3526. <tbody>
  3527. <tr>
  3528. <td>
  3529. <code>auth</code></br>
  3530. <em>
  3531. <a href="#external-secrets.io/v1beta1.DopplerAuth">
  3532. DopplerAuth
  3533. </a>
  3534. </em>
  3535. </td>
  3536. <td>
  3537. <p>Auth configures how the Operator authenticates with the Doppler API</p>
  3538. </td>
  3539. </tr>
  3540. <tr>
  3541. <td>
  3542. <code>project</code></br>
  3543. <em>
  3544. string
  3545. </em>
  3546. </td>
  3547. <td>
  3548. <em>(Optional)</em>
  3549. <p>Doppler project (required if not using a Service Token)</p>
  3550. </td>
  3551. </tr>
  3552. <tr>
  3553. <td>
  3554. <code>config</code></br>
  3555. <em>
  3556. string
  3557. </em>
  3558. </td>
  3559. <td>
  3560. <em>(Optional)</em>
  3561. <p>Doppler config (required if not using a Service Token)</p>
  3562. </td>
  3563. </tr>
  3564. <tr>
  3565. <td>
  3566. <code>nameTransformer</code></br>
  3567. <em>
  3568. string
  3569. </em>
  3570. </td>
  3571. <td>
  3572. <em>(Optional)</em>
  3573. <p>Environment variable compatible name transforms that change secret names to a different format</p>
  3574. </td>
  3575. </tr>
  3576. <tr>
  3577. <td>
  3578. <code>format</code></br>
  3579. <em>
  3580. string
  3581. </em>
  3582. </td>
  3583. <td>
  3584. <em>(Optional)</em>
  3585. <p>Format enables the downloading of secrets as a file (string)</p>
  3586. </td>
  3587. </tr>
  3588. </tbody>
  3589. </table>
  3590. <h3 id="external-secrets.io/v1beta1.ExternalSecret">ExternalSecret
  3591. </h3>
  3592. <p>
  3593. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  3594. </p>
  3595. <table>
  3596. <thead>
  3597. <tr>
  3598. <th>Field</th>
  3599. <th>Description</th>
  3600. </tr>
  3601. </thead>
  3602. <tbody>
  3603. <tr>
  3604. <td>
  3605. <code>metadata</code></br>
  3606. <em>
  3607. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  3608. Kubernetes meta/v1.ObjectMeta
  3609. </a>
  3610. </em>
  3611. </td>
  3612. <td>
  3613. Refer to the Kubernetes API documentation for the fields of the
  3614. <code>metadata</code> field.
  3615. </td>
  3616. </tr>
  3617. <tr>
  3618. <td>
  3619. <code>spec</code></br>
  3620. <em>
  3621. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  3622. ExternalSecretSpec
  3623. </a>
  3624. </em>
  3625. </td>
  3626. <td>
  3627. <br/>
  3628. <br/>
  3629. <table>
  3630. <tr>
  3631. <td>
  3632. <code>secretStoreRef</code></br>
  3633. <em>
  3634. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  3635. SecretStoreRef
  3636. </a>
  3637. </em>
  3638. </td>
  3639. <td>
  3640. <em>(Optional)</em>
  3641. </td>
  3642. </tr>
  3643. <tr>
  3644. <td>
  3645. <code>target</code></br>
  3646. <em>
  3647. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  3648. ExternalSecretTarget
  3649. </a>
  3650. </em>
  3651. </td>
  3652. <td>
  3653. <em>(Optional)</em>
  3654. </td>
  3655. </tr>
  3656. <tr>
  3657. <td>
  3658. <code>refreshInterval</code></br>
  3659. <em>
  3660. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  3661. Kubernetes meta/v1.Duration
  3662. </a>
  3663. </em>
  3664. </td>
  3665. <td>
  3666. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  3667. 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;
  3668. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  3669. </td>
  3670. </tr>
  3671. <tr>
  3672. <td>
  3673. <code>data</code></br>
  3674. <em>
  3675. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  3676. []ExternalSecretData
  3677. </a>
  3678. </em>
  3679. </td>
  3680. <td>
  3681. <em>(Optional)</em>
  3682. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  3683. </td>
  3684. </tr>
  3685. <tr>
  3686. <td>
  3687. <code>dataFrom</code></br>
  3688. <em>
  3689. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  3690. []ExternalSecretDataFromRemoteRef
  3691. </a>
  3692. </em>
  3693. </td>
  3694. <td>
  3695. <em>(Optional)</em>
  3696. <p>DataFrom is used to fetch all properties from a specific Provider data
  3697. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  3698. </td>
  3699. </tr>
  3700. </table>
  3701. </td>
  3702. </tr>
  3703. <tr>
  3704. <td>
  3705. <code>status</code></br>
  3706. <em>
  3707. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">
  3708. ExternalSecretStatus
  3709. </a>
  3710. </em>
  3711. </td>
  3712. <td>
  3713. </td>
  3714. </tr>
  3715. </tbody>
  3716. </table>
  3717. <h3 id="external-secrets.io/v1beta1.ExternalSecretConditionType">ExternalSecretConditionType
  3718. (<code>string</code> alias)</p></h3>
  3719. <p>
  3720. (<em>Appears on:</em>
  3721. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  3722. </p>
  3723. <p>
  3724. </p>
  3725. <table>
  3726. <thead>
  3727. <tr>
  3728. <th>Value</th>
  3729. <th>Description</th>
  3730. </tr>
  3731. </thead>
  3732. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
  3733. <td></td>
  3734. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  3735. <td></td>
  3736. </tr></tbody>
  3737. </table>
  3738. <h3 id="external-secrets.io/v1beta1.ExternalSecretConversionStrategy">ExternalSecretConversionStrategy
  3739. (<code>string</code> alias)</p></h3>
  3740. <p>
  3741. (<em>Appears on:</em>
  3742. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  3743. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  3744. </p>
  3745. <p>
  3746. </p>
  3747. <table>
  3748. <thead>
  3749. <tr>
  3750. <th>Value</th>
  3751. <th>Description</th>
  3752. </tr>
  3753. </thead>
  3754. <tbody><tr><td><p>&#34;Default&#34;</p></td>
  3755. <td></td>
  3756. </tr><tr><td><p>&#34;Unicode&#34;</p></td>
  3757. <td></td>
  3758. </tr></tbody>
  3759. </table>
  3760. <h3 id="external-secrets.io/v1beta1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  3761. (<code>string</code> alias)</p></h3>
  3762. <p>
  3763. (<em>Appears on:</em>
  3764. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  3765. </p>
  3766. <p>
  3767. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  3768. </p>
  3769. <table>
  3770. <thead>
  3771. <tr>
  3772. <th>Value</th>
  3773. <th>Description</th>
  3774. </tr>
  3775. </thead>
  3776. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  3777. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  3778. </td>
  3779. </tr><tr><td><p>&#34;None&#34;</p></td>
  3780. <td><p>None does not create a Secret (future use with injector).</p>
  3781. </td>
  3782. </tr><tr><td><p>&#34;Orphan&#34;</p></td>
  3783. <td><p>Orphan creates the Secret and does not set the ownerReference.
  3784. I.e. it will be orphaned after the deletion of the ExternalSecret.</p>
  3785. </td>
  3786. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  3787. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  3788. </td>
  3789. </tr></tbody>
  3790. </table>
  3791. <h3 id="external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData
  3792. </h3>
  3793. <p>
  3794. (<em>Appears on:</em>
  3795. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  3796. </p>
  3797. <p>
  3798. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  3799. </p>
  3800. <table>
  3801. <thead>
  3802. <tr>
  3803. <th>Field</th>
  3804. <th>Description</th>
  3805. </tr>
  3806. </thead>
  3807. <tbody>
  3808. <tr>
  3809. <td>
  3810. <code>secretKey</code></br>
  3811. <em>
  3812. string
  3813. </em>
  3814. </td>
  3815. <td>
  3816. <p>SecretKey defines the key in which the controller stores
  3817. the value. This is the key in the Kind=Secret</p>
  3818. </td>
  3819. </tr>
  3820. <tr>
  3821. <td>
  3822. <code>remoteRef</code></br>
  3823. <em>
  3824. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  3825. ExternalSecretDataRemoteRef
  3826. </a>
  3827. </em>
  3828. </td>
  3829. <td>
  3830. <p>RemoteRef points to the remote secret and defines
  3831. which secret (version/property/..) to fetch.</p>
  3832. </td>
  3833. </tr>
  3834. <tr>
  3835. <td>
  3836. <code>sourceRef</code></br>
  3837. <em>
  3838. <a href="#external-secrets.io/v1beta1.StoreSourceRef">
  3839. StoreSourceRef
  3840. </a>
  3841. </em>
  3842. </td>
  3843. <td>
  3844. <p>SourceRef allows you to override the source
  3845. from which the value will pulled from.</p>
  3846. </td>
  3847. </tr>
  3848. </tbody>
  3849. </table>
  3850. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef
  3851. </h3>
  3852. <p>
  3853. (<em>Appears on:</em>
  3854. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  3855. </p>
  3856. <p>
  3857. </p>
  3858. <table>
  3859. <thead>
  3860. <tr>
  3861. <th>Field</th>
  3862. <th>Description</th>
  3863. </tr>
  3864. </thead>
  3865. <tbody>
  3866. <tr>
  3867. <td>
  3868. <code>extract</code></br>
  3869. <em>
  3870. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  3871. ExternalSecretDataRemoteRef
  3872. </a>
  3873. </em>
  3874. </td>
  3875. <td>
  3876. <em>(Optional)</em>
  3877. <p>Used to extract multiple key/value pairs from one secret
  3878. Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
  3879. </td>
  3880. </tr>
  3881. <tr>
  3882. <td>
  3883. <code>find</code></br>
  3884. <em>
  3885. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">
  3886. ExternalSecretFind
  3887. </a>
  3888. </em>
  3889. </td>
  3890. <td>
  3891. <em>(Optional)</em>
  3892. <p>Used to find secrets based on tags or regular expressions
  3893. Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
  3894. </td>
  3895. </tr>
  3896. <tr>
  3897. <td>
  3898. <code>rewrite</code></br>
  3899. <em>
  3900. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">
  3901. []ExternalSecretRewrite
  3902. </a>
  3903. </em>
  3904. </td>
  3905. <td>
  3906. <em>(Optional)</em>
  3907. <p>Used to rewrite secret Keys after getting them from the secret Provider
  3908. Multiple Rewrite operations can be provided. They are applied in a layered order (first to last)</p>
  3909. </td>
  3910. </tr>
  3911. <tr>
  3912. <td>
  3913. <code>sourceRef</code></br>
  3914. <em>
  3915. <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">
  3916. StoreGeneratorSourceRef
  3917. </a>
  3918. </em>
  3919. </td>
  3920. <td>
  3921. <p>SourceRef points to a store or generator
  3922. which contains secret values ready to use.
  3923. Use this in combination with Extract or Find pull values out of
  3924. a specific SecretStore.
  3925. When sourceRef points to a generator Extract or Find is not supported.
  3926. The generator returns a static map of values</p>
  3927. </td>
  3928. </tr>
  3929. </tbody>
  3930. </table>
  3931. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  3932. </h3>
  3933. <p>
  3934. (<em>Appears on:</em>
  3935. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>,
  3936. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  3937. </p>
  3938. <p>
  3939. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  3940. </p>
  3941. <table>
  3942. <thead>
  3943. <tr>
  3944. <th>Field</th>
  3945. <th>Description</th>
  3946. </tr>
  3947. </thead>
  3948. <tbody>
  3949. <tr>
  3950. <td>
  3951. <code>key</code></br>
  3952. <em>
  3953. string
  3954. </em>
  3955. </td>
  3956. <td>
  3957. <p>Key is the key used in the Provider, mandatory</p>
  3958. </td>
  3959. </tr>
  3960. <tr>
  3961. <td>
  3962. <code>metadataPolicy</code></br>
  3963. <em>
  3964. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">
  3965. ExternalSecretMetadataPolicy
  3966. </a>
  3967. </em>
  3968. </td>
  3969. <td>
  3970. <em>(Optional)</em>
  3971. <p>Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None</p>
  3972. </td>
  3973. </tr>
  3974. <tr>
  3975. <td>
  3976. <code>property</code></br>
  3977. <em>
  3978. string
  3979. </em>
  3980. </td>
  3981. <td>
  3982. <em>(Optional)</em>
  3983. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  3984. </td>
  3985. </tr>
  3986. <tr>
  3987. <td>
  3988. <code>version</code></br>
  3989. <em>
  3990. string
  3991. </em>
  3992. </td>
  3993. <td>
  3994. <em>(Optional)</em>
  3995. <p>Used to select a specific version of the Provider value, if supported</p>
  3996. </td>
  3997. </tr>
  3998. <tr>
  3999. <td>
  4000. <code>conversionStrategy</code></br>
  4001. <em>
  4002. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  4003. ExternalSecretConversionStrategy
  4004. </a>
  4005. </em>
  4006. </td>
  4007. <td>
  4008. <em>(Optional)</em>
  4009. <p>Used to define a conversion Strategy</p>
  4010. </td>
  4011. </tr>
  4012. <tr>
  4013. <td>
  4014. <code>decodingStrategy</code></br>
  4015. <em>
  4016. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  4017. ExternalSecretDecodingStrategy
  4018. </a>
  4019. </em>
  4020. </td>
  4021. <td>
  4022. <em>(Optional)</em>
  4023. <p>Used to define a decoding Strategy</p>
  4024. </td>
  4025. </tr>
  4026. </tbody>
  4027. </table>
  4028. <h3 id="external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">ExternalSecretDecodingStrategy
  4029. (<code>string</code> alias)</p></h3>
  4030. <p>
  4031. (<em>Appears on:</em>
  4032. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  4033. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  4034. </p>
  4035. <p>
  4036. </p>
  4037. <table>
  4038. <thead>
  4039. <tr>
  4040. <th>Value</th>
  4041. <th>Description</th>
  4042. </tr>
  4043. </thead>
  4044. <tbody><tr><td><p>&#34;Auto&#34;</p></td>
  4045. <td></td>
  4046. </tr><tr><td><p>&#34;Base64&#34;</p></td>
  4047. <td></td>
  4048. </tr><tr><td><p>&#34;Base64URL&#34;</p></td>
  4049. <td></td>
  4050. </tr><tr><td><p>&#34;None&#34;</p></td>
  4051. <td></td>
  4052. </tr></tbody>
  4053. </table>
  4054. <h3 id="external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">ExternalSecretDeletionPolicy
  4055. (<code>string</code> alias)</p></h3>
  4056. <p>
  4057. (<em>Appears on:</em>
  4058. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  4059. </p>
  4060. <p>
  4061. <p>ExternalSecretDeletionPolicy defines rules on how to delete the resulting Secret.</p>
  4062. </p>
  4063. <table>
  4064. <thead>
  4065. <tr>
  4066. <th>Value</th>
  4067. <th>Description</th>
  4068. </tr>
  4069. </thead>
  4070. <tbody><tr><td><p>&#34;Delete&#34;</p></td>
  4071. <td><p>Delete deletes the secret if all provider secrets are deleted.
  4072. If a secret gets deleted on the provider side and is not accessible
  4073. anymore this is not considered an error and the ExternalSecret
  4074. does not go into SecretSyncedError status.</p>
  4075. </td>
  4076. </tr><tr><td><p>&#34;Merge&#34;</p></td>
  4077. <td><p>Merge removes keys in the secret, but not the secret itself.
  4078. If a secret gets deleted on the provider side and is not accessible
  4079. anymore this is not considered an error and the ExternalSecret
  4080. does not go into SecretSyncedError status.</p>
  4081. </td>
  4082. </tr><tr><td><p>&#34;Retain&#34;</p></td>
  4083. <td><p>Retain will retain the secret if all provider secrets have been deleted.
  4084. If a provider secret does not exist the ExternalSecret gets into the
  4085. SecretSyncedError status.</p>
  4086. </td>
  4087. </tr></tbody>
  4088. </table>
  4089. <h3 id="external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind
  4090. </h3>
  4091. <p>
  4092. (<em>Appears on:</em>
  4093. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  4094. </p>
  4095. <p>
  4096. </p>
  4097. <table>
  4098. <thead>
  4099. <tr>
  4100. <th>Field</th>
  4101. <th>Description</th>
  4102. </tr>
  4103. </thead>
  4104. <tbody>
  4105. <tr>
  4106. <td>
  4107. <code>path</code></br>
  4108. <em>
  4109. string
  4110. </em>
  4111. </td>
  4112. <td>
  4113. <em>(Optional)</em>
  4114. <p>A root path to start the find operations.</p>
  4115. </td>
  4116. </tr>
  4117. <tr>
  4118. <td>
  4119. <code>name</code></br>
  4120. <em>
  4121. <a href="#external-secrets.io/v1beta1.FindName">
  4122. FindName
  4123. </a>
  4124. </em>
  4125. </td>
  4126. <td>
  4127. <em>(Optional)</em>
  4128. <p>Finds secrets based on the name.</p>
  4129. </td>
  4130. </tr>
  4131. <tr>
  4132. <td>
  4133. <code>tags</code></br>
  4134. <em>
  4135. map[string]string
  4136. </em>
  4137. </td>
  4138. <td>
  4139. <em>(Optional)</em>
  4140. <p>Find secrets based on tags.</p>
  4141. </td>
  4142. </tr>
  4143. <tr>
  4144. <td>
  4145. <code>conversionStrategy</code></br>
  4146. <em>
  4147. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  4148. ExternalSecretConversionStrategy
  4149. </a>
  4150. </em>
  4151. </td>
  4152. <td>
  4153. <em>(Optional)</em>
  4154. <p>Used to define a conversion Strategy</p>
  4155. </td>
  4156. </tr>
  4157. <tr>
  4158. <td>
  4159. <code>decodingStrategy</code></br>
  4160. <em>
  4161. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  4162. ExternalSecretDecodingStrategy
  4163. </a>
  4164. </em>
  4165. </td>
  4166. <td>
  4167. <em>(Optional)</em>
  4168. <p>Used to define a decoding Strategy</p>
  4169. </td>
  4170. </tr>
  4171. </tbody>
  4172. </table>
  4173. <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadata">ExternalSecretMetadata
  4174. </h3>
  4175. <p>
  4176. (<em>Appears on:</em>
  4177. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>)
  4178. </p>
  4179. <p>
  4180. <p>ExternalSecretMetadata defines metadata fields for the ExternalSecret generated by the ClusterExternalSecret.</p>
  4181. </p>
  4182. <table>
  4183. <thead>
  4184. <tr>
  4185. <th>Field</th>
  4186. <th>Description</th>
  4187. </tr>
  4188. </thead>
  4189. <tbody>
  4190. <tr>
  4191. <td>
  4192. <code>annotations</code></br>
  4193. <em>
  4194. map[string]string
  4195. </em>
  4196. </td>
  4197. <td>
  4198. <em>(Optional)</em>
  4199. </td>
  4200. </tr>
  4201. <tr>
  4202. <td>
  4203. <code>labels</code></br>
  4204. <em>
  4205. map[string]string
  4206. </em>
  4207. </td>
  4208. <td>
  4209. <em>(Optional)</em>
  4210. </td>
  4211. </tr>
  4212. </tbody>
  4213. </table>
  4214. <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">ExternalSecretMetadataPolicy
  4215. (<code>string</code> alias)</p></h3>
  4216. <p>
  4217. (<em>Appears on:</em>
  4218. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>)
  4219. </p>
  4220. <p>
  4221. </p>
  4222. <table>
  4223. <thead>
  4224. <tr>
  4225. <th>Value</th>
  4226. <th>Description</th>
  4227. </tr>
  4228. </thead>
  4229. <tbody><tr><td><p>&#34;Fetch&#34;</p></td>
  4230. <td></td>
  4231. </tr><tr><td><p>&#34;None&#34;</p></td>
  4232. <td></td>
  4233. </tr></tbody>
  4234. </table>
  4235. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite
  4236. </h3>
  4237. <p>
  4238. (<em>Appears on:</em>
  4239. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  4240. </p>
  4241. <p>
  4242. </p>
  4243. <table>
  4244. <thead>
  4245. <tr>
  4246. <th>Field</th>
  4247. <th>Description</th>
  4248. </tr>
  4249. </thead>
  4250. <tbody>
  4251. <tr>
  4252. <td>
  4253. <code>regexp</code></br>
  4254. <em>
  4255. <a href="#external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">
  4256. ExternalSecretRewriteRegexp
  4257. </a>
  4258. </em>
  4259. </td>
  4260. <td>
  4261. <em>(Optional)</em>
  4262. <p>Used to rewrite with regular expressions.
  4263. The resulting key will be the output of a regexp.ReplaceAll operation.</p>
  4264. </td>
  4265. </tr>
  4266. <tr>
  4267. <td>
  4268. <code>transform</code></br>
  4269. <em>
  4270. <a href="#external-secrets.io/v1beta1.ExternalSecretRewriteTransform">
  4271. ExternalSecretRewriteTransform
  4272. </a>
  4273. </em>
  4274. </td>
  4275. <td>
  4276. <em>(Optional)</em>
  4277. <p>Used to apply string transformation on the secrets.
  4278. The resulting key will be the output of the template applied by the operation.</p>
  4279. </td>
  4280. </tr>
  4281. </tbody>
  4282. </table>
  4283. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">ExternalSecretRewriteRegexp
  4284. </h3>
  4285. <p>
  4286. (<em>Appears on:</em>
  4287. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
  4288. </p>
  4289. <p>
  4290. </p>
  4291. <table>
  4292. <thead>
  4293. <tr>
  4294. <th>Field</th>
  4295. <th>Description</th>
  4296. </tr>
  4297. </thead>
  4298. <tbody>
  4299. <tr>
  4300. <td>
  4301. <code>source</code></br>
  4302. <em>
  4303. string
  4304. </em>
  4305. </td>
  4306. <td>
  4307. <p>Used to define the regular expression of a re.Compiler.</p>
  4308. </td>
  4309. </tr>
  4310. <tr>
  4311. <td>
  4312. <code>target</code></br>
  4313. <em>
  4314. string
  4315. </em>
  4316. </td>
  4317. <td>
  4318. <p>Used to define the target pattern of a ReplaceAll operation.</p>
  4319. </td>
  4320. </tr>
  4321. </tbody>
  4322. </table>
  4323. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewriteTransform">ExternalSecretRewriteTransform
  4324. </h3>
  4325. <p>
  4326. (<em>Appears on:</em>
  4327. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
  4328. </p>
  4329. <p>
  4330. </p>
  4331. <table>
  4332. <thead>
  4333. <tr>
  4334. <th>Field</th>
  4335. <th>Description</th>
  4336. </tr>
  4337. </thead>
  4338. <tbody>
  4339. <tr>
  4340. <td>
  4341. <code>template</code></br>
  4342. <em>
  4343. string
  4344. </em>
  4345. </td>
  4346. <td>
  4347. <p>Used to define the template to apply on the secret name.
  4348. <code>.value</code> will specify the secret name in the template.</p>
  4349. </td>
  4350. </tr>
  4351. </tbody>
  4352. </table>
  4353. <h3 id="external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec
  4354. </h3>
  4355. <p>
  4356. (<em>Appears on:</em>
  4357. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>,
  4358. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  4359. </p>
  4360. <p>
  4361. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  4362. </p>
  4363. <table>
  4364. <thead>
  4365. <tr>
  4366. <th>Field</th>
  4367. <th>Description</th>
  4368. </tr>
  4369. </thead>
  4370. <tbody>
  4371. <tr>
  4372. <td>
  4373. <code>secretStoreRef</code></br>
  4374. <em>
  4375. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  4376. SecretStoreRef
  4377. </a>
  4378. </em>
  4379. </td>
  4380. <td>
  4381. <em>(Optional)</em>
  4382. </td>
  4383. </tr>
  4384. <tr>
  4385. <td>
  4386. <code>target</code></br>
  4387. <em>
  4388. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  4389. ExternalSecretTarget
  4390. </a>
  4391. </em>
  4392. </td>
  4393. <td>
  4394. <em>(Optional)</em>
  4395. </td>
  4396. </tr>
  4397. <tr>
  4398. <td>
  4399. <code>refreshInterval</code></br>
  4400. <em>
  4401. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  4402. Kubernetes meta/v1.Duration
  4403. </a>
  4404. </em>
  4405. </td>
  4406. <td>
  4407. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  4408. 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;
  4409. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  4410. </td>
  4411. </tr>
  4412. <tr>
  4413. <td>
  4414. <code>data</code></br>
  4415. <em>
  4416. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  4417. []ExternalSecretData
  4418. </a>
  4419. </em>
  4420. </td>
  4421. <td>
  4422. <em>(Optional)</em>
  4423. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  4424. </td>
  4425. </tr>
  4426. <tr>
  4427. <td>
  4428. <code>dataFrom</code></br>
  4429. <em>
  4430. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  4431. []ExternalSecretDataFromRemoteRef
  4432. </a>
  4433. </em>
  4434. </td>
  4435. <td>
  4436. <em>(Optional)</em>
  4437. <p>DataFrom is used to fetch all properties from a specific Provider data
  4438. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  4439. </td>
  4440. </tr>
  4441. </tbody>
  4442. </table>
  4443. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus
  4444. </h3>
  4445. <p>
  4446. (<em>Appears on:</em>
  4447. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  4448. </p>
  4449. <p>
  4450. </p>
  4451. <table>
  4452. <thead>
  4453. <tr>
  4454. <th>Field</th>
  4455. <th>Description</th>
  4456. </tr>
  4457. </thead>
  4458. <tbody>
  4459. <tr>
  4460. <td>
  4461. <code>refreshTime</code></br>
  4462. <em>
  4463. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  4464. Kubernetes meta/v1.Time
  4465. </a>
  4466. </em>
  4467. </td>
  4468. <td>
  4469. <p>refreshTime is the time and date the external secret was fetched and
  4470. the target secret updated</p>
  4471. </td>
  4472. </tr>
  4473. <tr>
  4474. <td>
  4475. <code>syncedResourceVersion</code></br>
  4476. <em>
  4477. string
  4478. </em>
  4479. </td>
  4480. <td>
  4481. <p>SyncedResourceVersion keeps track of the last synced version</p>
  4482. </td>
  4483. </tr>
  4484. <tr>
  4485. <td>
  4486. <code>conditions</code></br>
  4487. <em>
  4488. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">
  4489. []ExternalSecretStatusCondition
  4490. </a>
  4491. </em>
  4492. </td>
  4493. <td>
  4494. <em>(Optional)</em>
  4495. </td>
  4496. </tr>
  4497. <tr>
  4498. <td>
  4499. <code>binding</code></br>
  4500. <em>
  4501. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#localobjectreference-v1-core">
  4502. Kubernetes core/v1.LocalObjectReference
  4503. </a>
  4504. </em>
  4505. </td>
  4506. <td>
  4507. <p>Binding represents a servicebinding.io Provisioned Service reference to the secret</p>
  4508. </td>
  4509. </tr>
  4510. </tbody>
  4511. </table>
  4512. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  4513. </h3>
  4514. <p>
  4515. (<em>Appears on:</em>
  4516. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus</a>)
  4517. </p>
  4518. <p>
  4519. </p>
  4520. <table>
  4521. <thead>
  4522. <tr>
  4523. <th>Field</th>
  4524. <th>Description</th>
  4525. </tr>
  4526. </thead>
  4527. <tbody>
  4528. <tr>
  4529. <td>
  4530. <code>type</code></br>
  4531. <em>
  4532. <a href="#external-secrets.io/v1beta1.ExternalSecretConditionType">
  4533. ExternalSecretConditionType
  4534. </a>
  4535. </em>
  4536. </td>
  4537. <td>
  4538. </td>
  4539. </tr>
  4540. <tr>
  4541. <td>
  4542. <code>status</code></br>
  4543. <em>
  4544. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  4545. Kubernetes core/v1.ConditionStatus
  4546. </a>
  4547. </em>
  4548. </td>
  4549. <td>
  4550. </td>
  4551. </tr>
  4552. <tr>
  4553. <td>
  4554. <code>reason</code></br>
  4555. <em>
  4556. string
  4557. </em>
  4558. </td>
  4559. <td>
  4560. <em>(Optional)</em>
  4561. </td>
  4562. </tr>
  4563. <tr>
  4564. <td>
  4565. <code>message</code></br>
  4566. <em>
  4567. string
  4568. </em>
  4569. </td>
  4570. <td>
  4571. <em>(Optional)</em>
  4572. </td>
  4573. </tr>
  4574. <tr>
  4575. <td>
  4576. <code>lastTransitionTime</code></br>
  4577. <em>
  4578. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  4579. Kubernetes meta/v1.Time
  4580. </a>
  4581. </em>
  4582. </td>
  4583. <td>
  4584. <em>(Optional)</em>
  4585. </td>
  4586. </tr>
  4587. </tbody>
  4588. </table>
  4589. <h3 id="external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget
  4590. </h3>
  4591. <p>
  4592. (<em>Appears on:</em>
  4593. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  4594. </p>
  4595. <p>
  4596. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  4597. There can be only one target per ExternalSecret.</p>
  4598. </p>
  4599. <table>
  4600. <thead>
  4601. <tr>
  4602. <th>Field</th>
  4603. <th>Description</th>
  4604. </tr>
  4605. </thead>
  4606. <tbody>
  4607. <tr>
  4608. <td>
  4609. <code>name</code></br>
  4610. <em>
  4611. string
  4612. </em>
  4613. </td>
  4614. <td>
  4615. <em>(Optional)</em>
  4616. <p>Name defines the name of the Secret resource to be managed
  4617. This field is immutable
  4618. Defaults to the .metadata.name of the ExternalSecret resource</p>
  4619. </td>
  4620. </tr>
  4621. <tr>
  4622. <td>
  4623. <code>creationPolicy</code></br>
  4624. <em>
  4625. <a href="#external-secrets.io/v1beta1.ExternalSecretCreationPolicy">
  4626. ExternalSecretCreationPolicy
  4627. </a>
  4628. </em>
  4629. </td>
  4630. <td>
  4631. <em>(Optional)</em>
  4632. <p>CreationPolicy defines rules on how to create the resulting Secret
  4633. Defaults to &lsquo;Owner&rsquo;</p>
  4634. </td>
  4635. </tr>
  4636. <tr>
  4637. <td>
  4638. <code>deletionPolicy</code></br>
  4639. <em>
  4640. <a href="#external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">
  4641. ExternalSecretDeletionPolicy
  4642. </a>
  4643. </em>
  4644. </td>
  4645. <td>
  4646. <em>(Optional)</em>
  4647. <p>DeletionPolicy defines rules on how to delete the resulting Secret
  4648. Defaults to &lsquo;Retain&rsquo;</p>
  4649. </td>
  4650. </tr>
  4651. <tr>
  4652. <td>
  4653. <code>template</code></br>
  4654. <em>
  4655. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">
  4656. ExternalSecretTemplate
  4657. </a>
  4658. </em>
  4659. </td>
  4660. <td>
  4661. <em>(Optional)</em>
  4662. <p>Template defines a blueprint for the created Secret resource.</p>
  4663. </td>
  4664. </tr>
  4665. <tr>
  4666. <td>
  4667. <code>immutable</code></br>
  4668. <em>
  4669. bool
  4670. </em>
  4671. </td>
  4672. <td>
  4673. <em>(Optional)</em>
  4674. <p>Immutable defines if the final secret will be immutable</p>
  4675. </td>
  4676. </tr>
  4677. </tbody>
  4678. </table>
  4679. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate
  4680. </h3>
  4681. <p>
  4682. (<em>Appears on:</em>
  4683. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  4684. </p>
  4685. <p>
  4686. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  4687. 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>
  4688. </p>
  4689. <table>
  4690. <thead>
  4691. <tr>
  4692. <th>Field</th>
  4693. <th>Description</th>
  4694. </tr>
  4695. </thead>
  4696. <tbody>
  4697. <tr>
  4698. <td>
  4699. <code>type</code></br>
  4700. <em>
  4701. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secrettype-v1-core">
  4702. Kubernetes core/v1.SecretType
  4703. </a>
  4704. </em>
  4705. </td>
  4706. <td>
  4707. <em>(Optional)</em>
  4708. </td>
  4709. </tr>
  4710. <tr>
  4711. <td>
  4712. <code>engineVersion</code></br>
  4713. <em>
  4714. <a href="#external-secrets.io/v1beta1.TemplateEngineVersion">
  4715. TemplateEngineVersion
  4716. </a>
  4717. </em>
  4718. </td>
  4719. <td>
  4720. <p>EngineVersion specifies the template engine version
  4721. that should be used to compile/execute the
  4722. template specified in .data and .templateFrom[].</p>
  4723. </td>
  4724. </tr>
  4725. <tr>
  4726. <td>
  4727. <code>metadata</code></br>
  4728. <em>
  4729. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">
  4730. ExternalSecretTemplateMetadata
  4731. </a>
  4732. </em>
  4733. </td>
  4734. <td>
  4735. <em>(Optional)</em>
  4736. </td>
  4737. </tr>
  4738. <tr>
  4739. <td>
  4740. <code>mergePolicy</code></br>
  4741. <em>
  4742. <a href="#external-secrets.io/v1beta1.TemplateMergePolicy">
  4743. TemplateMergePolicy
  4744. </a>
  4745. </em>
  4746. </td>
  4747. <td>
  4748. </td>
  4749. </tr>
  4750. <tr>
  4751. <td>
  4752. <code>data</code></br>
  4753. <em>
  4754. map[string]string
  4755. </em>
  4756. </td>
  4757. <td>
  4758. <em>(Optional)</em>
  4759. </td>
  4760. </tr>
  4761. <tr>
  4762. <td>
  4763. <code>templateFrom</code></br>
  4764. <em>
  4765. <a href="#external-secrets.io/v1beta1.TemplateFrom">
  4766. []TemplateFrom
  4767. </a>
  4768. </em>
  4769. </td>
  4770. <td>
  4771. <em>(Optional)</em>
  4772. </td>
  4773. </tr>
  4774. </tbody>
  4775. </table>
  4776. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  4777. </h3>
  4778. <p>
  4779. (<em>Appears on:</em>
  4780. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  4781. </p>
  4782. <p>
  4783. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  4784. </p>
  4785. <table>
  4786. <thead>
  4787. <tr>
  4788. <th>Field</th>
  4789. <th>Description</th>
  4790. </tr>
  4791. </thead>
  4792. <tbody>
  4793. <tr>
  4794. <td>
  4795. <code>annotations</code></br>
  4796. <em>
  4797. map[string]string
  4798. </em>
  4799. </td>
  4800. <td>
  4801. <em>(Optional)</em>
  4802. </td>
  4803. </tr>
  4804. <tr>
  4805. <td>
  4806. <code>labels</code></br>
  4807. <em>
  4808. map[string]string
  4809. </em>
  4810. </td>
  4811. <td>
  4812. <em>(Optional)</em>
  4813. </td>
  4814. </tr>
  4815. </tbody>
  4816. </table>
  4817. <h3 id="external-secrets.io/v1beta1.ExternalSecretValidator">ExternalSecretValidator
  4818. </h3>
  4819. <p>
  4820. </p>
  4821. <h3 id="external-secrets.io/v1beta1.FakeProvider">FakeProvider
  4822. </h3>
  4823. <p>
  4824. (<em>Appears on:</em>
  4825. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4826. </p>
  4827. <p>
  4828. <p>FakeProvider configures a fake provider that returns static values.</p>
  4829. </p>
  4830. <table>
  4831. <thead>
  4832. <tr>
  4833. <th>Field</th>
  4834. <th>Description</th>
  4835. </tr>
  4836. </thead>
  4837. <tbody>
  4838. <tr>
  4839. <td>
  4840. <code>data</code></br>
  4841. <em>
  4842. <a href="#external-secrets.io/v1beta1.FakeProviderData">
  4843. []FakeProviderData
  4844. </a>
  4845. </em>
  4846. </td>
  4847. <td>
  4848. </td>
  4849. </tr>
  4850. </tbody>
  4851. </table>
  4852. <h3 id="external-secrets.io/v1beta1.FakeProviderData">FakeProviderData
  4853. </h3>
  4854. <p>
  4855. (<em>Appears on:</em>
  4856. <a href="#external-secrets.io/v1beta1.FakeProvider">FakeProvider</a>)
  4857. </p>
  4858. <p>
  4859. </p>
  4860. <table>
  4861. <thead>
  4862. <tr>
  4863. <th>Field</th>
  4864. <th>Description</th>
  4865. </tr>
  4866. </thead>
  4867. <tbody>
  4868. <tr>
  4869. <td>
  4870. <code>key</code></br>
  4871. <em>
  4872. string
  4873. </em>
  4874. </td>
  4875. <td>
  4876. </td>
  4877. </tr>
  4878. <tr>
  4879. <td>
  4880. <code>value</code></br>
  4881. <em>
  4882. string
  4883. </em>
  4884. </td>
  4885. <td>
  4886. </td>
  4887. </tr>
  4888. <tr>
  4889. <td>
  4890. <code>valueMap</code></br>
  4891. <em>
  4892. map[string]string
  4893. </em>
  4894. </td>
  4895. <td>
  4896. <p>Deprecated: ValueMap is deprecated and is intended to be removed in the future, use the <code>value</code> field instead.</p>
  4897. </td>
  4898. </tr>
  4899. <tr>
  4900. <td>
  4901. <code>version</code></br>
  4902. <em>
  4903. string
  4904. </em>
  4905. </td>
  4906. <td>
  4907. </td>
  4908. </tr>
  4909. </tbody>
  4910. </table>
  4911. <h3 id="external-secrets.io/v1beta1.FindName">FindName
  4912. </h3>
  4913. <p>
  4914. (<em>Appears on:</em>
  4915. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  4916. </p>
  4917. <p>
  4918. </p>
  4919. <table>
  4920. <thead>
  4921. <tr>
  4922. <th>Field</th>
  4923. <th>Description</th>
  4924. </tr>
  4925. </thead>
  4926. <tbody>
  4927. <tr>
  4928. <td>
  4929. <code>regexp</code></br>
  4930. <em>
  4931. string
  4932. </em>
  4933. </td>
  4934. <td>
  4935. <em>(Optional)</em>
  4936. <p>Finds secrets base</p>
  4937. </td>
  4938. </tr>
  4939. </tbody>
  4940. </table>
  4941. <h3 id="external-secrets.io/v1beta1.FortanixProvider">FortanixProvider
  4942. </h3>
  4943. <p>
  4944. (<em>Appears on:</em>
  4945. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4946. </p>
  4947. <p>
  4948. </p>
  4949. <table>
  4950. <thead>
  4951. <tr>
  4952. <th>Field</th>
  4953. <th>Description</th>
  4954. </tr>
  4955. </thead>
  4956. <tbody>
  4957. <tr>
  4958. <td>
  4959. <code>apiUrl</code></br>
  4960. <em>
  4961. string
  4962. </em>
  4963. </td>
  4964. <td>
  4965. <p>APIURL is the URL of SDKMS API. Defaults to <code>sdkms.fortanix.com</code>.</p>
  4966. </td>
  4967. </tr>
  4968. <tr>
  4969. <td>
  4970. <code>apiKey</code></br>
  4971. <em>
  4972. <a href="#external-secrets.io/v1beta1.FortanixProviderSecretRef">
  4973. FortanixProviderSecretRef
  4974. </a>
  4975. </em>
  4976. </td>
  4977. <td>
  4978. <p>APIKey is the API token to access SDKMS Applications.</p>
  4979. </td>
  4980. </tr>
  4981. </tbody>
  4982. </table>
  4983. <h3 id="external-secrets.io/v1beta1.FortanixProviderSecretRef">FortanixProviderSecretRef
  4984. </h3>
  4985. <p>
  4986. (<em>Appears on:</em>
  4987. <a href="#external-secrets.io/v1beta1.FortanixProvider">FortanixProvider</a>)
  4988. </p>
  4989. <p>
  4990. </p>
  4991. <table>
  4992. <thead>
  4993. <tr>
  4994. <th>Field</th>
  4995. <th>Description</th>
  4996. </tr>
  4997. </thead>
  4998. <tbody>
  4999. <tr>
  5000. <td>
  5001. <code>secretRef</code></br>
  5002. <em>
  5003. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5004. External Secrets meta/v1.SecretKeySelector
  5005. </a>
  5006. </em>
  5007. </td>
  5008. <td>
  5009. <p>SecretRef is a reference to a secret containing the SDKMS API Key.</p>
  5010. </td>
  5011. </tr>
  5012. </tbody>
  5013. </table>
  5014. <h3 id="external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth
  5015. </h3>
  5016. <p>
  5017. (<em>Appears on:</em>
  5018. <a href="#external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider</a>)
  5019. </p>
  5020. <p>
  5021. </p>
  5022. <table>
  5023. <thead>
  5024. <tr>
  5025. <th>Field</th>
  5026. <th>Description</th>
  5027. </tr>
  5028. </thead>
  5029. <tbody>
  5030. <tr>
  5031. <td>
  5032. <code>secretRef</code></br>
  5033. <em>
  5034. <a href="#external-secrets.io/v1beta1.GCPSMAuthSecretRef">
  5035. GCPSMAuthSecretRef
  5036. </a>
  5037. </em>
  5038. </td>
  5039. <td>
  5040. <em>(Optional)</em>
  5041. </td>
  5042. </tr>
  5043. <tr>
  5044. <td>
  5045. <code>workloadIdentity</code></br>
  5046. <em>
  5047. <a href="#external-secrets.io/v1beta1.GCPWorkloadIdentity">
  5048. GCPWorkloadIdentity
  5049. </a>
  5050. </em>
  5051. </td>
  5052. <td>
  5053. <em>(Optional)</em>
  5054. </td>
  5055. </tr>
  5056. </tbody>
  5057. </table>
  5058. <h3 id="external-secrets.io/v1beta1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  5059. </h3>
  5060. <p>
  5061. (<em>Appears on:</em>
  5062. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  5063. </p>
  5064. <p>
  5065. </p>
  5066. <table>
  5067. <thead>
  5068. <tr>
  5069. <th>Field</th>
  5070. <th>Description</th>
  5071. </tr>
  5072. </thead>
  5073. <tbody>
  5074. <tr>
  5075. <td>
  5076. <code>secretAccessKeySecretRef</code></br>
  5077. <em>
  5078. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5079. External Secrets meta/v1.SecretKeySelector
  5080. </a>
  5081. </em>
  5082. </td>
  5083. <td>
  5084. <em>(Optional)</em>
  5085. <p>The SecretAccessKey is used for authentication</p>
  5086. </td>
  5087. </tr>
  5088. </tbody>
  5089. </table>
  5090. <h3 id="external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider
  5091. </h3>
  5092. <p>
  5093. (<em>Appears on:</em>
  5094. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5095. </p>
  5096. <p>
  5097. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  5098. </p>
  5099. <table>
  5100. <thead>
  5101. <tr>
  5102. <th>Field</th>
  5103. <th>Description</th>
  5104. </tr>
  5105. </thead>
  5106. <tbody>
  5107. <tr>
  5108. <td>
  5109. <code>auth</code></br>
  5110. <em>
  5111. <a href="#external-secrets.io/v1beta1.GCPSMAuth">
  5112. GCPSMAuth
  5113. </a>
  5114. </em>
  5115. </td>
  5116. <td>
  5117. <em>(Optional)</em>
  5118. <p>Auth defines the information necessary to authenticate against GCP</p>
  5119. </td>
  5120. </tr>
  5121. <tr>
  5122. <td>
  5123. <code>projectID</code></br>
  5124. <em>
  5125. string
  5126. </em>
  5127. </td>
  5128. <td>
  5129. <p>ProjectID project where secret is located</p>
  5130. </td>
  5131. </tr>
  5132. </tbody>
  5133. </table>
  5134. <h3 id="external-secrets.io/v1beta1.GCPWorkloadIdentity">GCPWorkloadIdentity
  5135. </h3>
  5136. <p>
  5137. (<em>Appears on:</em>
  5138. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  5139. </p>
  5140. <p>
  5141. </p>
  5142. <table>
  5143. <thead>
  5144. <tr>
  5145. <th>Field</th>
  5146. <th>Description</th>
  5147. </tr>
  5148. </thead>
  5149. <tbody>
  5150. <tr>
  5151. <td>
  5152. <code>serviceAccountRef</code></br>
  5153. <em>
  5154. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  5155. External Secrets meta/v1.ServiceAccountSelector
  5156. </a>
  5157. </em>
  5158. </td>
  5159. <td>
  5160. </td>
  5161. </tr>
  5162. <tr>
  5163. <td>
  5164. <code>clusterLocation</code></br>
  5165. <em>
  5166. string
  5167. </em>
  5168. </td>
  5169. <td>
  5170. </td>
  5171. </tr>
  5172. <tr>
  5173. <td>
  5174. <code>clusterName</code></br>
  5175. <em>
  5176. string
  5177. </em>
  5178. </td>
  5179. <td>
  5180. </td>
  5181. </tr>
  5182. <tr>
  5183. <td>
  5184. <code>clusterProjectID</code></br>
  5185. <em>
  5186. string
  5187. </em>
  5188. </td>
  5189. <td>
  5190. </td>
  5191. </tr>
  5192. </tbody>
  5193. </table>
  5194. <h3 id="external-secrets.io/v1beta1.GeneratorRef">GeneratorRef
  5195. </h3>
  5196. <p>
  5197. (<em>Appears on:</em>
  5198. <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef</a>,
  5199. <a href="#external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef</a>)
  5200. </p>
  5201. <p>
  5202. <p>GeneratorRef points to a generator custom resource.</p>
  5203. </p>
  5204. <table>
  5205. <thead>
  5206. <tr>
  5207. <th>Field</th>
  5208. <th>Description</th>
  5209. </tr>
  5210. </thead>
  5211. <tbody>
  5212. <tr>
  5213. <td>
  5214. <code>apiVersion</code></br>
  5215. <em>
  5216. string
  5217. </em>
  5218. </td>
  5219. <td>
  5220. <p>Specify the apiVersion of the generator resource</p>
  5221. </td>
  5222. </tr>
  5223. <tr>
  5224. <td>
  5225. <code>kind</code></br>
  5226. <em>
  5227. string
  5228. </em>
  5229. </td>
  5230. <td>
  5231. <p>Specify the Kind of the resource, e.g. Password, ACRAccessToken etc.</p>
  5232. </td>
  5233. </tr>
  5234. <tr>
  5235. <td>
  5236. <code>name</code></br>
  5237. <em>
  5238. string
  5239. </em>
  5240. </td>
  5241. <td>
  5242. <p>Specify the name of the generator resource</p>
  5243. </td>
  5244. </tr>
  5245. </tbody>
  5246. </table>
  5247. <h3 id="external-secrets.io/v1beta1.GenericStore">GenericStore
  5248. </h3>
  5249. <p>
  5250. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  5251. or a namespaced SecretStore.</p>
  5252. </p>
  5253. <h3 id="external-secrets.io/v1beta1.GenericStoreValidator">GenericStoreValidator
  5254. </h3>
  5255. <p>
  5256. </p>
  5257. <h3 id="external-secrets.io/v1beta1.GitlabAuth">GitlabAuth
  5258. </h3>
  5259. <p>
  5260. (<em>Appears on:</em>
  5261. <a href="#external-secrets.io/v1beta1.GitlabProvider">GitlabProvider</a>)
  5262. </p>
  5263. <p>
  5264. </p>
  5265. <table>
  5266. <thead>
  5267. <tr>
  5268. <th>Field</th>
  5269. <th>Description</th>
  5270. </tr>
  5271. </thead>
  5272. <tbody>
  5273. <tr>
  5274. <td>
  5275. <code>SecretRef</code></br>
  5276. <em>
  5277. <a href="#external-secrets.io/v1beta1.GitlabSecretRef">
  5278. GitlabSecretRef
  5279. </a>
  5280. </em>
  5281. </td>
  5282. <td>
  5283. </td>
  5284. </tr>
  5285. </tbody>
  5286. </table>
  5287. <h3 id="external-secrets.io/v1beta1.GitlabProvider">GitlabProvider
  5288. </h3>
  5289. <p>
  5290. (<em>Appears on:</em>
  5291. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5292. </p>
  5293. <p>
  5294. <p>Configures a store to sync secrets with a GitLab instance.</p>
  5295. </p>
  5296. <table>
  5297. <thead>
  5298. <tr>
  5299. <th>Field</th>
  5300. <th>Description</th>
  5301. </tr>
  5302. </thead>
  5303. <tbody>
  5304. <tr>
  5305. <td>
  5306. <code>url</code></br>
  5307. <em>
  5308. string
  5309. </em>
  5310. </td>
  5311. <td>
  5312. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
  5313. </td>
  5314. </tr>
  5315. <tr>
  5316. <td>
  5317. <code>auth</code></br>
  5318. <em>
  5319. <a href="#external-secrets.io/v1beta1.GitlabAuth">
  5320. GitlabAuth
  5321. </a>
  5322. </em>
  5323. </td>
  5324. <td>
  5325. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
  5326. </td>
  5327. </tr>
  5328. <tr>
  5329. <td>
  5330. <code>projectID</code></br>
  5331. <em>
  5332. string
  5333. </em>
  5334. </td>
  5335. <td>
  5336. <p>ProjectID specifies a project where secrets are located.</p>
  5337. </td>
  5338. </tr>
  5339. <tr>
  5340. <td>
  5341. <code>inheritFromGroups</code></br>
  5342. <em>
  5343. bool
  5344. </em>
  5345. </td>
  5346. <td>
  5347. <p>InheritFromGroups specifies whether parent groups should be discovered and checked for secrets.</p>
  5348. </td>
  5349. </tr>
  5350. <tr>
  5351. <td>
  5352. <code>groupIDs</code></br>
  5353. <em>
  5354. []string
  5355. </em>
  5356. </td>
  5357. <td>
  5358. <p>GroupIDs specify, which gitlab groups to pull secrets from. Group secrets are read from left to right followed by the project variables.</p>
  5359. </td>
  5360. </tr>
  5361. <tr>
  5362. <td>
  5363. <code>environment</code></br>
  5364. <em>
  5365. string
  5366. </em>
  5367. </td>
  5368. <td>
  5369. <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>
  5370. </td>
  5371. </tr>
  5372. </tbody>
  5373. </table>
  5374. <h3 id="external-secrets.io/v1beta1.GitlabSecretRef">GitlabSecretRef
  5375. </h3>
  5376. <p>
  5377. (<em>Appears on:</em>
  5378. <a href="#external-secrets.io/v1beta1.GitlabAuth">GitlabAuth</a>)
  5379. </p>
  5380. <p>
  5381. </p>
  5382. <table>
  5383. <thead>
  5384. <tr>
  5385. <th>Field</th>
  5386. <th>Description</th>
  5387. </tr>
  5388. </thead>
  5389. <tbody>
  5390. <tr>
  5391. <td>
  5392. <code>accessToken</code></br>
  5393. <em>
  5394. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5395. External Secrets meta/v1.SecretKeySelector
  5396. </a>
  5397. </em>
  5398. </td>
  5399. <td>
  5400. <p>AccessToken is used for authentication.</p>
  5401. </td>
  5402. </tr>
  5403. </tbody>
  5404. </table>
  5405. <h3 id="external-secrets.io/v1beta1.IBMAuth">IBMAuth
  5406. </h3>
  5407. <p>
  5408. (<em>Appears on:</em>
  5409. <a href="#external-secrets.io/v1beta1.IBMProvider">IBMProvider</a>)
  5410. </p>
  5411. <p>
  5412. </p>
  5413. <table>
  5414. <thead>
  5415. <tr>
  5416. <th>Field</th>
  5417. <th>Description</th>
  5418. </tr>
  5419. </thead>
  5420. <tbody>
  5421. <tr>
  5422. <td>
  5423. <code>secretRef</code></br>
  5424. <em>
  5425. <a href="#external-secrets.io/v1beta1.IBMAuthSecretRef">
  5426. IBMAuthSecretRef
  5427. </a>
  5428. </em>
  5429. </td>
  5430. <td>
  5431. </td>
  5432. </tr>
  5433. <tr>
  5434. <td>
  5435. <code>containerAuth</code></br>
  5436. <em>
  5437. <a href="#external-secrets.io/v1beta1.IBMAuthContainerAuth">
  5438. IBMAuthContainerAuth
  5439. </a>
  5440. </em>
  5441. </td>
  5442. <td>
  5443. </td>
  5444. </tr>
  5445. </tbody>
  5446. </table>
  5447. <h3 id="external-secrets.io/v1beta1.IBMAuthContainerAuth">IBMAuthContainerAuth
  5448. </h3>
  5449. <p>
  5450. (<em>Appears on:</em>
  5451. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  5452. </p>
  5453. <p>
  5454. <p>IBM Container-based auth with IAM Trusted Profile.</p>
  5455. </p>
  5456. <table>
  5457. <thead>
  5458. <tr>
  5459. <th>Field</th>
  5460. <th>Description</th>
  5461. </tr>
  5462. </thead>
  5463. <tbody>
  5464. <tr>
  5465. <td>
  5466. <code>profile</code></br>
  5467. <em>
  5468. string
  5469. </em>
  5470. </td>
  5471. <td>
  5472. <p>the IBM Trusted Profile</p>
  5473. </td>
  5474. </tr>
  5475. <tr>
  5476. <td>
  5477. <code>tokenLocation</code></br>
  5478. <em>
  5479. string
  5480. </em>
  5481. </td>
  5482. <td>
  5483. <p>Location the token is mounted on the pod</p>
  5484. </td>
  5485. </tr>
  5486. <tr>
  5487. <td>
  5488. <code>iamEndpoint</code></br>
  5489. <em>
  5490. string
  5491. </em>
  5492. </td>
  5493. <td>
  5494. </td>
  5495. </tr>
  5496. </tbody>
  5497. </table>
  5498. <h3 id="external-secrets.io/v1beta1.IBMAuthSecretRef">IBMAuthSecretRef
  5499. </h3>
  5500. <p>
  5501. (<em>Appears on:</em>
  5502. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  5503. </p>
  5504. <p>
  5505. </p>
  5506. <table>
  5507. <thead>
  5508. <tr>
  5509. <th>Field</th>
  5510. <th>Description</th>
  5511. </tr>
  5512. </thead>
  5513. <tbody>
  5514. <tr>
  5515. <td>
  5516. <code>secretApiKeySecretRef</code></br>
  5517. <em>
  5518. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5519. External Secrets meta/v1.SecretKeySelector
  5520. </a>
  5521. </em>
  5522. </td>
  5523. <td>
  5524. <p>The SecretAccessKey is used for authentication</p>
  5525. </td>
  5526. </tr>
  5527. </tbody>
  5528. </table>
  5529. <h3 id="external-secrets.io/v1beta1.IBMProvider">IBMProvider
  5530. </h3>
  5531. <p>
  5532. (<em>Appears on:</em>
  5533. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5534. </p>
  5535. <p>
  5536. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
  5537. backend.</p>
  5538. </p>
  5539. <table>
  5540. <thead>
  5541. <tr>
  5542. <th>Field</th>
  5543. <th>Description</th>
  5544. </tr>
  5545. </thead>
  5546. <tbody>
  5547. <tr>
  5548. <td>
  5549. <code>auth</code></br>
  5550. <em>
  5551. <a href="#external-secrets.io/v1beta1.IBMAuth">
  5552. IBMAuth
  5553. </a>
  5554. </em>
  5555. </td>
  5556. <td>
  5557. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
  5558. </td>
  5559. </tr>
  5560. <tr>
  5561. <td>
  5562. <code>serviceUrl</code></br>
  5563. <em>
  5564. string
  5565. </em>
  5566. </td>
  5567. <td>
  5568. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
  5569. </td>
  5570. </tr>
  5571. </tbody>
  5572. </table>
  5573. <h3 id="external-secrets.io/v1beta1.KeeperSecurityProvider">KeeperSecurityProvider
  5574. </h3>
  5575. <p>
  5576. (<em>Appears on:</em>
  5577. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5578. </p>
  5579. <p>
  5580. <p>KeeperSecurityProvider Configures a store to sync secrets using Keeper Security.</p>
  5581. </p>
  5582. <table>
  5583. <thead>
  5584. <tr>
  5585. <th>Field</th>
  5586. <th>Description</th>
  5587. </tr>
  5588. </thead>
  5589. <tbody>
  5590. <tr>
  5591. <td>
  5592. <code>authRef</code></br>
  5593. <em>
  5594. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5595. External Secrets meta/v1.SecretKeySelector
  5596. </a>
  5597. </em>
  5598. </td>
  5599. <td>
  5600. </td>
  5601. </tr>
  5602. <tr>
  5603. <td>
  5604. <code>folderID</code></br>
  5605. <em>
  5606. string
  5607. </em>
  5608. </td>
  5609. <td>
  5610. </td>
  5611. </tr>
  5612. </tbody>
  5613. </table>
  5614. <h3 id="external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth
  5615. </h3>
  5616. <p>
  5617. (<em>Appears on:</em>
  5618. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  5619. </p>
  5620. <p>
  5621. </p>
  5622. <table>
  5623. <thead>
  5624. <tr>
  5625. <th>Field</th>
  5626. <th>Description</th>
  5627. </tr>
  5628. </thead>
  5629. <tbody>
  5630. <tr>
  5631. <td>
  5632. <code>cert</code></br>
  5633. <em>
  5634. <a href="#external-secrets.io/v1beta1.CertAuth">
  5635. CertAuth
  5636. </a>
  5637. </em>
  5638. </td>
  5639. <td>
  5640. <em>(Optional)</em>
  5641. <p>has both clientCert and clientKey as secretKeySelector</p>
  5642. </td>
  5643. </tr>
  5644. <tr>
  5645. <td>
  5646. <code>token</code></br>
  5647. <em>
  5648. <a href="#external-secrets.io/v1beta1.TokenAuth">
  5649. TokenAuth
  5650. </a>
  5651. </em>
  5652. </td>
  5653. <td>
  5654. <em>(Optional)</em>
  5655. <p>use static token to authenticate with</p>
  5656. </td>
  5657. </tr>
  5658. <tr>
  5659. <td>
  5660. <code>serviceAccount</code></br>
  5661. <em>
  5662. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  5663. External Secrets meta/v1.ServiceAccountSelector
  5664. </a>
  5665. </em>
  5666. </td>
  5667. <td>
  5668. <em>(Optional)</em>
  5669. <p>points to a service account that should be used for authentication</p>
  5670. </td>
  5671. </tr>
  5672. </tbody>
  5673. </table>
  5674. <h3 id="external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider
  5675. </h3>
  5676. <p>
  5677. (<em>Appears on:</em>
  5678. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5679. </p>
  5680. <p>
  5681. <p>Configures a store to sync secrets with a Kubernetes instance.</p>
  5682. </p>
  5683. <table>
  5684. <thead>
  5685. <tr>
  5686. <th>Field</th>
  5687. <th>Description</th>
  5688. </tr>
  5689. </thead>
  5690. <tbody>
  5691. <tr>
  5692. <td>
  5693. <code>server</code></br>
  5694. <em>
  5695. <a href="#external-secrets.io/v1beta1.KubernetesServer">
  5696. KubernetesServer
  5697. </a>
  5698. </em>
  5699. </td>
  5700. <td>
  5701. <p>configures the Kubernetes server Address.</p>
  5702. </td>
  5703. </tr>
  5704. <tr>
  5705. <td>
  5706. <code>auth</code></br>
  5707. <em>
  5708. <a href="#external-secrets.io/v1beta1.KubernetesAuth">
  5709. KubernetesAuth
  5710. </a>
  5711. </em>
  5712. </td>
  5713. <td>
  5714. <p>Auth configures how secret-manager authenticates with a Kubernetes instance.</p>
  5715. </td>
  5716. </tr>
  5717. <tr>
  5718. <td>
  5719. <code>remoteNamespace</code></br>
  5720. <em>
  5721. string
  5722. </em>
  5723. </td>
  5724. <td>
  5725. <em>(Optional)</em>
  5726. <p>Remote namespace to fetch the secrets from</p>
  5727. </td>
  5728. </tr>
  5729. </tbody>
  5730. </table>
  5731. <h3 id="external-secrets.io/v1beta1.KubernetesServer">KubernetesServer
  5732. </h3>
  5733. <p>
  5734. (<em>Appears on:</em>
  5735. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  5736. </p>
  5737. <p>
  5738. </p>
  5739. <table>
  5740. <thead>
  5741. <tr>
  5742. <th>Field</th>
  5743. <th>Description</th>
  5744. </tr>
  5745. </thead>
  5746. <tbody>
  5747. <tr>
  5748. <td>
  5749. <code>url</code></br>
  5750. <em>
  5751. string
  5752. </em>
  5753. </td>
  5754. <td>
  5755. <em>(Optional)</em>
  5756. <p>configures the Kubernetes server Address.</p>
  5757. </td>
  5758. </tr>
  5759. <tr>
  5760. <td>
  5761. <code>caBundle</code></br>
  5762. <em>
  5763. []byte
  5764. </em>
  5765. </td>
  5766. <td>
  5767. <em>(Optional)</em>
  5768. <p>CABundle is a base64-encoded CA certificate</p>
  5769. </td>
  5770. </tr>
  5771. <tr>
  5772. <td>
  5773. <code>caProvider</code></br>
  5774. <em>
  5775. <a href="#external-secrets.io/v1beta1.CAProvider">
  5776. CAProvider
  5777. </a>
  5778. </em>
  5779. </td>
  5780. <td>
  5781. <em>(Optional)</em>
  5782. <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>
  5783. </td>
  5784. </tr>
  5785. </tbody>
  5786. </table>
  5787. <h3 id="external-secrets.io/v1beta1.NoSecretError">NoSecretError
  5788. </h3>
  5789. <p>
  5790. <p>NoSecretError shall be returned when a GetSecret can not find the
  5791. desired secret. This is used for deletionPolicy.</p>
  5792. </p>
  5793. <h3 id="external-secrets.io/v1beta1.OnboardbaseAuthSecretRef">OnboardbaseAuthSecretRef
  5794. </h3>
  5795. <p>
  5796. (<em>Appears on:</em>
  5797. <a href="#external-secrets.io/v1beta1.OnboardbaseProvider">OnboardbaseProvider</a>)
  5798. </p>
  5799. <p>
  5800. <p>OnboardbaseAuthSecretRef holds secret references for onboardbase API Key credentials.</p>
  5801. </p>
  5802. <table>
  5803. <thead>
  5804. <tr>
  5805. <th>Field</th>
  5806. <th>Description</th>
  5807. </tr>
  5808. </thead>
  5809. <tbody>
  5810. <tr>
  5811. <td>
  5812. <code>apiKeyRef</code></br>
  5813. <em>
  5814. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5815. External Secrets meta/v1.SecretKeySelector
  5816. </a>
  5817. </em>
  5818. </td>
  5819. <td>
  5820. <p>OnboardbaseAPIKey is the APIKey generated by an admin account.
  5821. It is used to recognize and authorize access to a project and environment within onboardbase</p>
  5822. </td>
  5823. </tr>
  5824. <tr>
  5825. <td>
  5826. <code>passcodeRef</code></br>
  5827. <em>
  5828. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5829. External Secrets meta/v1.SecretKeySelector
  5830. </a>
  5831. </em>
  5832. </td>
  5833. <td>
  5834. <p>OnboardbasePasscode is the passcode attached to the API Key</p>
  5835. </td>
  5836. </tr>
  5837. </tbody>
  5838. </table>
  5839. <h3 id="external-secrets.io/v1beta1.OnboardbaseProvider">OnboardbaseProvider
  5840. </h3>
  5841. <p>
  5842. (<em>Appears on:</em>
  5843. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5844. </p>
  5845. <p>
  5846. <p>OnboardbaseProvider configures a store to sync secrets using the Onboardbase provider.
  5847. Project and Config are required if not using a Service Token.</p>
  5848. </p>
  5849. <table>
  5850. <thead>
  5851. <tr>
  5852. <th>Field</th>
  5853. <th>Description</th>
  5854. </tr>
  5855. </thead>
  5856. <tbody>
  5857. <tr>
  5858. <td>
  5859. <code>auth</code></br>
  5860. <em>
  5861. <a href="#external-secrets.io/v1beta1.OnboardbaseAuthSecretRef">
  5862. OnboardbaseAuthSecretRef
  5863. </a>
  5864. </em>
  5865. </td>
  5866. <td>
  5867. <p>Auth configures how the Operator authenticates with the Onboardbase API</p>
  5868. </td>
  5869. </tr>
  5870. <tr>
  5871. <td>
  5872. <code>apiHost</code></br>
  5873. <em>
  5874. string
  5875. </em>
  5876. </td>
  5877. <td>
  5878. <p>APIHost use this to configure the host url for the API for selfhosted installation, default is <a href="https://public.onboardbase.com/api/v1/">https://public.onboardbase.com/api/v1/</a></p>
  5879. </td>
  5880. </tr>
  5881. <tr>
  5882. <td>
  5883. <code>project</code></br>
  5884. <em>
  5885. string
  5886. </em>
  5887. </td>
  5888. <td>
  5889. <p>Project is an onboardbase project that the secrets should be pulled from</p>
  5890. </td>
  5891. </tr>
  5892. <tr>
  5893. <td>
  5894. <code>environment</code></br>
  5895. <em>
  5896. string
  5897. </em>
  5898. </td>
  5899. <td>
  5900. <p>Environment is the name of an environmnent within a project to pull the secrets from</p>
  5901. </td>
  5902. </tr>
  5903. </tbody>
  5904. </table>
  5905. <h3 id="external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth
  5906. </h3>
  5907. <p>
  5908. (<em>Appears on:</em>
  5909. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider</a>)
  5910. </p>
  5911. <p>
  5912. <p>OnePasswordAuth contains a secretRef for credentials.</p>
  5913. </p>
  5914. <table>
  5915. <thead>
  5916. <tr>
  5917. <th>Field</th>
  5918. <th>Description</th>
  5919. </tr>
  5920. </thead>
  5921. <tbody>
  5922. <tr>
  5923. <td>
  5924. <code>secretRef</code></br>
  5925. <em>
  5926. <a href="#external-secrets.io/v1beta1.OnePasswordAuthSecretRef">
  5927. OnePasswordAuthSecretRef
  5928. </a>
  5929. </em>
  5930. </td>
  5931. <td>
  5932. </td>
  5933. </tr>
  5934. </tbody>
  5935. </table>
  5936. <h3 id="external-secrets.io/v1beta1.OnePasswordAuthSecretRef">OnePasswordAuthSecretRef
  5937. </h3>
  5938. <p>
  5939. (<em>Appears on:</em>
  5940. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth</a>)
  5941. </p>
  5942. <p>
  5943. <p>OnePasswordAuthSecretRef holds secret references for 1Password credentials.</p>
  5944. </p>
  5945. <table>
  5946. <thead>
  5947. <tr>
  5948. <th>Field</th>
  5949. <th>Description</th>
  5950. </tr>
  5951. </thead>
  5952. <tbody>
  5953. <tr>
  5954. <td>
  5955. <code>connectTokenSecretRef</code></br>
  5956. <em>
  5957. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5958. External Secrets meta/v1.SecretKeySelector
  5959. </a>
  5960. </em>
  5961. </td>
  5962. <td>
  5963. <p>The ConnectToken is used for authentication to a 1Password Connect Server.</p>
  5964. </td>
  5965. </tr>
  5966. </tbody>
  5967. </table>
  5968. <h3 id="external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider
  5969. </h3>
  5970. <p>
  5971. (<em>Appears on:</em>
  5972. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5973. </p>
  5974. <p>
  5975. <p>OnePasswordProvider configures a store to sync secrets using the 1Password Secret Manager provider.</p>
  5976. </p>
  5977. <table>
  5978. <thead>
  5979. <tr>
  5980. <th>Field</th>
  5981. <th>Description</th>
  5982. </tr>
  5983. </thead>
  5984. <tbody>
  5985. <tr>
  5986. <td>
  5987. <code>auth</code></br>
  5988. <em>
  5989. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">
  5990. OnePasswordAuth
  5991. </a>
  5992. </em>
  5993. </td>
  5994. <td>
  5995. <p>Auth defines the information necessary to authenticate against OnePassword Connect Server</p>
  5996. </td>
  5997. </tr>
  5998. <tr>
  5999. <td>
  6000. <code>connectHost</code></br>
  6001. <em>
  6002. string
  6003. </em>
  6004. </td>
  6005. <td>
  6006. <p>ConnectHost defines the OnePassword Connect Server to connect to</p>
  6007. </td>
  6008. </tr>
  6009. <tr>
  6010. <td>
  6011. <code>vaults</code></br>
  6012. <em>
  6013. map[string]int
  6014. </em>
  6015. </td>
  6016. <td>
  6017. <p>Vaults defines which OnePassword vaults to search in which order</p>
  6018. </td>
  6019. </tr>
  6020. </tbody>
  6021. </table>
  6022. <h3 id="external-secrets.io/v1beta1.OracleAuth">OracleAuth
  6023. </h3>
  6024. <p>
  6025. (<em>Appears on:</em>
  6026. <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
  6027. </p>
  6028. <p>
  6029. </p>
  6030. <table>
  6031. <thead>
  6032. <tr>
  6033. <th>Field</th>
  6034. <th>Description</th>
  6035. </tr>
  6036. </thead>
  6037. <tbody>
  6038. <tr>
  6039. <td>
  6040. <code>tenancy</code></br>
  6041. <em>
  6042. string
  6043. </em>
  6044. </td>
  6045. <td>
  6046. <p>Tenancy is the tenancy OCID where user is located.</p>
  6047. </td>
  6048. </tr>
  6049. <tr>
  6050. <td>
  6051. <code>user</code></br>
  6052. <em>
  6053. string
  6054. </em>
  6055. </td>
  6056. <td>
  6057. <p>User is an access OCID specific to the account.</p>
  6058. </td>
  6059. </tr>
  6060. <tr>
  6061. <td>
  6062. <code>secretRef</code></br>
  6063. <em>
  6064. <a href="#external-secrets.io/v1beta1.OracleSecretRef">
  6065. OracleSecretRef
  6066. </a>
  6067. </em>
  6068. </td>
  6069. <td>
  6070. <p>SecretRef to pass through sensitive information.</p>
  6071. </td>
  6072. </tr>
  6073. </tbody>
  6074. </table>
  6075. <h3 id="external-secrets.io/v1beta1.OraclePrincipalType">OraclePrincipalType
  6076. (<code>string</code> alias)</p></h3>
  6077. <p>
  6078. (<em>Appears on:</em>
  6079. <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
  6080. </p>
  6081. <p>
  6082. </p>
  6083. <table>
  6084. <thead>
  6085. <tr>
  6086. <th>Value</th>
  6087. <th>Description</th>
  6088. </tr>
  6089. </thead>
  6090. <tbody><tr><td><p>&#34;InstancePrincipal&#34;</p></td>
  6091. <td><p>InstancePrincipal represents a instance principal.</p>
  6092. </td>
  6093. </tr><tr><td><p>&#34;UserPrincipal&#34;</p></td>
  6094. <td><p>UserPrincipal represents a user principal.</p>
  6095. </td>
  6096. </tr><tr><td><p>&#34;Workload&#34;</p></td>
  6097. <td><p>WorkloadPrincipal represents a workload principal.</p>
  6098. </td>
  6099. </tr></tbody>
  6100. </table>
  6101. <h3 id="external-secrets.io/v1beta1.OracleProvider">OracleProvider
  6102. </h3>
  6103. <p>
  6104. (<em>Appears on:</em>
  6105. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6106. </p>
  6107. <p>
  6108. <p>Configures an store to sync secrets using a Oracle Vault
  6109. backend.</p>
  6110. </p>
  6111. <table>
  6112. <thead>
  6113. <tr>
  6114. <th>Field</th>
  6115. <th>Description</th>
  6116. </tr>
  6117. </thead>
  6118. <tbody>
  6119. <tr>
  6120. <td>
  6121. <code>region</code></br>
  6122. <em>
  6123. string
  6124. </em>
  6125. </td>
  6126. <td>
  6127. <p>Region is the region where vault is located.</p>
  6128. </td>
  6129. </tr>
  6130. <tr>
  6131. <td>
  6132. <code>vault</code></br>
  6133. <em>
  6134. string
  6135. </em>
  6136. </td>
  6137. <td>
  6138. <p>Vault is the vault&rsquo;s OCID of the specific vault where secret is located.</p>
  6139. </td>
  6140. </tr>
  6141. <tr>
  6142. <td>
  6143. <code>compartment</code></br>
  6144. <em>
  6145. string
  6146. </em>
  6147. </td>
  6148. <td>
  6149. <em>(Optional)</em>
  6150. <p>Compartment is the vault compartment OCID.
  6151. Required for PushSecret</p>
  6152. </td>
  6153. </tr>
  6154. <tr>
  6155. <td>
  6156. <code>encryptionKey</code></br>
  6157. <em>
  6158. string
  6159. </em>
  6160. </td>
  6161. <td>
  6162. <em>(Optional)</em>
  6163. <p>EncryptionKey is the OCID of the encryption key within the vault.
  6164. Required for PushSecret</p>
  6165. </td>
  6166. </tr>
  6167. <tr>
  6168. <td>
  6169. <code>principalType</code></br>
  6170. <em>
  6171. <a href="#external-secrets.io/v1beta1.OraclePrincipalType">
  6172. OraclePrincipalType
  6173. </a>
  6174. </em>
  6175. </td>
  6176. <td>
  6177. <em>(Optional)</em>
  6178. <p>The type of principal to use for authentication. If left blank, the Auth struct will
  6179. determine the principal type. This optional field must be specified if using
  6180. workload identity.</p>
  6181. </td>
  6182. </tr>
  6183. <tr>
  6184. <td>
  6185. <code>auth</code></br>
  6186. <em>
  6187. <a href="#external-secrets.io/v1beta1.OracleAuth">
  6188. OracleAuth
  6189. </a>
  6190. </em>
  6191. </td>
  6192. <td>
  6193. <em>(Optional)</em>
  6194. <p>Auth configures how secret-manager authenticates with the Oracle Vault.
  6195. If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
  6196. </td>
  6197. </tr>
  6198. <tr>
  6199. <td>
  6200. <code>serviceAccountRef</code></br>
  6201. <em>
  6202. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  6203. External Secrets meta/v1.ServiceAccountSelector
  6204. </a>
  6205. </em>
  6206. </td>
  6207. <td>
  6208. <em>(Optional)</em>
  6209. <p>ServiceAccountRef specified the service account
  6210. that should be used when authenticating with WorkloadIdentity.</p>
  6211. </td>
  6212. </tr>
  6213. </tbody>
  6214. </table>
  6215. <h3 id="external-secrets.io/v1beta1.OracleSecretRef">OracleSecretRef
  6216. </h3>
  6217. <p>
  6218. (<em>Appears on:</em>
  6219. <a href="#external-secrets.io/v1beta1.OracleAuth">OracleAuth</a>)
  6220. </p>
  6221. <p>
  6222. </p>
  6223. <table>
  6224. <thead>
  6225. <tr>
  6226. <th>Field</th>
  6227. <th>Description</th>
  6228. </tr>
  6229. </thead>
  6230. <tbody>
  6231. <tr>
  6232. <td>
  6233. <code>privatekey</code></br>
  6234. <em>
  6235. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6236. External Secrets meta/v1.SecretKeySelector
  6237. </a>
  6238. </em>
  6239. </td>
  6240. <td>
  6241. <p>PrivateKey is the user&rsquo;s API Signing Key in PEM format, used for authentication.</p>
  6242. </td>
  6243. </tr>
  6244. <tr>
  6245. <td>
  6246. <code>fingerprint</code></br>
  6247. <em>
  6248. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6249. External Secrets meta/v1.SecretKeySelector
  6250. </a>
  6251. </em>
  6252. </td>
  6253. <td>
  6254. <p>Fingerprint is the fingerprint of the API private key.</p>
  6255. </td>
  6256. </tr>
  6257. </tbody>
  6258. </table>
  6259. <h3 id="external-secrets.io/v1beta1.PasswordDepotAuth">PasswordDepotAuth
  6260. </h3>
  6261. <p>
  6262. (<em>Appears on:</em>
  6263. <a href="#external-secrets.io/v1beta1.PasswordDepotProvider">PasswordDepotProvider</a>)
  6264. </p>
  6265. <p>
  6266. </p>
  6267. <table>
  6268. <thead>
  6269. <tr>
  6270. <th>Field</th>
  6271. <th>Description</th>
  6272. </tr>
  6273. </thead>
  6274. <tbody>
  6275. <tr>
  6276. <td>
  6277. <code>secretRef</code></br>
  6278. <em>
  6279. <a href="#external-secrets.io/v1beta1.PasswordDepotSecretRef">
  6280. PasswordDepotSecretRef
  6281. </a>
  6282. </em>
  6283. </td>
  6284. <td>
  6285. </td>
  6286. </tr>
  6287. </tbody>
  6288. </table>
  6289. <h3 id="external-secrets.io/v1beta1.PasswordDepotProvider">PasswordDepotProvider
  6290. </h3>
  6291. <p>
  6292. (<em>Appears on:</em>
  6293. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6294. </p>
  6295. <p>
  6296. <p>Configures a store to sync secrets with a Password Depot instance.</p>
  6297. </p>
  6298. <table>
  6299. <thead>
  6300. <tr>
  6301. <th>Field</th>
  6302. <th>Description</th>
  6303. </tr>
  6304. </thead>
  6305. <tbody>
  6306. <tr>
  6307. <td>
  6308. <code>host</code></br>
  6309. <em>
  6310. string
  6311. </em>
  6312. </td>
  6313. <td>
  6314. <p>URL configures the Password Depot instance URL.</p>
  6315. </td>
  6316. </tr>
  6317. <tr>
  6318. <td>
  6319. <code>database</code></br>
  6320. <em>
  6321. string
  6322. </em>
  6323. </td>
  6324. <td>
  6325. <p>Database to use as source</p>
  6326. </td>
  6327. </tr>
  6328. <tr>
  6329. <td>
  6330. <code>auth</code></br>
  6331. <em>
  6332. <a href="#external-secrets.io/v1beta1.PasswordDepotAuth">
  6333. PasswordDepotAuth
  6334. </a>
  6335. </em>
  6336. </td>
  6337. <td>
  6338. <p>Auth configures how secret-manager authenticates with a Password Depot instance.</p>
  6339. </td>
  6340. </tr>
  6341. </tbody>
  6342. </table>
  6343. <h3 id="external-secrets.io/v1beta1.PasswordDepotSecretRef">PasswordDepotSecretRef
  6344. </h3>
  6345. <p>
  6346. (<em>Appears on:</em>
  6347. <a href="#external-secrets.io/v1beta1.PasswordDepotAuth">PasswordDepotAuth</a>)
  6348. </p>
  6349. <p>
  6350. </p>
  6351. <table>
  6352. <thead>
  6353. <tr>
  6354. <th>Field</th>
  6355. <th>Description</th>
  6356. </tr>
  6357. </thead>
  6358. <tbody>
  6359. <tr>
  6360. <td>
  6361. <code>credentials</code></br>
  6362. <em>
  6363. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6364. External Secrets meta/v1.SecretKeySelector
  6365. </a>
  6366. </em>
  6367. </td>
  6368. <td>
  6369. <em>(Optional)</em>
  6370. <p>Username / Password is used for authentication.</p>
  6371. </td>
  6372. </tr>
  6373. </tbody>
  6374. </table>
  6375. <h3 id="external-secrets.io/v1beta1.Provider">Provider
  6376. </h3>
  6377. <p>
  6378. <p>Provider is a common interface for interacting with secret backends.</p>
  6379. </p>
  6380. <h3 id="external-secrets.io/v1beta1.PulumiProvider">PulumiProvider
  6381. </h3>
  6382. <p>
  6383. (<em>Appears on:</em>
  6384. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6385. </p>
  6386. <p>
  6387. </p>
  6388. <table>
  6389. <thead>
  6390. <tr>
  6391. <th>Field</th>
  6392. <th>Description</th>
  6393. </tr>
  6394. </thead>
  6395. <tbody>
  6396. <tr>
  6397. <td>
  6398. <code>apiUrl</code></br>
  6399. <em>
  6400. string
  6401. </em>
  6402. </td>
  6403. <td>
  6404. <p>APIURL is the URL of the Pulumi API.</p>
  6405. </td>
  6406. </tr>
  6407. <tr>
  6408. <td>
  6409. <code>accessToken</code></br>
  6410. <em>
  6411. <a href="#external-secrets.io/v1beta1.PulumiProviderSecretRef">
  6412. PulumiProviderSecretRef
  6413. </a>
  6414. </em>
  6415. </td>
  6416. <td>
  6417. <p>AccessToken is the access tokens to sign in to the Pulumi Cloud Console.</p>
  6418. </td>
  6419. </tr>
  6420. <tr>
  6421. <td>
  6422. <code>organization</code></br>
  6423. <em>
  6424. string
  6425. </em>
  6426. </td>
  6427. <td>
  6428. <p>Organization are a space to collaborate on shared projects and stacks.
  6429. To create a new organization, visit <a href="https://app.pulumi.com/">https://app.pulumi.com/</a> and click &ldquo;New Organization&rdquo;.</p>
  6430. </td>
  6431. </tr>
  6432. <tr>
  6433. <td>
  6434. <code>environment</code></br>
  6435. <em>
  6436. string
  6437. </em>
  6438. </td>
  6439. <td>
  6440. <p>Environment are YAML documents composed of static key-value pairs, programmatic expressions,
  6441. dynamically retrieved values from supported providers including all major clouds,
  6442. and other Pulumi ESC environments.
  6443. To create a new environment, visit <a href="https://www.pulumi.com/docs/esc/environments/">https://www.pulumi.com/docs/esc/environments/</a> for more information.</p>
  6444. </td>
  6445. </tr>
  6446. </tbody>
  6447. </table>
  6448. <h3 id="external-secrets.io/v1beta1.PulumiProviderSecretRef">PulumiProviderSecretRef
  6449. </h3>
  6450. <p>
  6451. (<em>Appears on:</em>
  6452. <a href="#external-secrets.io/v1beta1.PulumiProvider">PulumiProvider</a>)
  6453. </p>
  6454. <p>
  6455. </p>
  6456. <table>
  6457. <thead>
  6458. <tr>
  6459. <th>Field</th>
  6460. <th>Description</th>
  6461. </tr>
  6462. </thead>
  6463. <tbody>
  6464. <tr>
  6465. <td>
  6466. <code>secretRef</code></br>
  6467. <em>
  6468. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6469. External Secrets meta/v1.SecretKeySelector
  6470. </a>
  6471. </em>
  6472. </td>
  6473. <td>
  6474. <p>SecretRef is a reference to a secret containing the Pulumi API token.</p>
  6475. </td>
  6476. </tr>
  6477. </tbody>
  6478. </table>
  6479. <h3 id="external-secrets.io/v1beta1.PushSecretData">PushSecretData
  6480. </h3>
  6481. <p>
  6482. <p>PushSecretData is an interface to allow using v1alpha1.PushSecretData content in Provider registered in v1beta1.</p>
  6483. </p>
  6484. <h3 id="external-secrets.io/v1beta1.PushSecretRemoteRef">PushSecretRemoteRef
  6485. </h3>
  6486. <p>
  6487. <p>PushSecretRemoteRef is an interface to allow using v1alpha1.PushSecretRemoteRef in Provider registered in v1beta1.</p>
  6488. </p>
  6489. <h3 id="external-secrets.io/v1beta1.ScalewayProvider">ScalewayProvider
  6490. </h3>
  6491. <p>
  6492. (<em>Appears on:</em>
  6493. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6494. </p>
  6495. <p>
  6496. </p>
  6497. <table>
  6498. <thead>
  6499. <tr>
  6500. <th>Field</th>
  6501. <th>Description</th>
  6502. </tr>
  6503. </thead>
  6504. <tbody>
  6505. <tr>
  6506. <td>
  6507. <code>apiUrl</code></br>
  6508. <em>
  6509. string
  6510. </em>
  6511. </td>
  6512. <td>
  6513. <em>(Optional)</em>
  6514. <p>APIURL is the url of the api to use. Defaults to <a href="https://api.scaleway.com">https://api.scaleway.com</a></p>
  6515. </td>
  6516. </tr>
  6517. <tr>
  6518. <td>
  6519. <code>region</code></br>
  6520. <em>
  6521. string
  6522. </em>
  6523. </td>
  6524. <td>
  6525. <p>Region where your secrets are located: <a href="https://developers.scaleway.com/en/quickstart/#region-and-zone">https://developers.scaleway.com/en/quickstart/#region-and-zone</a></p>
  6526. </td>
  6527. </tr>
  6528. <tr>
  6529. <td>
  6530. <code>projectId</code></br>
  6531. <em>
  6532. string
  6533. </em>
  6534. </td>
  6535. <td>
  6536. <p>ProjectID is the id of your project, which you can find in the console: <a href="https://console.scaleway.com/project/settings">https://console.scaleway.com/project/settings</a></p>
  6537. </td>
  6538. </tr>
  6539. <tr>
  6540. <td>
  6541. <code>accessKey</code></br>
  6542. <em>
  6543. <a href="#external-secrets.io/v1beta1.ScalewayProviderSecretRef">
  6544. ScalewayProviderSecretRef
  6545. </a>
  6546. </em>
  6547. </td>
  6548. <td>
  6549. <p>AccessKey is the non-secret part of the api key.</p>
  6550. </td>
  6551. </tr>
  6552. <tr>
  6553. <td>
  6554. <code>secretKey</code></br>
  6555. <em>
  6556. <a href="#external-secrets.io/v1beta1.ScalewayProviderSecretRef">
  6557. ScalewayProviderSecretRef
  6558. </a>
  6559. </em>
  6560. </td>
  6561. <td>
  6562. <p>SecretKey is the non-secret part of the api key.</p>
  6563. </td>
  6564. </tr>
  6565. </tbody>
  6566. </table>
  6567. <h3 id="external-secrets.io/v1beta1.ScalewayProviderSecretRef">ScalewayProviderSecretRef
  6568. </h3>
  6569. <p>
  6570. (<em>Appears on:</em>
  6571. <a href="#external-secrets.io/v1beta1.ScalewayProvider">ScalewayProvider</a>)
  6572. </p>
  6573. <p>
  6574. </p>
  6575. <table>
  6576. <thead>
  6577. <tr>
  6578. <th>Field</th>
  6579. <th>Description</th>
  6580. </tr>
  6581. </thead>
  6582. <tbody>
  6583. <tr>
  6584. <td>
  6585. <code>value</code></br>
  6586. <em>
  6587. string
  6588. </em>
  6589. </td>
  6590. <td>
  6591. <em>(Optional)</em>
  6592. <p>Value can be specified directly to set a value without using a secret.</p>
  6593. </td>
  6594. </tr>
  6595. <tr>
  6596. <td>
  6597. <code>secretRef</code></br>
  6598. <em>
  6599. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6600. External Secrets meta/v1.SecretKeySelector
  6601. </a>
  6602. </em>
  6603. </td>
  6604. <td>
  6605. <em>(Optional)</em>
  6606. <p>SecretRef references a key in a secret that will be used as value.</p>
  6607. </td>
  6608. </tr>
  6609. </tbody>
  6610. </table>
  6611. <h3 id="external-secrets.io/v1beta1.SecretStore">SecretStore
  6612. </h3>
  6613. <p>
  6614. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  6615. </p>
  6616. <table>
  6617. <thead>
  6618. <tr>
  6619. <th>Field</th>
  6620. <th>Description</th>
  6621. </tr>
  6622. </thead>
  6623. <tbody>
  6624. <tr>
  6625. <td>
  6626. <code>metadata</code></br>
  6627. <em>
  6628. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  6629. Kubernetes meta/v1.ObjectMeta
  6630. </a>
  6631. </em>
  6632. </td>
  6633. <td>
  6634. Refer to the Kubernetes API documentation for the fields of the
  6635. <code>metadata</code> field.
  6636. </td>
  6637. </tr>
  6638. <tr>
  6639. <td>
  6640. <code>spec</code></br>
  6641. <em>
  6642. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  6643. SecretStoreSpec
  6644. </a>
  6645. </em>
  6646. </td>
  6647. <td>
  6648. <br/>
  6649. <br/>
  6650. <table>
  6651. <tr>
  6652. <td>
  6653. <code>controller</code></br>
  6654. <em>
  6655. string
  6656. </em>
  6657. </td>
  6658. <td>
  6659. <em>(Optional)</em>
  6660. <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
  6661. The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
  6662. </td>
  6663. </tr>
  6664. <tr>
  6665. <td>
  6666. <code>provider</code></br>
  6667. <em>
  6668. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  6669. SecretStoreProvider
  6670. </a>
  6671. </em>
  6672. </td>
  6673. <td>
  6674. <p>Used to configure the provider. Only one provider may be set</p>
  6675. </td>
  6676. </tr>
  6677. <tr>
  6678. <td>
  6679. <code>retrySettings</code></br>
  6680. <em>
  6681. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  6682. SecretStoreRetrySettings
  6683. </a>
  6684. </em>
  6685. </td>
  6686. <td>
  6687. <em>(Optional)</em>
  6688. <p>Used to configure http retries if failed</p>
  6689. </td>
  6690. </tr>
  6691. <tr>
  6692. <td>
  6693. <code>refreshInterval</code></br>
  6694. <em>
  6695. int
  6696. </em>
  6697. </td>
  6698. <td>
  6699. <em>(Optional)</em>
  6700. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  6701. </td>
  6702. </tr>
  6703. <tr>
  6704. <td>
  6705. <code>conditions</code></br>
  6706. <em>
  6707. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  6708. []ClusterSecretStoreCondition
  6709. </a>
  6710. </em>
  6711. </td>
  6712. <td>
  6713. <em>(Optional)</em>
  6714. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  6715. </td>
  6716. </tr>
  6717. </table>
  6718. </td>
  6719. </tr>
  6720. <tr>
  6721. <td>
  6722. <code>status</code></br>
  6723. <em>
  6724. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  6725. SecretStoreStatus
  6726. </a>
  6727. </em>
  6728. </td>
  6729. <td>
  6730. </td>
  6731. </tr>
  6732. </tbody>
  6733. </table>
  6734. <h3 id="external-secrets.io/v1beta1.SecretStoreCapabilities">SecretStoreCapabilities
  6735. (<code>string</code> alias)</p></h3>
  6736. <p>
  6737. (<em>Appears on:</em>
  6738. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  6739. </p>
  6740. <p>
  6741. <p>SecretStoreCapabilities defines the possible operations a SecretStore can do.</p>
  6742. </p>
  6743. <table>
  6744. <thead>
  6745. <tr>
  6746. <th>Value</th>
  6747. <th>Description</th>
  6748. </tr>
  6749. </thead>
  6750. <tbody><tr><td><p>&#34;ReadOnly&#34;</p></td>
  6751. <td></td>
  6752. </tr><tr><td><p>&#34;ReadWrite&#34;</p></td>
  6753. <td></td>
  6754. </tr><tr><td><p>&#34;WriteOnly&#34;</p></td>
  6755. <td></td>
  6756. </tr></tbody>
  6757. </table>
  6758. <h3 id="external-secrets.io/v1beta1.SecretStoreConditionType">SecretStoreConditionType
  6759. (<code>string</code> alias)</p></h3>
  6760. <p>
  6761. (<em>Appears on:</em>
  6762. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  6763. </p>
  6764. <p>
  6765. </p>
  6766. <table>
  6767. <thead>
  6768. <tr>
  6769. <th>Value</th>
  6770. <th>Description</th>
  6771. </tr>
  6772. </thead>
  6773. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  6774. <td></td>
  6775. </tr></tbody>
  6776. </table>
  6777. <h3 id="external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider
  6778. </h3>
  6779. <p>
  6780. (<em>Appears on:</em>
  6781. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  6782. </p>
  6783. <p>
  6784. <p>SecretStoreProvider contains the provider-specific configuration.</p>
  6785. </p>
  6786. <table>
  6787. <thead>
  6788. <tr>
  6789. <th>Field</th>
  6790. <th>Description</th>
  6791. </tr>
  6792. </thead>
  6793. <tbody>
  6794. <tr>
  6795. <td>
  6796. <code>aws</code></br>
  6797. <em>
  6798. <a href="#external-secrets.io/v1beta1.AWSProvider">
  6799. AWSProvider
  6800. </a>
  6801. </em>
  6802. </td>
  6803. <td>
  6804. <em>(Optional)</em>
  6805. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  6806. </td>
  6807. </tr>
  6808. <tr>
  6809. <td>
  6810. <code>azurekv</code></br>
  6811. <em>
  6812. <a href="#external-secrets.io/v1beta1.AzureKVProvider">
  6813. AzureKVProvider
  6814. </a>
  6815. </em>
  6816. </td>
  6817. <td>
  6818. <em>(Optional)</em>
  6819. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  6820. </td>
  6821. </tr>
  6822. <tr>
  6823. <td>
  6824. <code>akeyless</code></br>
  6825. <em>
  6826. <a href="#external-secrets.io/v1beta1.AkeylessProvider">
  6827. AkeylessProvider
  6828. </a>
  6829. </em>
  6830. </td>
  6831. <td>
  6832. <em>(Optional)</em>
  6833. <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
  6834. </td>
  6835. </tr>
  6836. <tr>
  6837. <td>
  6838. <code>vault</code></br>
  6839. <em>
  6840. <a href="#external-secrets.io/v1beta1.VaultProvider">
  6841. VaultProvider
  6842. </a>
  6843. </em>
  6844. </td>
  6845. <td>
  6846. <em>(Optional)</em>
  6847. <p>Vault configures this store to sync secrets using Hashi provider</p>
  6848. </td>
  6849. </tr>
  6850. <tr>
  6851. <td>
  6852. <code>gcpsm</code></br>
  6853. <em>
  6854. <a href="#external-secrets.io/v1beta1.GCPSMProvider">
  6855. GCPSMProvider
  6856. </a>
  6857. </em>
  6858. </td>
  6859. <td>
  6860. <em>(Optional)</em>
  6861. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  6862. </td>
  6863. </tr>
  6864. <tr>
  6865. <td>
  6866. <code>oracle</code></br>
  6867. <em>
  6868. <a href="#external-secrets.io/v1beta1.OracleProvider">
  6869. OracleProvider
  6870. </a>
  6871. </em>
  6872. </td>
  6873. <td>
  6874. <em>(Optional)</em>
  6875. <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
  6876. </td>
  6877. </tr>
  6878. <tr>
  6879. <td>
  6880. <code>ibm</code></br>
  6881. <em>
  6882. <a href="#external-secrets.io/v1beta1.IBMProvider">
  6883. IBMProvider
  6884. </a>
  6885. </em>
  6886. </td>
  6887. <td>
  6888. <em>(Optional)</em>
  6889. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
  6890. </td>
  6891. </tr>
  6892. <tr>
  6893. <td>
  6894. <code>yandexcertificatemanager</code></br>
  6895. <em>
  6896. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">
  6897. YandexCertificateManagerProvider
  6898. </a>
  6899. </em>
  6900. </td>
  6901. <td>
  6902. <em>(Optional)</em>
  6903. <p>YandexCertificateManager configures this store to sync secrets using Yandex Certificate Manager provider</p>
  6904. </td>
  6905. </tr>
  6906. <tr>
  6907. <td>
  6908. <code>yandexlockbox</code></br>
  6909. <em>
  6910. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">
  6911. YandexLockboxProvider
  6912. </a>
  6913. </em>
  6914. </td>
  6915. <td>
  6916. <em>(Optional)</em>
  6917. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
  6918. </td>
  6919. </tr>
  6920. <tr>
  6921. <td>
  6922. <code>gitlab</code></br>
  6923. <em>
  6924. <a href="#external-secrets.io/v1beta1.GitlabProvider">
  6925. GitlabProvider
  6926. </a>
  6927. </em>
  6928. </td>
  6929. <td>
  6930. <em>(Optional)</em>
  6931. <p>GitLab configures this store to sync secrets using GitLab Variables provider</p>
  6932. </td>
  6933. </tr>
  6934. <tr>
  6935. <td>
  6936. <code>alibaba</code></br>
  6937. <em>
  6938. <a href="#external-secrets.io/v1beta1.AlibabaProvider">
  6939. AlibabaProvider
  6940. </a>
  6941. </em>
  6942. </td>
  6943. <td>
  6944. <em>(Optional)</em>
  6945. <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
  6946. </td>
  6947. </tr>
  6948. <tr>
  6949. <td>
  6950. <code>onepassword</code></br>
  6951. <em>
  6952. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">
  6953. OnePasswordProvider
  6954. </a>
  6955. </em>
  6956. </td>
  6957. <td>
  6958. <em>(Optional)</em>
  6959. <p>OnePassword configures this store to sync secrets using the 1Password Cloud provider</p>
  6960. </td>
  6961. </tr>
  6962. <tr>
  6963. <td>
  6964. <code>webhook</code></br>
  6965. <em>
  6966. <a href="#external-secrets.io/v1beta1.WebhookProvider">
  6967. WebhookProvider
  6968. </a>
  6969. </em>
  6970. </td>
  6971. <td>
  6972. <em>(Optional)</em>
  6973. <p>Webhook configures this store to sync secrets using a generic templated webhook</p>
  6974. </td>
  6975. </tr>
  6976. <tr>
  6977. <td>
  6978. <code>kubernetes</code></br>
  6979. <em>
  6980. <a href="#external-secrets.io/v1beta1.KubernetesProvider">
  6981. KubernetesProvider
  6982. </a>
  6983. </em>
  6984. </td>
  6985. <td>
  6986. <em>(Optional)</em>
  6987. <p>Kubernetes configures this store to sync secrets using a Kubernetes cluster provider</p>
  6988. </td>
  6989. </tr>
  6990. <tr>
  6991. <td>
  6992. <code>fake</code></br>
  6993. <em>
  6994. <a href="#external-secrets.io/v1beta1.FakeProvider">
  6995. FakeProvider
  6996. </a>
  6997. </em>
  6998. </td>
  6999. <td>
  7000. <em>(Optional)</em>
  7001. <p>Fake configures a store with static key/value pairs</p>
  7002. </td>
  7003. </tr>
  7004. <tr>
  7005. <td>
  7006. <code>senhasegura</code></br>
  7007. <em>
  7008. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">
  7009. SenhaseguraProvider
  7010. </a>
  7011. </em>
  7012. </td>
  7013. <td>
  7014. <em>(Optional)</em>
  7015. <p>Senhasegura configures this store to sync secrets using senhasegura provider</p>
  7016. </td>
  7017. </tr>
  7018. <tr>
  7019. <td>
  7020. <code>scaleway</code></br>
  7021. <em>
  7022. <a href="#external-secrets.io/v1beta1.ScalewayProvider">
  7023. ScalewayProvider
  7024. </a>
  7025. </em>
  7026. </td>
  7027. <td>
  7028. <em>(Optional)</em>
  7029. <p>Scaleway</p>
  7030. </td>
  7031. </tr>
  7032. <tr>
  7033. <td>
  7034. <code>doppler</code></br>
  7035. <em>
  7036. <a href="#external-secrets.io/v1beta1.DopplerProvider">
  7037. DopplerProvider
  7038. </a>
  7039. </em>
  7040. </td>
  7041. <td>
  7042. <em>(Optional)</em>
  7043. <p>Doppler configures this store to sync secrets using the Doppler provider</p>
  7044. </td>
  7045. </tr>
  7046. <tr>
  7047. <td>
  7048. <code>onboardbase</code></br>
  7049. <em>
  7050. <a href="#external-secrets.io/v1beta1.OnboardbaseProvider">
  7051. OnboardbaseProvider
  7052. </a>
  7053. </em>
  7054. </td>
  7055. <td>
  7056. <em>(Optional)</em>
  7057. <p>Onboardbase configures this store to sync secrets using the Onboardbase provider</p>
  7058. </td>
  7059. </tr>
  7060. <tr>
  7061. <td>
  7062. <code>keepersecurity</code></br>
  7063. <em>
  7064. <a href="#external-secrets.io/v1beta1.KeeperSecurityProvider">
  7065. KeeperSecurityProvider
  7066. </a>
  7067. </em>
  7068. </td>
  7069. <td>
  7070. <em>(Optional)</em>
  7071. <p>KeeperSecurity configures this store to sync secrets using the KeeperSecurity provider</p>
  7072. </td>
  7073. </tr>
  7074. <tr>
  7075. <td>
  7076. <code>conjur</code></br>
  7077. <em>
  7078. <a href="#external-secrets.io/v1beta1.ConjurProvider">
  7079. ConjurProvider
  7080. </a>
  7081. </em>
  7082. </td>
  7083. <td>
  7084. <em>(Optional)</em>
  7085. <p>Conjur configures this store to sync secrets using conjur provider</p>
  7086. </td>
  7087. </tr>
  7088. <tr>
  7089. <td>
  7090. <code>delinea</code></br>
  7091. <em>
  7092. <a href="#external-secrets.io/v1beta1.DelineaProvider">
  7093. DelineaProvider
  7094. </a>
  7095. </em>
  7096. </td>
  7097. <td>
  7098. <em>(Optional)</em>
  7099. <p>Delinea DevOps Secrets Vault
  7100. <a href="https://docs.delinea.com/online-help/products/devops-secrets-vault/current">https://docs.delinea.com/online-help/products/devops-secrets-vault/current</a></p>
  7101. </td>
  7102. </tr>
  7103. <tr>
  7104. <td>
  7105. <code>chef</code></br>
  7106. <em>
  7107. <a href="#external-secrets.io/v1beta1.ChefProvider">
  7108. ChefProvider
  7109. </a>
  7110. </em>
  7111. </td>
  7112. <td>
  7113. <em>(Optional)</em>
  7114. <p>Chef configures this store to sync secrets with chef server</p>
  7115. </td>
  7116. </tr>
  7117. <tr>
  7118. <td>
  7119. <code>pulumi</code></br>
  7120. <em>
  7121. <a href="#external-secrets.io/v1beta1.PulumiProvider">
  7122. PulumiProvider
  7123. </a>
  7124. </em>
  7125. </td>
  7126. <td>
  7127. <em>(Optional)</em>
  7128. <p>Pulumi configures this store to sync secrets using the Pulumi provider</p>
  7129. </td>
  7130. </tr>
  7131. <tr>
  7132. <td>
  7133. <code>fortanix</code></br>
  7134. <em>
  7135. <a href="#external-secrets.io/v1beta1.FortanixProvider">
  7136. FortanixProvider
  7137. </a>
  7138. </em>
  7139. </td>
  7140. <td>
  7141. <em>(Optional)</em>
  7142. <p>Fortanix configures this store to sync secrets using the Fortanix provider</p>
  7143. </td>
  7144. </tr>
  7145. <tr>
  7146. <td>
  7147. <code>passworddepot</code></br>
  7148. <em>
  7149. <a href="#external-secrets.io/v1beta1.PasswordDepotProvider">
  7150. PasswordDepotProvider
  7151. </a>
  7152. </em>
  7153. </td>
  7154. <td>
  7155. <em>(Optional)</em>
  7156. </td>
  7157. </tr>
  7158. </tbody>
  7159. </table>
  7160. <h3 id="external-secrets.io/v1beta1.SecretStoreRef">SecretStoreRef
  7161. </h3>
  7162. <p>
  7163. (<em>Appears on:</em>
  7164. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>,
  7165. <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef</a>,
  7166. <a href="#external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef</a>)
  7167. </p>
  7168. <p>
  7169. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  7170. </p>
  7171. <table>
  7172. <thead>
  7173. <tr>
  7174. <th>Field</th>
  7175. <th>Description</th>
  7176. </tr>
  7177. </thead>
  7178. <tbody>
  7179. <tr>
  7180. <td>
  7181. <code>name</code></br>
  7182. <em>
  7183. string
  7184. </em>
  7185. </td>
  7186. <td>
  7187. <p>Name of the SecretStore resource</p>
  7188. </td>
  7189. </tr>
  7190. <tr>
  7191. <td>
  7192. <code>kind</code></br>
  7193. <em>
  7194. string
  7195. </em>
  7196. </td>
  7197. <td>
  7198. <em>(Optional)</em>
  7199. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  7200. Defaults to <code>SecretStore</code></p>
  7201. </td>
  7202. </tr>
  7203. </tbody>
  7204. </table>
  7205. <h3 id="external-secrets.io/v1beta1.SecretStoreRetrySettings">SecretStoreRetrySettings
  7206. </h3>
  7207. <p>
  7208. (<em>Appears on:</em>
  7209. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  7210. </p>
  7211. <p>
  7212. </p>
  7213. <table>
  7214. <thead>
  7215. <tr>
  7216. <th>Field</th>
  7217. <th>Description</th>
  7218. </tr>
  7219. </thead>
  7220. <tbody>
  7221. <tr>
  7222. <td>
  7223. <code>maxRetries</code></br>
  7224. <em>
  7225. int32
  7226. </em>
  7227. </td>
  7228. <td>
  7229. </td>
  7230. </tr>
  7231. <tr>
  7232. <td>
  7233. <code>retryInterval</code></br>
  7234. <em>
  7235. string
  7236. </em>
  7237. </td>
  7238. <td>
  7239. </td>
  7240. </tr>
  7241. </tbody>
  7242. </table>
  7243. <h3 id="external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec
  7244. </h3>
  7245. <p>
  7246. (<em>Appears on:</em>
  7247. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  7248. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  7249. </p>
  7250. <p>
  7251. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  7252. </p>
  7253. <table>
  7254. <thead>
  7255. <tr>
  7256. <th>Field</th>
  7257. <th>Description</th>
  7258. </tr>
  7259. </thead>
  7260. <tbody>
  7261. <tr>
  7262. <td>
  7263. <code>controller</code></br>
  7264. <em>
  7265. string
  7266. </em>
  7267. </td>
  7268. <td>
  7269. <em>(Optional)</em>
  7270. <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
  7271. The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
  7272. </td>
  7273. </tr>
  7274. <tr>
  7275. <td>
  7276. <code>provider</code></br>
  7277. <em>
  7278. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  7279. SecretStoreProvider
  7280. </a>
  7281. </em>
  7282. </td>
  7283. <td>
  7284. <p>Used to configure the provider. Only one provider may be set</p>
  7285. </td>
  7286. </tr>
  7287. <tr>
  7288. <td>
  7289. <code>retrySettings</code></br>
  7290. <em>
  7291. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  7292. SecretStoreRetrySettings
  7293. </a>
  7294. </em>
  7295. </td>
  7296. <td>
  7297. <em>(Optional)</em>
  7298. <p>Used to configure http retries if failed</p>
  7299. </td>
  7300. </tr>
  7301. <tr>
  7302. <td>
  7303. <code>refreshInterval</code></br>
  7304. <em>
  7305. int
  7306. </em>
  7307. </td>
  7308. <td>
  7309. <em>(Optional)</em>
  7310. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  7311. </td>
  7312. </tr>
  7313. <tr>
  7314. <td>
  7315. <code>conditions</code></br>
  7316. <em>
  7317. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  7318. []ClusterSecretStoreCondition
  7319. </a>
  7320. </em>
  7321. </td>
  7322. <td>
  7323. <em>(Optional)</em>
  7324. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  7325. </td>
  7326. </tr>
  7327. </tbody>
  7328. </table>
  7329. <h3 id="external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus
  7330. </h3>
  7331. <p>
  7332. (<em>Appears on:</em>
  7333. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  7334. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  7335. </p>
  7336. <p>
  7337. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  7338. </p>
  7339. <table>
  7340. <thead>
  7341. <tr>
  7342. <th>Field</th>
  7343. <th>Description</th>
  7344. </tr>
  7345. </thead>
  7346. <tbody>
  7347. <tr>
  7348. <td>
  7349. <code>conditions</code></br>
  7350. <em>
  7351. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">
  7352. []SecretStoreStatusCondition
  7353. </a>
  7354. </em>
  7355. </td>
  7356. <td>
  7357. <em>(Optional)</em>
  7358. </td>
  7359. </tr>
  7360. <tr>
  7361. <td>
  7362. <code>capabilities</code></br>
  7363. <em>
  7364. <a href="#external-secrets.io/v1beta1.SecretStoreCapabilities">
  7365. SecretStoreCapabilities
  7366. </a>
  7367. </em>
  7368. </td>
  7369. <td>
  7370. <em>(Optional)</em>
  7371. </td>
  7372. </tr>
  7373. </tbody>
  7374. </table>
  7375. <h3 id="external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition
  7376. </h3>
  7377. <p>
  7378. (<em>Appears on:</em>
  7379. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  7380. </p>
  7381. <p>
  7382. </p>
  7383. <table>
  7384. <thead>
  7385. <tr>
  7386. <th>Field</th>
  7387. <th>Description</th>
  7388. </tr>
  7389. </thead>
  7390. <tbody>
  7391. <tr>
  7392. <td>
  7393. <code>type</code></br>
  7394. <em>
  7395. <a href="#external-secrets.io/v1beta1.SecretStoreConditionType">
  7396. SecretStoreConditionType
  7397. </a>
  7398. </em>
  7399. </td>
  7400. <td>
  7401. </td>
  7402. </tr>
  7403. <tr>
  7404. <td>
  7405. <code>status</code></br>
  7406. <em>
  7407. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  7408. Kubernetes core/v1.ConditionStatus
  7409. </a>
  7410. </em>
  7411. </td>
  7412. <td>
  7413. </td>
  7414. </tr>
  7415. <tr>
  7416. <td>
  7417. <code>reason</code></br>
  7418. <em>
  7419. string
  7420. </em>
  7421. </td>
  7422. <td>
  7423. <em>(Optional)</em>
  7424. </td>
  7425. </tr>
  7426. <tr>
  7427. <td>
  7428. <code>message</code></br>
  7429. <em>
  7430. string
  7431. </em>
  7432. </td>
  7433. <td>
  7434. <em>(Optional)</em>
  7435. </td>
  7436. </tr>
  7437. <tr>
  7438. <td>
  7439. <code>lastTransitionTime</code></br>
  7440. <em>
  7441. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  7442. Kubernetes meta/v1.Time
  7443. </a>
  7444. </em>
  7445. </td>
  7446. <td>
  7447. <em>(Optional)</em>
  7448. </td>
  7449. </tr>
  7450. </tbody>
  7451. </table>
  7452. <h3 id="external-secrets.io/v1beta1.SecretsClient">SecretsClient
  7453. </h3>
  7454. <p>
  7455. <p>SecretsClient provides access to secrets.</p>
  7456. </p>
  7457. <h3 id="external-secrets.io/v1beta1.SecretsManager">SecretsManager
  7458. </h3>
  7459. <p>
  7460. (<em>Appears on:</em>
  7461. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  7462. </p>
  7463. <p>
  7464. <p>SecretsManager defines how the provider behaves when interacting with AWS
  7465. SecretsManager. Some of these settings are only applicable to controlling how
  7466. secrets are deleted, and hence only apply to PushSecret (and only when
  7467. deletionPolicy is set to Delete).</p>
  7468. </p>
  7469. <table>
  7470. <thead>
  7471. <tr>
  7472. <th>Field</th>
  7473. <th>Description</th>
  7474. </tr>
  7475. </thead>
  7476. <tbody>
  7477. <tr>
  7478. <td>
  7479. <code>forceDeleteWithoutRecovery</code></br>
  7480. <em>
  7481. bool
  7482. </em>
  7483. </td>
  7484. <td>
  7485. <em>(Optional)</em>
  7486. <p>Specifies whether to delete the secret without any recovery window. You
  7487. can&rsquo;t use both this parameter and RecoveryWindowInDays in the same call.
  7488. If you don&rsquo;t use either, then by default Secrets Manager uses a 30 day
  7489. recovery window.
  7490. see: <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-ForceDeleteWithoutRecovery">https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-ForceDeleteWithoutRecovery</a></p>
  7491. </td>
  7492. </tr>
  7493. <tr>
  7494. <td>
  7495. <code>recoveryWindowInDays</code></br>
  7496. <em>
  7497. int64
  7498. </em>
  7499. </td>
  7500. <td>
  7501. <em>(Optional)</em>
  7502. <p>The number of days from 7 to 30 that Secrets Manager waits before
  7503. permanently deleting the secret. You can&rsquo;t use both this parameter and
  7504. ForceDeleteWithoutRecovery in the same call. If you don&rsquo;t use either,
  7505. then by default Secrets Manager uses a 30 day recovery window.
  7506. see: <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-RecoveryWindowInDays">https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-RecoveryWindowInDays</a></p>
  7507. </td>
  7508. </tr>
  7509. </tbody>
  7510. </table>
  7511. <h3 id="external-secrets.io/v1beta1.SenhaseguraAuth">SenhaseguraAuth
  7512. </h3>
  7513. <p>
  7514. (<em>Appears on:</em>
  7515. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  7516. </p>
  7517. <p>
  7518. <p>SenhaseguraAuth tells the controller how to do auth in senhasegura.</p>
  7519. </p>
  7520. <table>
  7521. <thead>
  7522. <tr>
  7523. <th>Field</th>
  7524. <th>Description</th>
  7525. </tr>
  7526. </thead>
  7527. <tbody>
  7528. <tr>
  7529. <td>
  7530. <code>clientId</code></br>
  7531. <em>
  7532. string
  7533. </em>
  7534. </td>
  7535. <td>
  7536. </td>
  7537. </tr>
  7538. <tr>
  7539. <td>
  7540. <code>clientSecretSecretRef</code></br>
  7541. <em>
  7542. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7543. External Secrets meta/v1.SecretKeySelector
  7544. </a>
  7545. </em>
  7546. </td>
  7547. <td>
  7548. </td>
  7549. </tr>
  7550. </tbody>
  7551. </table>
  7552. <h3 id="external-secrets.io/v1beta1.SenhaseguraModuleType">SenhaseguraModuleType
  7553. (<code>string</code> alias)</p></h3>
  7554. <p>
  7555. (<em>Appears on:</em>
  7556. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  7557. </p>
  7558. <p>
  7559. <p>SenhaseguraModuleType enum defines senhasegura target module to fetch secrets</p>
  7560. </p>
  7561. <table>
  7562. <thead>
  7563. <tr>
  7564. <th>Value</th>
  7565. <th>Description</th>
  7566. </tr>
  7567. </thead>
  7568. <tbody><tr><td><p>&#34;DSM&#34;</p></td>
  7569. <td><pre><code> SenhaseguraModuleDSM is the senhasegura DevOps Secrets Management module
  7570. see: https://senhasegura.com/devops
  7571. </code></pre>
  7572. </td>
  7573. </tr></tbody>
  7574. </table>
  7575. <h3 id="external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider
  7576. </h3>
  7577. <p>
  7578. (<em>Appears on:</em>
  7579. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  7580. </p>
  7581. <p>
  7582. <p>SenhaseguraProvider setup a store to sync secrets with senhasegura.</p>
  7583. </p>
  7584. <table>
  7585. <thead>
  7586. <tr>
  7587. <th>Field</th>
  7588. <th>Description</th>
  7589. </tr>
  7590. </thead>
  7591. <tbody>
  7592. <tr>
  7593. <td>
  7594. <code>url</code></br>
  7595. <em>
  7596. string
  7597. </em>
  7598. </td>
  7599. <td>
  7600. <p>URL of senhasegura</p>
  7601. </td>
  7602. </tr>
  7603. <tr>
  7604. <td>
  7605. <code>module</code></br>
  7606. <em>
  7607. <a href="#external-secrets.io/v1beta1.SenhaseguraModuleType">
  7608. SenhaseguraModuleType
  7609. </a>
  7610. </em>
  7611. </td>
  7612. <td>
  7613. <p>Module defines which senhasegura module should be used to get secrets</p>
  7614. </td>
  7615. </tr>
  7616. <tr>
  7617. <td>
  7618. <code>auth</code></br>
  7619. <em>
  7620. <a href="#external-secrets.io/v1beta1.SenhaseguraAuth">
  7621. SenhaseguraAuth
  7622. </a>
  7623. </em>
  7624. </td>
  7625. <td>
  7626. <p>Auth defines parameters to authenticate in senhasegura</p>
  7627. </td>
  7628. </tr>
  7629. <tr>
  7630. <td>
  7631. <code>ignoreSslCertificate</code></br>
  7632. <em>
  7633. bool
  7634. </em>
  7635. </td>
  7636. <td>
  7637. <p>IgnoreSslCertificate defines if SSL certificate must be ignored</p>
  7638. </td>
  7639. </tr>
  7640. </tbody>
  7641. </table>
  7642. <h3 id="external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef
  7643. </h3>
  7644. <p>
  7645. (<em>Appears on:</em>
  7646. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  7647. </p>
  7648. <p>
  7649. <p>StoreGeneratorSourceRef allows you to override the source
  7650. from which the secret will be pulled from.
  7651. You can define at maximum one property.</p>
  7652. </p>
  7653. <table>
  7654. <thead>
  7655. <tr>
  7656. <th>Field</th>
  7657. <th>Description</th>
  7658. </tr>
  7659. </thead>
  7660. <tbody>
  7661. <tr>
  7662. <td>
  7663. <code>storeRef</code></br>
  7664. <em>
  7665. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  7666. SecretStoreRef
  7667. </a>
  7668. </em>
  7669. </td>
  7670. <td>
  7671. <em>(Optional)</em>
  7672. </td>
  7673. </tr>
  7674. <tr>
  7675. <td>
  7676. <code>generatorRef</code></br>
  7677. <em>
  7678. <a href="#external-secrets.io/v1beta1.GeneratorRef">
  7679. GeneratorRef
  7680. </a>
  7681. </em>
  7682. </td>
  7683. <td>
  7684. <em>(Optional)</em>
  7685. <p>GeneratorRef points to a generator custom resource.</p>
  7686. </td>
  7687. </tr>
  7688. </tbody>
  7689. </table>
  7690. <h3 id="external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef
  7691. </h3>
  7692. <p>
  7693. (<em>Appears on:</em>
  7694. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>)
  7695. </p>
  7696. <p>
  7697. <p>StoreSourceRef allows you to override the SecretStore source
  7698. from which the secret will be pulled from.
  7699. You can define at maximum one property.</p>
  7700. </p>
  7701. <table>
  7702. <thead>
  7703. <tr>
  7704. <th>Field</th>
  7705. <th>Description</th>
  7706. </tr>
  7707. </thead>
  7708. <tbody>
  7709. <tr>
  7710. <td>
  7711. <code>storeRef</code></br>
  7712. <em>
  7713. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  7714. SecretStoreRef
  7715. </a>
  7716. </em>
  7717. </td>
  7718. <td>
  7719. <em>(Optional)</em>
  7720. </td>
  7721. </tr>
  7722. <tr>
  7723. <td>
  7724. <code>generatorRef</code></br>
  7725. <em>
  7726. <a href="#external-secrets.io/v1beta1.GeneratorRef">
  7727. GeneratorRef
  7728. </a>
  7729. </em>
  7730. </td>
  7731. <td>
  7732. <p>GeneratorRef points to a generator custom resource.</p>
  7733. <p>Deprecated: The generatorRef is not implemented in .data[].
  7734. this will be removed with v1.</p>
  7735. </td>
  7736. </tr>
  7737. </tbody>
  7738. </table>
  7739. <h3 id="external-secrets.io/v1beta1.Tag">Tag
  7740. </h3>
  7741. <p>
  7742. </p>
  7743. <table>
  7744. <thead>
  7745. <tr>
  7746. <th>Field</th>
  7747. <th>Description</th>
  7748. </tr>
  7749. </thead>
  7750. <tbody>
  7751. <tr>
  7752. <td>
  7753. <code>key</code></br>
  7754. <em>
  7755. string
  7756. </em>
  7757. </td>
  7758. <td>
  7759. </td>
  7760. </tr>
  7761. <tr>
  7762. <td>
  7763. <code>value</code></br>
  7764. <em>
  7765. string
  7766. </em>
  7767. </td>
  7768. <td>
  7769. </td>
  7770. </tr>
  7771. </tbody>
  7772. </table>
  7773. <h3 id="external-secrets.io/v1beta1.TemplateEngineVersion">TemplateEngineVersion
  7774. (<code>string</code> alias)</p></h3>
  7775. <p>
  7776. (<em>Appears on:</em>
  7777. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  7778. </p>
  7779. <p>
  7780. </p>
  7781. <table>
  7782. <thead>
  7783. <tr>
  7784. <th>Value</th>
  7785. <th>Description</th>
  7786. </tr>
  7787. </thead>
  7788. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  7789. <td></td>
  7790. </tr><tr><td><p>&#34;v2&#34;</p></td>
  7791. <td></td>
  7792. </tr></tbody>
  7793. </table>
  7794. <h3 id="external-secrets.io/v1beta1.TemplateFrom">TemplateFrom
  7795. </h3>
  7796. <p>
  7797. (<em>Appears on:</em>
  7798. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  7799. </p>
  7800. <p>
  7801. </p>
  7802. <table>
  7803. <thead>
  7804. <tr>
  7805. <th>Field</th>
  7806. <th>Description</th>
  7807. </tr>
  7808. </thead>
  7809. <tbody>
  7810. <tr>
  7811. <td>
  7812. <code>configMap</code></br>
  7813. <em>
  7814. <a href="#external-secrets.io/v1beta1.TemplateRef">
  7815. TemplateRef
  7816. </a>
  7817. </em>
  7818. </td>
  7819. <td>
  7820. </td>
  7821. </tr>
  7822. <tr>
  7823. <td>
  7824. <code>secret</code></br>
  7825. <em>
  7826. <a href="#external-secrets.io/v1beta1.TemplateRef">
  7827. TemplateRef
  7828. </a>
  7829. </em>
  7830. </td>
  7831. <td>
  7832. </td>
  7833. </tr>
  7834. <tr>
  7835. <td>
  7836. <code>target</code></br>
  7837. <em>
  7838. <a href="#external-secrets.io/v1beta1.TemplateTarget">
  7839. TemplateTarget
  7840. </a>
  7841. </em>
  7842. </td>
  7843. <td>
  7844. <em>(Optional)</em>
  7845. </td>
  7846. </tr>
  7847. <tr>
  7848. <td>
  7849. <code>literal</code></br>
  7850. <em>
  7851. string
  7852. </em>
  7853. </td>
  7854. <td>
  7855. <em>(Optional)</em>
  7856. </td>
  7857. </tr>
  7858. </tbody>
  7859. </table>
  7860. <h3 id="external-secrets.io/v1beta1.TemplateMergePolicy">TemplateMergePolicy
  7861. (<code>string</code> alias)</p></h3>
  7862. <p>
  7863. (<em>Appears on:</em>
  7864. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  7865. </p>
  7866. <p>
  7867. </p>
  7868. <table>
  7869. <thead>
  7870. <tr>
  7871. <th>Value</th>
  7872. <th>Description</th>
  7873. </tr>
  7874. </thead>
  7875. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  7876. <td></td>
  7877. </tr><tr><td><p>&#34;Replace&#34;</p></td>
  7878. <td></td>
  7879. </tr></tbody>
  7880. </table>
  7881. <h3 id="external-secrets.io/v1beta1.TemplateRef">TemplateRef
  7882. </h3>
  7883. <p>
  7884. (<em>Appears on:</em>
  7885. <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
  7886. </p>
  7887. <p>
  7888. </p>
  7889. <table>
  7890. <thead>
  7891. <tr>
  7892. <th>Field</th>
  7893. <th>Description</th>
  7894. </tr>
  7895. </thead>
  7896. <tbody>
  7897. <tr>
  7898. <td>
  7899. <code>name</code></br>
  7900. <em>
  7901. string
  7902. </em>
  7903. </td>
  7904. <td>
  7905. </td>
  7906. </tr>
  7907. <tr>
  7908. <td>
  7909. <code>items</code></br>
  7910. <em>
  7911. <a href="#external-secrets.io/v1beta1.TemplateRefItem">
  7912. []TemplateRefItem
  7913. </a>
  7914. </em>
  7915. </td>
  7916. <td>
  7917. </td>
  7918. </tr>
  7919. </tbody>
  7920. </table>
  7921. <h3 id="external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem
  7922. </h3>
  7923. <p>
  7924. (<em>Appears on:</em>
  7925. <a href="#external-secrets.io/v1beta1.TemplateRef">TemplateRef</a>)
  7926. </p>
  7927. <p>
  7928. </p>
  7929. <table>
  7930. <thead>
  7931. <tr>
  7932. <th>Field</th>
  7933. <th>Description</th>
  7934. </tr>
  7935. </thead>
  7936. <tbody>
  7937. <tr>
  7938. <td>
  7939. <code>key</code></br>
  7940. <em>
  7941. string
  7942. </em>
  7943. </td>
  7944. <td>
  7945. </td>
  7946. </tr>
  7947. <tr>
  7948. <td>
  7949. <code>templateAs</code></br>
  7950. <em>
  7951. <a href="#external-secrets.io/v1beta1.TemplateScope">
  7952. TemplateScope
  7953. </a>
  7954. </em>
  7955. </td>
  7956. <td>
  7957. </td>
  7958. </tr>
  7959. </tbody>
  7960. </table>
  7961. <h3 id="external-secrets.io/v1beta1.TemplateScope">TemplateScope
  7962. (<code>string</code> alias)</p></h3>
  7963. <p>
  7964. (<em>Appears on:</em>
  7965. <a href="#external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem</a>)
  7966. </p>
  7967. <p>
  7968. </p>
  7969. <table>
  7970. <thead>
  7971. <tr>
  7972. <th>Value</th>
  7973. <th>Description</th>
  7974. </tr>
  7975. </thead>
  7976. <tbody><tr><td><p>&#34;KeysAndValues&#34;</p></td>
  7977. <td></td>
  7978. </tr><tr><td><p>&#34;Values&#34;</p></td>
  7979. <td></td>
  7980. </tr></tbody>
  7981. </table>
  7982. <h3 id="external-secrets.io/v1beta1.TemplateTarget">TemplateTarget
  7983. (<code>string</code> alias)</p></h3>
  7984. <p>
  7985. (<em>Appears on:</em>
  7986. <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
  7987. </p>
  7988. <p>
  7989. </p>
  7990. <table>
  7991. <thead>
  7992. <tr>
  7993. <th>Value</th>
  7994. <th>Description</th>
  7995. </tr>
  7996. </thead>
  7997. <tbody><tr><td><p>&#34;Annotations&#34;</p></td>
  7998. <td></td>
  7999. </tr><tr><td><p>&#34;Data&#34;</p></td>
  8000. <td></td>
  8001. </tr><tr><td><p>&#34;Labels&#34;</p></td>
  8002. <td></td>
  8003. </tr></tbody>
  8004. </table>
  8005. <h3 id="external-secrets.io/v1beta1.TokenAuth">TokenAuth
  8006. </h3>
  8007. <p>
  8008. (<em>Appears on:</em>
  8009. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  8010. </p>
  8011. <p>
  8012. </p>
  8013. <table>
  8014. <thead>
  8015. <tr>
  8016. <th>Field</th>
  8017. <th>Description</th>
  8018. </tr>
  8019. </thead>
  8020. <tbody>
  8021. <tr>
  8022. <td>
  8023. <code>bearerToken</code></br>
  8024. <em>
  8025. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8026. External Secrets meta/v1.SecretKeySelector
  8027. </a>
  8028. </em>
  8029. </td>
  8030. <td>
  8031. </td>
  8032. </tr>
  8033. </tbody>
  8034. </table>
  8035. <h3 id="external-secrets.io/v1beta1.ValidationResult">ValidationResult
  8036. (<code>byte</code> alias)</p></h3>
  8037. <p>
  8038. </p>
  8039. <table>
  8040. <thead>
  8041. <tr>
  8042. <th>Value</th>
  8043. <th>Description</th>
  8044. </tr>
  8045. </thead>
  8046. <tbody><tr><td><p>2</p></td>
  8047. <td><p>Error indicates that there is a misconfiguration.</p>
  8048. </td>
  8049. </tr><tr><td><p>0</p></td>
  8050. <td><p>Ready indicates that the client is configured correctly
  8051. and can be used.</p>
  8052. </td>
  8053. </tr><tr><td><p>1</p></td>
  8054. <td><p>Unknown indicates that the client can be used
  8055. but information is missing and it can not be validated.</p>
  8056. </td>
  8057. </tr></tbody>
  8058. </table>
  8059. <h3 id="external-secrets.io/v1beta1.VaultAppRole">VaultAppRole
  8060. </h3>
  8061. <p>
  8062. (<em>Appears on:</em>
  8063. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  8064. </p>
  8065. <p>
  8066. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  8067. with the role and secret stored in a Kubernetes Secret resource.</p>
  8068. </p>
  8069. <table>
  8070. <thead>
  8071. <tr>
  8072. <th>Field</th>
  8073. <th>Description</th>
  8074. </tr>
  8075. </thead>
  8076. <tbody>
  8077. <tr>
  8078. <td>
  8079. <code>path</code></br>
  8080. <em>
  8081. string
  8082. </em>
  8083. </td>
  8084. <td>
  8085. <p>Path where the App Role authentication backend is mounted
  8086. in Vault, e.g: &ldquo;approle&rdquo;</p>
  8087. </td>
  8088. </tr>
  8089. <tr>
  8090. <td>
  8091. <code>roleId</code></br>
  8092. <em>
  8093. string
  8094. </em>
  8095. </td>
  8096. <td>
  8097. <em>(Optional)</em>
  8098. <p>RoleID configured in the App Role authentication backend when setting
  8099. up the authentication backend in Vault.</p>
  8100. </td>
  8101. </tr>
  8102. <tr>
  8103. <td>
  8104. <code>roleRef</code></br>
  8105. <em>
  8106. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8107. External Secrets meta/v1.SecretKeySelector
  8108. </a>
  8109. </em>
  8110. </td>
  8111. <td>
  8112. <em>(Optional)</em>
  8113. <p>Reference to a key in a Secret that contains the App Role ID used
  8114. to authenticate with Vault.
  8115. The <code>key</code> field must be specified and denotes which entry within the Secret
  8116. resource is used as the app role id.</p>
  8117. </td>
  8118. </tr>
  8119. <tr>
  8120. <td>
  8121. <code>secretRef</code></br>
  8122. <em>
  8123. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8124. External Secrets meta/v1.SecretKeySelector
  8125. </a>
  8126. </em>
  8127. </td>
  8128. <td>
  8129. <p>Reference to a key in a Secret that contains the App Role secret used
  8130. to authenticate with Vault.
  8131. The <code>key</code> field must be specified and denotes which entry within the Secret
  8132. resource is used as the app role secret.</p>
  8133. </td>
  8134. </tr>
  8135. </tbody>
  8136. </table>
  8137. <h3 id="external-secrets.io/v1beta1.VaultAuth">VaultAuth
  8138. </h3>
  8139. <p>
  8140. (<em>Appears on:</em>
  8141. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  8142. </p>
  8143. <p>
  8144. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  8145. 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>
  8146. can be specified. A namespace to authenticate against can optionally be specified.</p>
  8147. </p>
  8148. <table>
  8149. <thead>
  8150. <tr>
  8151. <th>Field</th>
  8152. <th>Description</th>
  8153. </tr>
  8154. </thead>
  8155. <tbody>
  8156. <tr>
  8157. <td>
  8158. <code>namespace</code></br>
  8159. <em>
  8160. string
  8161. </em>
  8162. </td>
  8163. <td>
  8164. <em>(Optional)</em>
  8165. <p>Name of the vault namespace to authenticate to. This can be different than the namespace your secret is in.
  8166. Namespaces is a set of features within Vault Enterprise that allows
  8167. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  8168. More about namespaces can be found here <a href="https://www.vaultproject.io/docs/enterprise/namespaces">https://www.vaultproject.io/docs/enterprise/namespaces</a>
  8169. This will default to Vault.Namespace field if set, or empty otherwise</p>
  8170. </td>
  8171. </tr>
  8172. <tr>
  8173. <td>
  8174. <code>tokenSecretRef</code></br>
  8175. <em>
  8176. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8177. External Secrets meta/v1.SecretKeySelector
  8178. </a>
  8179. </em>
  8180. </td>
  8181. <td>
  8182. <em>(Optional)</em>
  8183. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  8184. </td>
  8185. </tr>
  8186. <tr>
  8187. <td>
  8188. <code>appRole</code></br>
  8189. <em>
  8190. <a href="#external-secrets.io/v1beta1.VaultAppRole">
  8191. VaultAppRole
  8192. </a>
  8193. </em>
  8194. </td>
  8195. <td>
  8196. <em>(Optional)</em>
  8197. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  8198. with the role and secret stored in a Kubernetes Secret resource.</p>
  8199. </td>
  8200. </tr>
  8201. <tr>
  8202. <td>
  8203. <code>kubernetes</code></br>
  8204. <em>
  8205. <a href="#external-secrets.io/v1beta1.VaultKubernetesAuth">
  8206. VaultKubernetesAuth
  8207. </a>
  8208. </em>
  8209. </td>
  8210. <td>
  8211. <em>(Optional)</em>
  8212. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  8213. token stored in the named Secret resource to the Vault server.</p>
  8214. </td>
  8215. </tr>
  8216. <tr>
  8217. <td>
  8218. <code>ldap</code></br>
  8219. <em>
  8220. <a href="#external-secrets.io/v1beta1.VaultLdapAuth">
  8221. VaultLdapAuth
  8222. </a>
  8223. </em>
  8224. </td>
  8225. <td>
  8226. <em>(Optional)</em>
  8227. <p>Ldap authenticates with Vault by passing username/password pair using
  8228. the LDAP authentication method</p>
  8229. </td>
  8230. </tr>
  8231. <tr>
  8232. <td>
  8233. <code>jwt</code></br>
  8234. <em>
  8235. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">
  8236. VaultJwtAuth
  8237. </a>
  8238. </em>
  8239. </td>
  8240. <td>
  8241. <em>(Optional)</em>
  8242. <p>Jwt authenticates with Vault by passing role and JWT token using the
  8243. JWT/OIDC authentication method</p>
  8244. </td>
  8245. </tr>
  8246. <tr>
  8247. <td>
  8248. <code>cert</code></br>
  8249. <em>
  8250. <a href="#external-secrets.io/v1beta1.VaultCertAuth">
  8251. VaultCertAuth
  8252. </a>
  8253. </em>
  8254. </td>
  8255. <td>
  8256. <em>(Optional)</em>
  8257. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  8258. Cert authentication method</p>
  8259. </td>
  8260. </tr>
  8261. <tr>
  8262. <td>
  8263. <code>iam</code></br>
  8264. <em>
  8265. <a href="#external-secrets.io/v1beta1.VaultIamAuth">
  8266. VaultIamAuth
  8267. </a>
  8268. </em>
  8269. </td>
  8270. <td>
  8271. <em>(Optional)</em>
  8272. <p>Iam authenticates with vault by passing a special AWS request signed with AWS IAM credentials
  8273. AWS IAM authentication method</p>
  8274. </td>
  8275. </tr>
  8276. <tr>
  8277. <td>
  8278. <code>userPass</code></br>
  8279. <em>
  8280. <a href="#external-secrets.io/v1beta1.VaultUserPassAuth">
  8281. VaultUserPassAuth
  8282. </a>
  8283. </em>
  8284. </td>
  8285. <td>
  8286. <em>(Optional)</em>
  8287. <p>UserPass authenticates with Vault by passing username/password pair</p>
  8288. </td>
  8289. </tr>
  8290. </tbody>
  8291. </table>
  8292. <h3 id="external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth
  8293. </h3>
  8294. <p>
  8295. <p>VaultAwsAuth tells the controller how to do authentication with aws.
  8296. Only one of secretRef or jwt can be specified.
  8297. if none is specified the controller will try to load credentials from its own service account assuming it is IRSA enabled.</p>
  8298. </p>
  8299. <table>
  8300. <thead>
  8301. <tr>
  8302. <th>Field</th>
  8303. <th>Description</th>
  8304. </tr>
  8305. </thead>
  8306. <tbody>
  8307. <tr>
  8308. <td>
  8309. <code>secretRef</code></br>
  8310. <em>
  8311. <a href="#external-secrets.io/v1beta1.VaultAwsAuthSecretRef">
  8312. VaultAwsAuthSecretRef
  8313. </a>
  8314. </em>
  8315. </td>
  8316. <td>
  8317. <em>(Optional)</em>
  8318. </td>
  8319. </tr>
  8320. <tr>
  8321. <td>
  8322. <code>jwt</code></br>
  8323. <em>
  8324. <a href="#external-secrets.io/v1beta1.VaultAwsJWTAuth">
  8325. VaultAwsJWTAuth
  8326. </a>
  8327. </em>
  8328. </td>
  8329. <td>
  8330. <em>(Optional)</em>
  8331. </td>
  8332. </tr>
  8333. </tbody>
  8334. </table>
  8335. <h3 id="external-secrets.io/v1beta1.VaultAwsAuthSecretRef">VaultAwsAuthSecretRef
  8336. </h3>
  8337. <p>
  8338. (<em>Appears on:</em>
  8339. <a href="#external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth</a>,
  8340. <a href="#external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth</a>)
  8341. </p>
  8342. <p>
  8343. <p>VaultAWSAuthSecretRef holds secret references for AWS credentials
  8344. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  8345. </p>
  8346. <table>
  8347. <thead>
  8348. <tr>
  8349. <th>Field</th>
  8350. <th>Description</th>
  8351. </tr>
  8352. </thead>
  8353. <tbody>
  8354. <tr>
  8355. <td>
  8356. <code>accessKeyIDSecretRef</code></br>
  8357. <em>
  8358. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8359. External Secrets meta/v1.SecretKeySelector
  8360. </a>
  8361. </em>
  8362. </td>
  8363. <td>
  8364. <p>The AccessKeyID is used for authentication</p>
  8365. </td>
  8366. </tr>
  8367. <tr>
  8368. <td>
  8369. <code>secretAccessKeySecretRef</code></br>
  8370. <em>
  8371. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8372. External Secrets meta/v1.SecretKeySelector
  8373. </a>
  8374. </em>
  8375. </td>
  8376. <td>
  8377. <p>The SecretAccessKey is used for authentication</p>
  8378. </td>
  8379. </tr>
  8380. <tr>
  8381. <td>
  8382. <code>sessionTokenSecretRef</code></br>
  8383. <em>
  8384. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8385. External Secrets meta/v1.SecretKeySelector
  8386. </a>
  8387. </em>
  8388. </td>
  8389. <td>
  8390. <p>The SessionToken used for authentication
  8391. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  8392. 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>
  8393. </td>
  8394. </tr>
  8395. </tbody>
  8396. </table>
  8397. <h3 id="external-secrets.io/v1beta1.VaultAwsJWTAuth">VaultAwsJWTAuth
  8398. </h3>
  8399. <p>
  8400. (<em>Appears on:</em>
  8401. <a href="#external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth</a>,
  8402. <a href="#external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth</a>)
  8403. </p>
  8404. <p>
  8405. <p>Authenticate against AWS using service account tokens.</p>
  8406. </p>
  8407. <table>
  8408. <thead>
  8409. <tr>
  8410. <th>Field</th>
  8411. <th>Description</th>
  8412. </tr>
  8413. </thead>
  8414. <tbody>
  8415. <tr>
  8416. <td>
  8417. <code>serviceAccountRef</code></br>
  8418. <em>
  8419. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  8420. External Secrets meta/v1.ServiceAccountSelector
  8421. </a>
  8422. </em>
  8423. </td>
  8424. <td>
  8425. </td>
  8426. </tr>
  8427. </tbody>
  8428. </table>
  8429. <h3 id="external-secrets.io/v1beta1.VaultCertAuth">VaultCertAuth
  8430. </h3>
  8431. <p>
  8432. (<em>Appears on:</em>
  8433. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  8434. </p>
  8435. <p>
  8436. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  8437. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  8438. </p>
  8439. <table>
  8440. <thead>
  8441. <tr>
  8442. <th>Field</th>
  8443. <th>Description</th>
  8444. </tr>
  8445. </thead>
  8446. <tbody>
  8447. <tr>
  8448. <td>
  8449. <code>clientCert</code></br>
  8450. <em>
  8451. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8452. External Secrets meta/v1.SecretKeySelector
  8453. </a>
  8454. </em>
  8455. </td>
  8456. <td>
  8457. <em>(Optional)</em>
  8458. <p>ClientCert is a certificate to authenticate using the Cert Vault
  8459. authentication method</p>
  8460. </td>
  8461. </tr>
  8462. <tr>
  8463. <td>
  8464. <code>secretRef</code></br>
  8465. <em>
  8466. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8467. External Secrets meta/v1.SecretKeySelector
  8468. </a>
  8469. </em>
  8470. </td>
  8471. <td>
  8472. <p>SecretRef to a key in a Secret resource containing client private key to
  8473. authenticate with Vault using the Cert authentication method</p>
  8474. </td>
  8475. </tr>
  8476. </tbody>
  8477. </table>
  8478. <h3 id="external-secrets.io/v1beta1.VaultClientTLS">VaultClientTLS
  8479. </h3>
  8480. <p>
  8481. (<em>Appears on:</em>
  8482. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  8483. </p>
  8484. <p>
  8485. <p>VaultClientTLS is the configuration used for client side related TLS communication,
  8486. when the Vault server requires mutual authentication.</p>
  8487. </p>
  8488. <table>
  8489. <thead>
  8490. <tr>
  8491. <th>Field</th>
  8492. <th>Description</th>
  8493. </tr>
  8494. </thead>
  8495. <tbody>
  8496. <tr>
  8497. <td>
  8498. <code>certSecretRef</code></br>
  8499. <em>
  8500. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8501. External Secrets meta/v1.SecretKeySelector
  8502. </a>
  8503. </em>
  8504. </td>
  8505. <td>
  8506. <p>CertSecretRef is a certificate added to the transport layer
  8507. when communicating with the Vault server.
  8508. If no key for the Secret is specified, external-secret will default to &lsquo;tls.crt&rsquo;.</p>
  8509. </td>
  8510. </tr>
  8511. <tr>
  8512. <td>
  8513. <code>keySecretRef</code></br>
  8514. <em>
  8515. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8516. External Secrets meta/v1.SecretKeySelector
  8517. </a>
  8518. </em>
  8519. </td>
  8520. <td>
  8521. <p>KeySecretRef to a key in a Secret resource containing client private key
  8522. added to the transport layer when communicating with the Vault server.
  8523. If no key for the Secret is specified, external-secret will default to &lsquo;tls.key&rsquo;.</p>
  8524. </td>
  8525. </tr>
  8526. </tbody>
  8527. </table>
  8528. <h3 id="external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth
  8529. </h3>
  8530. <p>
  8531. (<em>Appears on:</em>
  8532. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  8533. </p>
  8534. <p>
  8535. <p>VaultIamAuth authenticates with Vault using the Vault&rsquo;s AWS IAM authentication method. Refer: <a href="https://developer.hashicorp.com/vault/docs/auth/aws">https://developer.hashicorp.com/vault/docs/auth/aws</a></p>
  8536. </p>
  8537. <table>
  8538. <thead>
  8539. <tr>
  8540. <th>Field</th>
  8541. <th>Description</th>
  8542. </tr>
  8543. </thead>
  8544. <tbody>
  8545. <tr>
  8546. <td>
  8547. <code>path</code></br>
  8548. <em>
  8549. string
  8550. </em>
  8551. </td>
  8552. <td>
  8553. <p>Path where the AWS auth method is enabled in Vault, e.g: &ldquo;aws&rdquo;</p>
  8554. </td>
  8555. </tr>
  8556. <tr>
  8557. <td>
  8558. <code>region</code></br>
  8559. <em>
  8560. string
  8561. </em>
  8562. </td>
  8563. <td>
  8564. <p>AWS region</p>
  8565. </td>
  8566. </tr>
  8567. <tr>
  8568. <td>
  8569. <code>role</code></br>
  8570. <em>
  8571. string
  8572. </em>
  8573. </td>
  8574. <td>
  8575. <p>This is the AWS role to be assumed before talking to vault</p>
  8576. </td>
  8577. </tr>
  8578. <tr>
  8579. <td>
  8580. <code>vaultRole</code></br>
  8581. <em>
  8582. string
  8583. </em>
  8584. </td>
  8585. <td>
  8586. <p>Vault Role. In vault, a role describes an identity with a set of permissions, groups, or policies you want to attach a user of the secrets engine</p>
  8587. </td>
  8588. </tr>
  8589. <tr>
  8590. <td>
  8591. <code>externalID</code></br>
  8592. <em>
  8593. string
  8594. </em>
  8595. </td>
  8596. <td>
  8597. <p>AWS External ID set on assumed IAM roles</p>
  8598. </td>
  8599. </tr>
  8600. <tr>
  8601. <td>
  8602. <code>vaultAwsIamServerID</code></br>
  8603. <em>
  8604. string
  8605. </em>
  8606. </td>
  8607. <td>
  8608. <p>X-Vault-AWS-IAM-Server-ID is an additional header used by Vault IAM auth method to mitigate against different types of replay attacks. More details here: <a href="https://developer.hashicorp.com/vault/docs/auth/aws">https://developer.hashicorp.com/vault/docs/auth/aws</a></p>
  8609. </td>
  8610. </tr>
  8611. <tr>
  8612. <td>
  8613. <code>secretRef</code></br>
  8614. <em>
  8615. <a href="#external-secrets.io/v1beta1.VaultAwsAuthSecretRef">
  8616. VaultAwsAuthSecretRef
  8617. </a>
  8618. </em>
  8619. </td>
  8620. <td>
  8621. <em>(Optional)</em>
  8622. <p>Specify credentials in a Secret object</p>
  8623. </td>
  8624. </tr>
  8625. <tr>
  8626. <td>
  8627. <code>jwt</code></br>
  8628. <em>
  8629. <a href="#external-secrets.io/v1beta1.VaultAwsJWTAuth">
  8630. VaultAwsJWTAuth
  8631. </a>
  8632. </em>
  8633. </td>
  8634. <td>
  8635. <em>(Optional)</em>
  8636. <p>Specify a service account with IRSA enabled</p>
  8637. </td>
  8638. </tr>
  8639. </tbody>
  8640. </table>
  8641. <h3 id="external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth
  8642. </h3>
  8643. <p>
  8644. (<em>Appears on:</em>
  8645. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  8646. </p>
  8647. <p>
  8648. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  8649. method, with the role name and a token stored in a Kubernetes Secret resource or
  8650. a Kubernetes service account token retrieved via <code>TokenRequest</code>.</p>
  8651. </p>
  8652. <table>
  8653. <thead>
  8654. <tr>
  8655. <th>Field</th>
  8656. <th>Description</th>
  8657. </tr>
  8658. </thead>
  8659. <tbody>
  8660. <tr>
  8661. <td>
  8662. <code>path</code></br>
  8663. <em>
  8664. string
  8665. </em>
  8666. </td>
  8667. <td>
  8668. <p>Path where the JWT authentication backend is mounted
  8669. in Vault, e.g: &ldquo;jwt&rdquo;</p>
  8670. </td>
  8671. </tr>
  8672. <tr>
  8673. <td>
  8674. <code>role</code></br>
  8675. <em>
  8676. string
  8677. </em>
  8678. </td>
  8679. <td>
  8680. <em>(Optional)</em>
  8681. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  8682. authentication method</p>
  8683. </td>
  8684. </tr>
  8685. <tr>
  8686. <td>
  8687. <code>secretRef</code></br>
  8688. <em>
  8689. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8690. External Secrets meta/v1.SecretKeySelector
  8691. </a>
  8692. </em>
  8693. </td>
  8694. <td>
  8695. <em>(Optional)</em>
  8696. <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  8697. authenticate with Vault using the JWT/OIDC authentication method.</p>
  8698. </td>
  8699. </tr>
  8700. <tr>
  8701. <td>
  8702. <code>kubernetesServiceAccountToken</code></br>
  8703. <em>
  8704. <a href="#external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">
  8705. VaultKubernetesServiceAccountTokenAuth
  8706. </a>
  8707. </em>
  8708. </td>
  8709. <td>
  8710. <em>(Optional)</em>
  8711. <p>Optional ServiceAccountToken specifies the Kubernetes service account for which to request
  8712. a token for with the <code>TokenRequest</code> API.</p>
  8713. </td>
  8714. </tr>
  8715. </tbody>
  8716. </table>
  8717. <h3 id="external-secrets.io/v1beta1.VaultKVStoreVersion">VaultKVStoreVersion
  8718. (<code>string</code> alias)</p></h3>
  8719. <p>
  8720. (<em>Appears on:</em>
  8721. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  8722. </p>
  8723. <p>
  8724. </p>
  8725. <table>
  8726. <thead>
  8727. <tr>
  8728. <th>Value</th>
  8729. <th>Description</th>
  8730. </tr>
  8731. </thead>
  8732. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  8733. <td></td>
  8734. </tr><tr><td><p>&#34;v2&#34;</p></td>
  8735. <td></td>
  8736. </tr></tbody>
  8737. </table>
  8738. <h3 id="external-secrets.io/v1beta1.VaultKubernetesAuth">VaultKubernetesAuth
  8739. </h3>
  8740. <p>
  8741. (<em>Appears on:</em>
  8742. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  8743. </p>
  8744. <p>
  8745. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  8746. a Secret.</p>
  8747. </p>
  8748. <table>
  8749. <thead>
  8750. <tr>
  8751. <th>Field</th>
  8752. <th>Description</th>
  8753. </tr>
  8754. </thead>
  8755. <tbody>
  8756. <tr>
  8757. <td>
  8758. <code>mountPath</code></br>
  8759. <em>
  8760. string
  8761. </em>
  8762. </td>
  8763. <td>
  8764. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  8765. &ldquo;kubernetes&rdquo;</p>
  8766. </td>
  8767. </tr>
  8768. <tr>
  8769. <td>
  8770. <code>serviceAccountRef</code></br>
  8771. <em>
  8772. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  8773. External Secrets meta/v1.ServiceAccountSelector
  8774. </a>
  8775. </em>
  8776. </td>
  8777. <td>
  8778. <em>(Optional)</em>
  8779. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  8780. If the service account is specified, the service account secret token JWT will be used
  8781. for authenticating with Vault. If the service account selector is not supplied,
  8782. the secretRef will be used instead.</p>
  8783. </td>
  8784. </tr>
  8785. <tr>
  8786. <td>
  8787. <code>secretRef</code></br>
  8788. <em>
  8789. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8790. External Secrets meta/v1.SecretKeySelector
  8791. </a>
  8792. </em>
  8793. </td>
  8794. <td>
  8795. <em>(Optional)</em>
  8796. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  8797. for authenticating with Vault. If a name is specified without a key,
  8798. <code>token</code> is the default. If one is not specified, the one bound to
  8799. the controller will be used.</p>
  8800. </td>
  8801. </tr>
  8802. <tr>
  8803. <td>
  8804. <code>role</code></br>
  8805. <em>
  8806. string
  8807. </em>
  8808. </td>
  8809. <td>
  8810. <p>A required field containing the Vault Role to assume. A Role binds a
  8811. Kubernetes ServiceAccount with a set of Vault policies.</p>
  8812. </td>
  8813. </tr>
  8814. </tbody>
  8815. </table>
  8816. <h3 id="external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">VaultKubernetesServiceAccountTokenAuth
  8817. </h3>
  8818. <p>
  8819. (<em>Appears on:</em>
  8820. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth</a>)
  8821. </p>
  8822. <p>
  8823. <p>VaultKubernetesServiceAccountTokenAuth authenticates with Vault using a temporary
  8824. Kubernetes service account token retrieved by the <code>TokenRequest</code> API.</p>
  8825. </p>
  8826. <table>
  8827. <thead>
  8828. <tr>
  8829. <th>Field</th>
  8830. <th>Description</th>
  8831. </tr>
  8832. </thead>
  8833. <tbody>
  8834. <tr>
  8835. <td>
  8836. <code>serviceAccountRef</code></br>
  8837. <em>
  8838. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  8839. External Secrets meta/v1.ServiceAccountSelector
  8840. </a>
  8841. </em>
  8842. </td>
  8843. <td>
  8844. <p>Service account field containing the name of a kubernetes ServiceAccount.</p>
  8845. </td>
  8846. </tr>
  8847. <tr>
  8848. <td>
  8849. <code>audiences</code></br>
  8850. <em>
  8851. []string
  8852. </em>
  8853. </td>
  8854. <td>
  8855. <em>(Optional)</em>
  8856. <p>Optional audiences field that will be used to request a temporary Kubernetes service
  8857. account token for the service account referenced by <code>serviceAccountRef</code>.
  8858. Defaults to a single audience <code>vault</code> it not specified.
  8859. Deprecated: use serviceAccountRef.Audiences instead</p>
  8860. </td>
  8861. </tr>
  8862. <tr>
  8863. <td>
  8864. <code>expirationSeconds</code></br>
  8865. <em>
  8866. int64
  8867. </em>
  8868. </td>
  8869. <td>
  8870. <em>(Optional)</em>
  8871. <p>Optional expiration time in seconds that will be used to request a temporary
  8872. Kubernetes service account token for the service account referenced by
  8873. <code>serviceAccountRef</code>.
  8874. Deprecated: this will be removed in the future.
  8875. Defaults to 10 minutes.</p>
  8876. </td>
  8877. </tr>
  8878. </tbody>
  8879. </table>
  8880. <h3 id="external-secrets.io/v1beta1.VaultLdapAuth">VaultLdapAuth
  8881. </h3>
  8882. <p>
  8883. (<em>Appears on:</em>
  8884. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  8885. </p>
  8886. <p>
  8887. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  8888. with the username and password stored in a Kubernetes Secret resource.</p>
  8889. </p>
  8890. <table>
  8891. <thead>
  8892. <tr>
  8893. <th>Field</th>
  8894. <th>Description</th>
  8895. </tr>
  8896. </thead>
  8897. <tbody>
  8898. <tr>
  8899. <td>
  8900. <code>path</code></br>
  8901. <em>
  8902. string
  8903. </em>
  8904. </td>
  8905. <td>
  8906. <p>Path where the LDAP authentication backend is mounted
  8907. in Vault, e.g: &ldquo;ldap&rdquo;</p>
  8908. </td>
  8909. </tr>
  8910. <tr>
  8911. <td>
  8912. <code>username</code></br>
  8913. <em>
  8914. string
  8915. </em>
  8916. </td>
  8917. <td>
  8918. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  8919. authentication method</p>
  8920. </td>
  8921. </tr>
  8922. <tr>
  8923. <td>
  8924. <code>secretRef</code></br>
  8925. <em>
  8926. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8927. External Secrets meta/v1.SecretKeySelector
  8928. </a>
  8929. </em>
  8930. </td>
  8931. <td>
  8932. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  8933. user used to authenticate with Vault using the LDAP authentication
  8934. method</p>
  8935. </td>
  8936. </tr>
  8937. </tbody>
  8938. </table>
  8939. <h3 id="external-secrets.io/v1beta1.VaultProvider">VaultProvider
  8940. </h3>
  8941. <p>
  8942. (<em>Appears on:</em>
  8943. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  8944. </p>
  8945. <p>
  8946. <p>Configures an store to sync secrets using a HashiCorp Vault
  8947. KV backend.</p>
  8948. </p>
  8949. <table>
  8950. <thead>
  8951. <tr>
  8952. <th>Field</th>
  8953. <th>Description</th>
  8954. </tr>
  8955. </thead>
  8956. <tbody>
  8957. <tr>
  8958. <td>
  8959. <code>auth</code></br>
  8960. <em>
  8961. <a href="#external-secrets.io/v1beta1.VaultAuth">
  8962. VaultAuth
  8963. </a>
  8964. </em>
  8965. </td>
  8966. <td>
  8967. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  8968. </td>
  8969. </tr>
  8970. <tr>
  8971. <td>
  8972. <code>server</code></br>
  8973. <em>
  8974. string
  8975. </em>
  8976. </td>
  8977. <td>
  8978. <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>
  8979. </td>
  8980. </tr>
  8981. <tr>
  8982. <td>
  8983. <code>path</code></br>
  8984. <em>
  8985. string
  8986. </em>
  8987. </td>
  8988. <td>
  8989. <em>(Optional)</em>
  8990. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  8991. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  8992. for fetching secrets from Vault is optional and will be appended
  8993. if not present in specified path.</p>
  8994. </td>
  8995. </tr>
  8996. <tr>
  8997. <td>
  8998. <code>version</code></br>
  8999. <em>
  9000. <a href="#external-secrets.io/v1beta1.VaultKVStoreVersion">
  9001. VaultKVStoreVersion
  9002. </a>
  9003. </em>
  9004. </td>
  9005. <td>
  9006. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  9007. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  9008. </td>
  9009. </tr>
  9010. <tr>
  9011. <td>
  9012. <code>namespace</code></br>
  9013. <em>
  9014. string
  9015. </em>
  9016. </td>
  9017. <td>
  9018. <em>(Optional)</em>
  9019. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  9020. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  9021. 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>
  9022. </td>
  9023. </tr>
  9024. <tr>
  9025. <td>
  9026. <code>caBundle</code></br>
  9027. <em>
  9028. []byte
  9029. </em>
  9030. </td>
  9031. <td>
  9032. <em>(Optional)</em>
  9033. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  9034. if the Server URL is using HTTPS protocol. This parameter is ignored for
  9035. plain HTTP protocol connection. If not set the system root certificates
  9036. are used to validate the TLS connection.</p>
  9037. </td>
  9038. </tr>
  9039. <tr>
  9040. <td>
  9041. <code>tls</code></br>
  9042. <em>
  9043. <a href="#external-secrets.io/v1beta1.VaultClientTLS">
  9044. VaultClientTLS
  9045. </a>
  9046. </em>
  9047. </td>
  9048. <td>
  9049. <em>(Optional)</em>
  9050. <p>The configuration used for client side related TLS communication, when the Vault server
  9051. requires mutual authentication. Only used if the Server URL is using HTTPS protocol.
  9052. This parameter is ignored for plain HTTP protocol connection.
  9053. It&rsquo;s worth noting this configuration is different from the &ldquo;TLS certificates auth method&rdquo;,
  9054. which is available under the <code>auth.cert</code> section.</p>
  9055. </td>
  9056. </tr>
  9057. <tr>
  9058. <td>
  9059. <code>caProvider</code></br>
  9060. <em>
  9061. <a href="#external-secrets.io/v1beta1.CAProvider">
  9062. CAProvider
  9063. </a>
  9064. </em>
  9065. </td>
  9066. <td>
  9067. <em>(Optional)</em>
  9068. <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
  9069. </td>
  9070. </tr>
  9071. <tr>
  9072. <td>
  9073. <code>readYourWrites</code></br>
  9074. <em>
  9075. bool
  9076. </em>
  9077. </td>
  9078. <td>
  9079. <em>(Optional)</em>
  9080. <p>ReadYourWrites ensures isolated read-after-write semantics by
  9081. providing discovered cluster replication states in each request.
  9082. More information about eventual consistency in Vault can be found here
  9083. <a href="https://www.vaultproject.io/docs/enterprise/consistency">https://www.vaultproject.io/docs/enterprise/consistency</a></p>
  9084. </td>
  9085. </tr>
  9086. <tr>
  9087. <td>
  9088. <code>forwardInconsistent</code></br>
  9089. <em>
  9090. bool
  9091. </em>
  9092. </td>
  9093. <td>
  9094. <em>(Optional)</em>
  9095. <p>ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
  9096. leader instead of simply retrying within a loop. This can increase performance if
  9097. the option is enabled serverside.
  9098. <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>
  9099. </td>
  9100. </tr>
  9101. </tbody>
  9102. </table>
  9103. <h3 id="external-secrets.io/v1beta1.VaultUserPassAuth">VaultUserPassAuth
  9104. </h3>
  9105. <p>
  9106. (<em>Appears on:</em>
  9107. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  9108. </p>
  9109. <p>
  9110. <p>VaultUserPassAuth authenticates with Vault using UserPass authentication method,
  9111. with the username and password stored in a Kubernetes Secret resource.</p>
  9112. </p>
  9113. <table>
  9114. <thead>
  9115. <tr>
  9116. <th>Field</th>
  9117. <th>Description</th>
  9118. </tr>
  9119. </thead>
  9120. <tbody>
  9121. <tr>
  9122. <td>
  9123. <code>path</code></br>
  9124. <em>
  9125. string
  9126. </em>
  9127. </td>
  9128. <td>
  9129. <p>Path where the UserPassword authentication backend is mounted
  9130. in Vault, e.g: &ldquo;user&rdquo;</p>
  9131. </td>
  9132. </tr>
  9133. <tr>
  9134. <td>
  9135. <code>username</code></br>
  9136. <em>
  9137. string
  9138. </em>
  9139. </td>
  9140. <td>
  9141. <p>Username is a user name used to authenticate using the UserPass Vault
  9142. authentication method</p>
  9143. </td>
  9144. </tr>
  9145. <tr>
  9146. <td>
  9147. <code>secretRef</code></br>
  9148. <em>
  9149. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9150. External Secrets meta/v1.SecretKeySelector
  9151. </a>
  9152. </em>
  9153. </td>
  9154. <td>
  9155. <p>SecretRef to a key in a Secret resource containing password for the
  9156. user used to authenticate with Vault using the UserPass authentication
  9157. method</p>
  9158. </td>
  9159. </tr>
  9160. </tbody>
  9161. </table>
  9162. <h3 id="external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider
  9163. </h3>
  9164. <p>
  9165. (<em>Appears on:</em>
  9166. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  9167. </p>
  9168. <p>
  9169. <p>Defines a location to fetch the cert for the webhook provider from.</p>
  9170. </p>
  9171. <table>
  9172. <thead>
  9173. <tr>
  9174. <th>Field</th>
  9175. <th>Description</th>
  9176. </tr>
  9177. </thead>
  9178. <tbody>
  9179. <tr>
  9180. <td>
  9181. <code>type</code></br>
  9182. <em>
  9183. <a href="#external-secrets.io/v1beta1.WebhookCAProviderType">
  9184. WebhookCAProviderType
  9185. </a>
  9186. </em>
  9187. </td>
  9188. <td>
  9189. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  9190. </td>
  9191. </tr>
  9192. <tr>
  9193. <td>
  9194. <code>name</code></br>
  9195. <em>
  9196. string
  9197. </em>
  9198. </td>
  9199. <td>
  9200. <p>The name of the object located at the provider type.</p>
  9201. </td>
  9202. </tr>
  9203. <tr>
  9204. <td>
  9205. <code>key</code></br>
  9206. <em>
  9207. string
  9208. </em>
  9209. </td>
  9210. <td>
  9211. <p>The key the value inside of the provider type to use, only used with &ldquo;Secret&rdquo; type</p>
  9212. </td>
  9213. </tr>
  9214. <tr>
  9215. <td>
  9216. <code>namespace</code></br>
  9217. <em>
  9218. string
  9219. </em>
  9220. </td>
  9221. <td>
  9222. <em>(Optional)</em>
  9223. <p>The namespace the Provider type is in.</p>
  9224. </td>
  9225. </tr>
  9226. </tbody>
  9227. </table>
  9228. <h3 id="external-secrets.io/v1beta1.WebhookCAProviderType">WebhookCAProviderType
  9229. (<code>string</code> alias)</p></h3>
  9230. <p>
  9231. (<em>Appears on:</em>
  9232. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider</a>)
  9233. </p>
  9234. <p>
  9235. </p>
  9236. <table>
  9237. <thead>
  9238. <tr>
  9239. <th>Value</th>
  9240. <th>Description</th>
  9241. </tr>
  9242. </thead>
  9243. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  9244. <td></td>
  9245. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  9246. <td></td>
  9247. </tr></tbody>
  9248. </table>
  9249. <h3 id="external-secrets.io/v1beta1.WebhookProvider">WebhookProvider
  9250. </h3>
  9251. <p>
  9252. (<em>Appears on:</em>
  9253. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  9254. </p>
  9255. <p>
  9256. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  9257. </p>
  9258. <table>
  9259. <thead>
  9260. <tr>
  9261. <th>Field</th>
  9262. <th>Description</th>
  9263. </tr>
  9264. </thead>
  9265. <tbody>
  9266. <tr>
  9267. <td>
  9268. <code>method</code></br>
  9269. <em>
  9270. string
  9271. </em>
  9272. </td>
  9273. <td>
  9274. <p>Webhook Method</p>
  9275. </td>
  9276. </tr>
  9277. <tr>
  9278. <td>
  9279. <code>url</code></br>
  9280. <em>
  9281. string
  9282. </em>
  9283. </td>
  9284. <td>
  9285. <p>Webhook url to call</p>
  9286. </td>
  9287. </tr>
  9288. <tr>
  9289. <td>
  9290. <code>headers</code></br>
  9291. <em>
  9292. map[string]string
  9293. </em>
  9294. </td>
  9295. <td>
  9296. <em>(Optional)</em>
  9297. <p>Headers</p>
  9298. </td>
  9299. </tr>
  9300. <tr>
  9301. <td>
  9302. <code>body</code></br>
  9303. <em>
  9304. string
  9305. </em>
  9306. </td>
  9307. <td>
  9308. <em>(Optional)</em>
  9309. <p>Body</p>
  9310. </td>
  9311. </tr>
  9312. <tr>
  9313. <td>
  9314. <code>timeout</code></br>
  9315. <em>
  9316. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  9317. Kubernetes meta/v1.Duration
  9318. </a>
  9319. </em>
  9320. </td>
  9321. <td>
  9322. <em>(Optional)</em>
  9323. <p>Timeout</p>
  9324. </td>
  9325. </tr>
  9326. <tr>
  9327. <td>
  9328. <code>result</code></br>
  9329. <em>
  9330. <a href="#external-secrets.io/v1beta1.WebhookResult">
  9331. WebhookResult
  9332. </a>
  9333. </em>
  9334. </td>
  9335. <td>
  9336. <p>Result formatting</p>
  9337. </td>
  9338. </tr>
  9339. <tr>
  9340. <td>
  9341. <code>secrets</code></br>
  9342. <em>
  9343. <a href="#external-secrets.io/v1beta1.WebhookSecret">
  9344. []WebhookSecret
  9345. </a>
  9346. </em>
  9347. </td>
  9348. <td>
  9349. <em>(Optional)</em>
  9350. <p>Secrets to fill in templates
  9351. These secrets will be passed to the templating function as key value pairs under the given name</p>
  9352. </td>
  9353. </tr>
  9354. <tr>
  9355. <td>
  9356. <code>caBundle</code></br>
  9357. <em>
  9358. []byte
  9359. </em>
  9360. </td>
  9361. <td>
  9362. <em>(Optional)</em>
  9363. <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
  9364. if the Server URL is using HTTPS protocol. This parameter is ignored for
  9365. plain HTTP protocol connection. If not set the system root certificates
  9366. are used to validate the TLS connection.</p>
  9367. </td>
  9368. </tr>
  9369. <tr>
  9370. <td>
  9371. <code>caProvider</code></br>
  9372. <em>
  9373. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">
  9374. WebhookCAProvider
  9375. </a>
  9376. </em>
  9377. </td>
  9378. <td>
  9379. <em>(Optional)</em>
  9380. <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
  9381. </td>
  9382. </tr>
  9383. </tbody>
  9384. </table>
  9385. <h3 id="external-secrets.io/v1beta1.WebhookResult">WebhookResult
  9386. </h3>
  9387. <p>
  9388. (<em>Appears on:</em>
  9389. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  9390. </p>
  9391. <p>
  9392. </p>
  9393. <table>
  9394. <thead>
  9395. <tr>
  9396. <th>Field</th>
  9397. <th>Description</th>
  9398. </tr>
  9399. </thead>
  9400. <tbody>
  9401. <tr>
  9402. <td>
  9403. <code>jsonPath</code></br>
  9404. <em>
  9405. string
  9406. </em>
  9407. </td>
  9408. <td>
  9409. <em>(Optional)</em>
  9410. <p>Json path of return value</p>
  9411. </td>
  9412. </tr>
  9413. </tbody>
  9414. </table>
  9415. <h3 id="external-secrets.io/v1beta1.WebhookSecret">WebhookSecret
  9416. </h3>
  9417. <p>
  9418. (<em>Appears on:</em>
  9419. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  9420. </p>
  9421. <p>
  9422. </p>
  9423. <table>
  9424. <thead>
  9425. <tr>
  9426. <th>Field</th>
  9427. <th>Description</th>
  9428. </tr>
  9429. </thead>
  9430. <tbody>
  9431. <tr>
  9432. <td>
  9433. <code>name</code></br>
  9434. <em>
  9435. string
  9436. </em>
  9437. </td>
  9438. <td>
  9439. <p>Name of this secret in templates</p>
  9440. </td>
  9441. </tr>
  9442. <tr>
  9443. <td>
  9444. <code>secretRef</code></br>
  9445. <em>
  9446. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9447. External Secrets meta/v1.SecretKeySelector
  9448. </a>
  9449. </em>
  9450. </td>
  9451. <td>
  9452. <p>Secret ref to fill in credentials</p>
  9453. </td>
  9454. </tr>
  9455. </tbody>
  9456. </table>
  9457. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerAuth">YandexCertificateManagerAuth
  9458. </h3>
  9459. <p>
  9460. (<em>Appears on:</em>
  9461. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  9462. </p>
  9463. <p>
  9464. </p>
  9465. <table>
  9466. <thead>
  9467. <tr>
  9468. <th>Field</th>
  9469. <th>Description</th>
  9470. </tr>
  9471. </thead>
  9472. <tbody>
  9473. <tr>
  9474. <td>
  9475. <code>authorizedKeySecretRef</code></br>
  9476. <em>
  9477. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9478. External Secrets meta/v1.SecretKeySelector
  9479. </a>
  9480. </em>
  9481. </td>
  9482. <td>
  9483. <em>(Optional)</em>
  9484. <p>The authorized key used for authentication</p>
  9485. </td>
  9486. </tr>
  9487. </tbody>
  9488. </table>
  9489. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">YandexCertificateManagerCAProvider
  9490. </h3>
  9491. <p>
  9492. (<em>Appears on:</em>
  9493. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  9494. </p>
  9495. <p>
  9496. </p>
  9497. <table>
  9498. <thead>
  9499. <tr>
  9500. <th>Field</th>
  9501. <th>Description</th>
  9502. </tr>
  9503. </thead>
  9504. <tbody>
  9505. <tr>
  9506. <td>
  9507. <code>certSecretRef</code></br>
  9508. <em>
  9509. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9510. External Secrets meta/v1.SecretKeySelector
  9511. </a>
  9512. </em>
  9513. </td>
  9514. <td>
  9515. </td>
  9516. </tr>
  9517. </tbody>
  9518. </table>
  9519. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider
  9520. </h3>
  9521. <p>
  9522. (<em>Appears on:</em>
  9523. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  9524. </p>
  9525. <p>
  9526. <p>YandexCertificateManagerProvider Configures a store to sync secrets using the Yandex Certificate Manager provider.</p>
  9527. </p>
  9528. <table>
  9529. <thead>
  9530. <tr>
  9531. <th>Field</th>
  9532. <th>Description</th>
  9533. </tr>
  9534. </thead>
  9535. <tbody>
  9536. <tr>
  9537. <td>
  9538. <code>apiEndpoint</code></br>
  9539. <em>
  9540. string
  9541. </em>
  9542. </td>
  9543. <td>
  9544. <em>(Optional)</em>
  9545. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  9546. </td>
  9547. </tr>
  9548. <tr>
  9549. <td>
  9550. <code>auth</code></br>
  9551. <em>
  9552. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerAuth">
  9553. YandexCertificateManagerAuth
  9554. </a>
  9555. </em>
  9556. </td>
  9557. <td>
  9558. <p>Auth defines the information necessary to authenticate against Yandex Certificate Manager</p>
  9559. </td>
  9560. </tr>
  9561. <tr>
  9562. <td>
  9563. <code>caProvider</code></br>
  9564. <em>
  9565. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">
  9566. YandexCertificateManagerCAProvider
  9567. </a>
  9568. </em>
  9569. </td>
  9570. <td>
  9571. <em>(Optional)</em>
  9572. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  9573. </td>
  9574. </tr>
  9575. </tbody>
  9576. </table>
  9577. <h3 id="external-secrets.io/v1beta1.YandexLockboxAuth">YandexLockboxAuth
  9578. </h3>
  9579. <p>
  9580. (<em>Appears on:</em>
  9581. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  9582. </p>
  9583. <p>
  9584. </p>
  9585. <table>
  9586. <thead>
  9587. <tr>
  9588. <th>Field</th>
  9589. <th>Description</th>
  9590. </tr>
  9591. </thead>
  9592. <tbody>
  9593. <tr>
  9594. <td>
  9595. <code>authorizedKeySecretRef</code></br>
  9596. <em>
  9597. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9598. External Secrets meta/v1.SecretKeySelector
  9599. </a>
  9600. </em>
  9601. </td>
  9602. <td>
  9603. <em>(Optional)</em>
  9604. <p>The authorized key used for authentication</p>
  9605. </td>
  9606. </tr>
  9607. </tbody>
  9608. </table>
  9609. <h3 id="external-secrets.io/v1beta1.YandexLockboxCAProvider">YandexLockboxCAProvider
  9610. </h3>
  9611. <p>
  9612. (<em>Appears on:</em>
  9613. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  9614. </p>
  9615. <p>
  9616. </p>
  9617. <table>
  9618. <thead>
  9619. <tr>
  9620. <th>Field</th>
  9621. <th>Description</th>
  9622. </tr>
  9623. </thead>
  9624. <tbody>
  9625. <tr>
  9626. <td>
  9627. <code>certSecretRef</code></br>
  9628. <em>
  9629. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9630. External Secrets meta/v1.SecretKeySelector
  9631. </a>
  9632. </em>
  9633. </td>
  9634. <td>
  9635. </td>
  9636. </tr>
  9637. </tbody>
  9638. </table>
  9639. <h3 id="external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider
  9640. </h3>
  9641. <p>
  9642. (<em>Appears on:</em>
  9643. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  9644. </p>
  9645. <p>
  9646. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
  9647. </p>
  9648. <table>
  9649. <thead>
  9650. <tr>
  9651. <th>Field</th>
  9652. <th>Description</th>
  9653. </tr>
  9654. </thead>
  9655. <tbody>
  9656. <tr>
  9657. <td>
  9658. <code>apiEndpoint</code></br>
  9659. <em>
  9660. string
  9661. </em>
  9662. </td>
  9663. <td>
  9664. <em>(Optional)</em>
  9665. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  9666. </td>
  9667. </tr>
  9668. <tr>
  9669. <td>
  9670. <code>auth</code></br>
  9671. <em>
  9672. <a href="#external-secrets.io/v1beta1.YandexLockboxAuth">
  9673. YandexLockboxAuth
  9674. </a>
  9675. </em>
  9676. </td>
  9677. <td>
  9678. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
  9679. </td>
  9680. </tr>
  9681. <tr>
  9682. <td>
  9683. <code>caProvider</code></br>
  9684. <em>
  9685. <a href="#external-secrets.io/v1beta1.YandexLockboxCAProvider">
  9686. YandexLockboxCAProvider
  9687. </a>
  9688. </em>
  9689. </td>
  9690. <td>
  9691. <em>(Optional)</em>
  9692. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  9693. </td>
  9694. </tr>
  9695. </tbody>
  9696. </table>
  9697. <hr/>
  9698. <p><em>
  9699. Generated with <code>gen-crd-api-reference-docs</code>.
  9700. </em></p>
  9701. </article>
  9702. </div>
  9703. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  9704. </div>
  9705. </main>
  9706. <footer class="md-footer">
  9707. <div class="md-footer-meta md-typeset">
  9708. <div class="md-footer-meta__inner md-grid">
  9709. <div class="md-copyright">
  9710. <div class="md-copyright__highlight">
  9711. &copy; 2024 The external-secrets Authors.<br/>
  9712. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  9713. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  9714. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  9715. </div>
  9716. Made with
  9717. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  9718. Material for MkDocs
  9719. </a>
  9720. </div>
  9721. </div>
  9722. </div>
  9723. </footer>
  9724. </div>
  9725. <div class="md-dialog" data-md-component="dialog">
  9726. <div class="md-dialog__inner md-typeset"></div>
  9727. </div>
  9728. <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>
  9729. <script src="../../assets/javascripts/bundle.1e8ae164.min.js"></script>
  9730. </body>
  9731. </html>