index.html 231 KB

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