| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435 |
- <!doctype html>
- <html lang="en" class="no-js">
- <head>
-
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width,initial-scale=1">
-
-
-
- <link rel="icon" href="../../assets/images/favicon.png">
- <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
-
-
-
- <title>API specification - External Secrets Operator</title>
-
-
-
- <link rel="stylesheet" href="../../assets/stylesheets/main.d6be258b.min.css">
-
-
- <link rel="stylesheet" href="../../assets/stylesheets/palette.e6a45f82.min.css">
-
-
-
-
-
-
-
- <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
- <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
-
-
-
- <script>__md_scope=new URL("../..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-
-
-
-
-
- <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&>ag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
- <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
-
-
- </head>
-
-
-
-
-
-
-
- <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
-
-
-
- <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
- <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
- <label class="md-overlay" for="__drawer"></label>
- <div data-md-component="skip">
-
- </div>
- <div data-md-component="announce">
-
- </div>
-
- <div data-md-component="outdated" hidden>
- <aside class="md-banner md-banner--warning">
-
- <div class="md-banner__inner md-grid md-typeset">
-
- You're not viewing the latest version.
- <a href="../../..">
- <strong>Click here to go to latest.</strong>
- </a>
- </div>
- <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
-
- </aside>
- </div>
-
-
-
- <header class="md-header" data-md-component="header">
- <nav class="md-header__inner md-grid" aria-label="Header">
- <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
-
-
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
- </a>
- <label class="md-header__button md-icon" for="__drawer">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
- </label>
- <div class="md-header__title" data-md-component="header-title">
- <div class="md-header__ellipsis">
- <div class="md-header__topic">
- <span class="md-ellipsis">
- External Secrets Operator
- </span>
- </div>
- <div class="md-header__topic" data-md-component="header-topic">
- <span class="md-ellipsis">
-
- API specification
-
- </span>
- </div>
- </div>
- </div>
-
-
-
- <label class="md-header__button md-icon" for="__search">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
- </label>
- <div class="md-search" data-md-component="search" role="dialog">
- <label class="md-search__overlay" for="__search"></label>
- <div class="md-search__inner" role="search">
- <form class="md-search__form" name="search">
- <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>
- <label class="md-search__icon md-icon" for="__search">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
- </label>
- <nav class="md-search__options" aria-label="Search">
-
- <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
- </button>
- </nav>
-
- </form>
- <div class="md-search__output">
- <div class="md-search__scrollwrap" data-md-scrollfix>
- <div class="md-search-result" data-md-component="search-result">
- <div class="md-search-result__meta">
- Initializing search
- </div>
- <ol class="md-search-result__list"></ol>
- </div>
- </div>
- </div>
- </div>
- </div>
-
-
- <div class="md-header__source">
- <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
- <div class="md-source__icon md-icon">
-
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
- </div>
- <div class="md-source__repository">
- External Secrets Operator
- </div>
- </a>
- </div>
-
- </nav>
-
- </header>
-
- <div class="md-container" data-md-component="container">
-
-
-
-
-
- <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
- <div class="md-tabs__inner md-grid">
- <ul class="md-tabs__list">
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../.." class="md-tabs__link">
- Introduction
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../components/" class="md-tabs__link md-tabs__link--active">
- API
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../../guides/introduction/" class="md-tabs__link">
- Guides
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
- Provider
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
- Examples
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-tabs__item">
- <a href="../../contributing/devguide/" class="md-tabs__link">
- Community
- </a>
- </li>
-
-
-
- </ul>
- </div>
- </nav>
-
-
-
- <main class="md-main" data-md-component="main">
- <div class="md-main__inner md-grid">
-
-
-
- <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
- <div class="md-sidebar__scrollwrap">
- <div class="md-sidebar__inner">
-
-
- <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
- <label class="md-nav__title" for="__drawer">
- <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
-
-
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
- </a>
- External Secrets Operator
- </label>
-
- <div class="md-nav__source">
- <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
- <div class="md-source__icon md-icon">
-
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
- </div>
- <div class="md-source__repository">
- External Secrets Operator
- </div>
- </a>
- </div>
-
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <div class="md-nav__link md-nav__link--index ">
- <a href="../..">Introduction</a>
-
- <label for="__nav_1">
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- </div>
-
- <nav class="md-nav" aria-label="Introduction" data-md-level="1">
- <label class="md-nav__title" for="__nav_1">
- <span class="md-nav__icon md-icon"></span>
- Introduction
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/overview/" class="md-nav__link">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/getting-started/" class="md-nav__link">
- Getting started
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/faq/" class="md-nav__link">
- FAQ
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/stability-support/" class="md-nav__link">
- Stability and Support
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../introduction/deprecation-policy/" class="md-nav__link">
- Deprecation Policy
- </a>
- </li>
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <label class="md-nav__link" for="__nav_2">
- API
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" aria-label="API" data-md-level="1">
- <label class="md-nav__title" for="__nav_2">
- <span class="md-nav__icon md-icon"></span>
- API
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../components/" class="md-nav__link">
- Components
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <label class="md-nav__link" for="__nav_2_2">
- Core Resources
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
- <label class="md-nav__title" for="__nav_2_2">
- <span class="md-nav__icon md-icon"></span>
- Core Resources
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../externalsecret/" class="md-nav__link">
- ExternalSecret
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../secretstore/" class="md-nav__link">
- SecretStore
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../clustersecretstore/" class="md-nav__link">
- ClusterSecretStore
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../clusterexternalsecret/" class="md-nav__link">
- ClusterExternalSecret
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../pushsecret/" class="md-nav__link">
- PushSecret
- </a>
- </li>
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <div class="md-nav__link md-nav__link--index ">
- <a href="../generator/">Generators</a>
-
- <label for="__nav_2_3">
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- </div>
-
- <nav class="md-nav" aria-label="Generators" data-md-level="2">
- <label class="md-nav__title" for="__nav_2_3">
- <span class="md-nav__icon md-icon"></span>
- Generators
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/acr/" class="md-nav__link">
- Azure Container Registry
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/ecr/" class="md-nav__link">
- AWS Elastic Container Registry
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/gcr/" class="md-nav__link">
- Google Container Registry
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/vault/" class="md-nav__link">
- Vault Dynamic Secret
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/password/" class="md-nav__link">
- Password
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../generator/fake/" class="md-nav__link">
- Fake
- </a>
- </li>
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" type="checkbox" id="__nav_2_4" checked>
-
-
-
-
-
-
-
-
-
-
-
-
- <label class="md-nav__link" for="__nav_2_4">
- Reference Docs
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
- <label class="md-nav__title" for="__nav_2_4">
- <span class="md-nav__icon md-icon"></span>
- Reference Docs
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active">
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
-
-
-
- <a href="./" class="md-nav__link md-nav__link--active">
- API specification
- </a>
-
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../controller-options/" class="md-nav__link">
- Controller Options
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../metrics/" class="md-nav__link">
- Metrics
- </a>
- </li>
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <label class="md-nav__link" for="__nav_3">
- Guides
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" aria-label="Guides" data-md-level="1">
- <label class="md-nav__title" for="__nav_3">
- <span class="md-nav__icon md-icon"></span>
- Guides
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/introduction/" class="md-nav__link">
- Introduction
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
-
-
-
-
-
-
-
-
-
-
- <label class="md-nav__link" for="__nav_3_2">
- Advanced Templating
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
- <label class="md-nav__title" for="__nav_3_2">
- <span class="md-nav__icon md-icon"></span>
- Advanced Templating
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/templating/" class="md-nav__link">
- v2
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/templating-v1/" class="md-nav__link">
- v1
- </a>
- </li>
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/generator/" class="md-nav__link">
- Generators
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
- All keys, One secret
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
- Common K8S Secret Types
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/controller-class/" class="md-nav__link">
- Controller Classes
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
- Lifecycle: ownership & deletion
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/decoding-strategy/" class="md-nav__link">
- Decoding Strategies
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/getallsecrets/" class="md-nav__link">
- Getting Multiple Secrets
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/multi-tenancy/" class="md-nav__link">
- Multi Tenancy
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
- Rewriting Keys
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/v1beta1/" class="md-nav__link">
- Upgrading to v1beta1
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/using-latest-image/" class="md-nav__link">
- Using Latest Image
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../guides/disable-cluster-features/" class="md-nav__link">
- Disable Cluster Features
- </a>
- </li>
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <label class="md-nav__link" for="__nav_4">
- Provider
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" aria-label="Provider" data-md-level="1">
- <label class="md-nav__title" for="__nav_4">
- <span class="md-nav__icon md-icon"></span>
- Provider
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
- AWS Secrets Manager
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/aws-parameter-store/" class="md-nav__link">
- AWS Parameter Store
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/azure-key-vault/" class="md-nav__link">
- Azure Key Vault
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/google-secrets-manager/" class="md-nav__link">
- Google Secret Manager
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
- IBM Secrets Manager
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/akeyless/" class="md-nav__link">
- Akeyless
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/hashicorp-vault/" class="md-nav__link">
- HashiCorp Vault
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
- Yandex Certificate Manager
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/yandex-lockbox/" class="md-nav__link">
- Yandex Lockbox
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/gitlab-variables/" class="md-nav__link">
- Gitlab Variables
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/oracle-vault/" class="md-nav__link">
- Oracle Vault
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/1password-automation/" class="md-nav__link">
- 1Password Secrets Automation
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/webhook/" class="md-nav__link">
- Webhook
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/fake/" class="md-nav__link">
- Fake
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/kubernetes/" class="md-nav__link">
- Kubernetes
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
- senhasegura DevOps Secrets Management (DSM)
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/doppler/" class="md-nav__link">
- Doppler
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/keeper-security/" class="md-nav__link">
- Keeper Security
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../provider/scaleway/" class="md-nav__link">
- Scaleway
- </a>
- </li>
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <label class="md-nav__link" for="__nav_5">
- Examples
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" aria-label="Examples" data-md-level="1">
- <label class="md-nav__title" for="__nav_5">
- <span class="md-nav__icon md-icon"></span>
- Examples
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
- FluxCD
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
- Anchore Engine
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
- Jenkins
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../examples/bitwarden/" class="md-nav__link">
- BitWarden
- </a>
- </li>
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
-
-
-
-
-
-
-
-
-
-
- <label class="md-nav__link" for="__nav_6">
- Community
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" aria-label="Community" data-md-level="1">
- <label class="md-nav__title" for="__nav_6">
- <span class="md-nav__icon md-icon"></span>
- Community
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <label class="md-nav__link" for="__nav_6_1">
- Contributing
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" aria-label="Contributing" data-md-level="2">
- <label class="md-nav__title" for="__nav_6_1">
- <span class="md-nav__icon md-icon"></span>
- Contributing
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/devguide/" class="md-nav__link">
- Developer guide
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/process/" class="md-nav__link">
- Contributing Process
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/release/" class="md-nav__link">
- Release Process
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/coc/" class="md-nav__link">
- Code of Conduct
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../contributing/roadmap/" class="md-nav__link">
- Roadmap
- </a>
- </li>
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
-
-
-
-
-
-
-
-
-
-
-
-
- <label class="md-nav__link" for="__nav_6_2">
- External Resources
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" aria-label="External Resources" data-md-level="2">
- <label class="md-nav__title" for="__nav_6_2">
- <span class="md-nav__icon md-icon"></span>
- External Resources
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../eso-talks/" class="md-nav__link">
- Talks
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../eso-demos/" class="md-nav__link">
- Demos
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../eso-blogs/" class="md-nav__link">
- Blogs
- </a>
- </li>
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
- </ul>
- </nav>
- </li>
-
-
- </ul>
- </nav>
- </div>
- </div>
- </div>
-
-
-
- <div class="md-content" data-md-component="content">
- <article class="md-content__inner md-typeset">
-
-
- <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/api/spec.md" title="Edit this page" class="md-content__button md-icon">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
- </a>
- <h1>API specification</h1>
- <p>Packages:</p>
- <ul>
- <li>
- <a href="#external-secrets.io%2fv1beta1">external-secrets.io/v1beta1</a>
- </li>
- </ul>
- <h2 id="external-secrets.io/v1beta1">external-secrets.io/v1beta1</h2>
- <p>
- <p>Package v1beta1 contains resources for external-secrets</p>
- </p>
- <p>Resource Types:</p>
- <ul></ul>
- <h3 id="external-secrets.io/v1beta1.AWSAuth">AWSAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
- </p>
- <p>
- <p>AWSAuth tells the controller how to do authentication with aws.
- Only one of secretRef or jwt can be specified.
- if none is specified the controller will load credentials using the aws sdk defaults.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AWSAuthSecretRef">
- AWSAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AWSJWTAuth">
- AWSJWTAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AWSAuthSecretRef">AWSAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
- </p>
- <p>
- <p>AWSAuthSecretRef holds secret references for AWS credentials
- both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessKeyIDSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessKeyID is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretAccessKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SecretAccessKey is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sessionTokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SessionToken used for authentication
- This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
- 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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AWSJWTAuth">AWSJWTAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
- </p>
- <p>
- <p>Authenticate against AWS using service account tokens.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AWSProvider">AWSProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>AWSProvider configures a store to sync secrets with AWS.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>service</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AWSServiceType">
- AWSServiceType
- </a>
- </em>
- </td>
- <td>
- <p>Service defines which service should be used to fetch the secrets</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AWSAuth">
- AWSAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth defines the information necessary to authenticate against AWS
- if not set aws sdk will infer credentials from your environment
- 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>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Role is a Role ARN which the SecretManager provider will assume</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>AWS Region to be used for the provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>additionalRoles</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AdditionalRoles is a chained list of Role ARNs which the SecretManager provider will sequentially assume before assuming Role</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AWSServiceType">AWSServiceType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
- </p>
- <p>
- <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ParameterStore"</p></td>
- <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore.
- 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>
- </td>
- </tr><tr><td><p>"SecretsManager"</p></td>
- <td><p>AWSServiceSecretsManager is the AWS SecretsManager.
- 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>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AkeylessAuthSecretRef">
- AkeylessAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Reference to a Secret that contains the details
- to authenticate with Akeyless.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetesAuth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AkeylessKubernetesAuth">
- AkeylessKubernetesAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kubernetes authenticates with Akeyless by passing the ServiceAccount
- token stored in the named Secret resource.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
- </p>
- <p>
- <p>AkeylessAuthSecretRef
- AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessID</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SecretAccessID is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessType</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessTypeParam</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AkeylessKubernetesAuth">AkeylessKubernetesAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
- </p>
- <p>
- <p>Authenticate with Kubernetes ServiceAccount token stored.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>the Akeyless Kubernetes auth-method access-id</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>k8sConfName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Kubernetes-auth configuration name in Akeyless-Gateway</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional service account field containing the name of a kubernetes ServiceAccount.
- If the service account is specified, the service account secret token JWT will be used
- for authenticating with Akeyless. If the service account selector is not supplied,
- the secretRef will be used instead.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
- for authenticating with Akeyless. If a name is specified without a key,
- <code>token</code> is the default. If one is not specified, the one bound to
- the controller will be used.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>akeylessGWApiURL</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>authSecretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AkeylessAuth">
- AkeylessAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the operator authenticates with Akeyless.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM/base64 encoded CA bundle used to validate Akeyless Gateway certificate. Only used
- if the AkeylessGWApiURL URL is using HTTPS protocol. If not set the system root certificates
- are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Akeyless Gateway certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider</a>)
- </p>
- <p>
- <p>AlibabaAuth contains a secretRef for credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AlibabaAuthSecretRef">
- AlibabaAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
- </p>
- <p>
- <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessKeyIDSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessKeyID is used for authentication</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessKeySecretSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The AccessKeySecret is used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AlibabaAuth">
- AlibabaAuth
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>endpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>regionID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Alibaba Region to be used for the provider</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AzureAuthType">AzureAuthType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
- </p>
- <p>
- <p>AuthType describes how to authenticate to the Azure Keyvault
- Only one of the following auth types may be specified.
- If none of the following auth type is specified, the default one
- is ServicePrincipal.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ManagedIdentity"</p></td>
- <td><p>Using Managed Identity to authenticate. Used with aad-pod-identity installed in the cluster.</p>
- </td>
- </tr><tr><td><p>"ServicePrincipal"</p></td>
- <td><p>Using service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.</p>
- </td>
- </tr><tr><td><p>"WorkloadIdentity"</p></td>
- <td><p>Using Workload Identity service accounts to authenticate.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AzureEnvironmentType">AzureEnvironmentType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
- </p>
- <p>
- <p>AzureEnvironmentType specifies the Azure cloud environment endpoints to use for
- connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
- 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>
- PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ChinaCloud"</p></td>
- <td></td>
- </tr><tr><td><p>"GermanCloud"</p></td>
- <td></td>
- </tr><tr><td><p>"PublicCloud"</p></td>
- <td></td>
- </tr><tr><td><p>"USGovernmentCloud"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AzureKVAuth">AzureKVAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
- </p>
- <p>
- <p>Configuration used to authenticate with Azure.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientId</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The Azure clientId of the service principle used for authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientSecret</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The Azure ClientSecret of the service principle used for authentication.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>Configures an store to sync secrets using Azure KV.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>authType</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AzureAuthType">
- AzureAuthType
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth type defines how to authenticate to the keyvault service.
- Valid values are:
- - “ServicePrincipal” (default): Using a service principal (tenantId, clientId, clientSecret)
- - “ManagedIdentity”: Using Managed Identity assigned to the pod (see aad-pod-identity)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vaultUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Vault Url from which the secrets to be fetched from.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tenantId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environmentType</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AzureEnvironmentType">
- AzureEnvironmentType
- </a>
- </em>
- </td>
- <td>
- <p>EnvironmentType specifies the Azure cloud environment endpoints to use for
- connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
- 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>
- PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>authSecretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AzureKVAuth">
- AzureKVAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ServiceAccountRef specified the service account
- that should be used when authenticating with WorkloadIdentity.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>identityId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.CAProvider">CAProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>,
- <a href="#external-secrets.io/v1beta1.KubernetesServer">KubernetesServer</a>,
- <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
- </p>
- <p>
- <p>Used to provide custom certificate authority (CA) certificates
- for a secret store. The CAProvider points to a Secret or ConfigMap resource
- that contains a PEM-encoded certificate.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CAProviderType">
- CAProviderType
- </a>
- </em>
- </td>
- <td>
- <p>The type of provider to use such as “Secret”, or “ConfigMap”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The name of the object located at the provider type.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The key where the CA certificate can be found in the Secret or ConfigMap.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The namespace the Provider type is in.
- Can only be defined when used in a ClusterSecretStore.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.CAProviderType">CAProviderType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.CAProvider">CAProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ConfigMap"</p></td>
- <td></td>
- </tr><tr><td><p>"Secret"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.CertAuth">CertAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientCert</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientKey</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret
- </h3>
- <p>
- <p>ClusterExternalSecret is the Schema for the clusterexternalsecrets API.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">
- ClusterExternalSecretSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>externalSecretSpec</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
- ExternalSecretSpec
- </a>
- </em>
- </td>
- <td>
- <p>The spec for the ExternalSecrets to be created</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalSecretName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceSelector</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
- Kubernetes meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshTime</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>The time in which the controller should reconcile it’s objects and recheck namespaces for labels.</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">
- ClusterExternalSecretStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretConditionType">ClusterExternalSecretConditionType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"NotReady"</p></td>
- <td></td>
- </tr><tr><td><p>"PartiallyReady"</p></td>
- <td></td>
- </tr><tr><td><p>"Ready"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">ClusterExternalSecretNamespaceFailure
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
- </p>
- <p>
- <p>ClusterExternalSecretNamespaceFailure represents a failed namespace deployment and it’s reason.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Namespace is the namespace that failed when trying to apply an ExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>reason</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Reason is why the ExternalSecret failed to apply to the namespace</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
- </p>
- <p>
- <p>ClusterExternalSecretSpec defines the desired state of ClusterExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>externalSecretSpec</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
- ExternalSecretSpec
- </a>
- </em>
- </td>
- <td>
- <p>The spec for the ExternalSecrets to be created</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>externalSecretName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaceSelector</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
- Kubernetes meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshTime</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>The time in which the controller should reconcile it’s objects and recheck namespaces for labels.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
- </p>
- <p>
- <p>ClusterExternalSecretStatus defines the observed state of ClusterExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>failedNamespaces</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">
- []ClusterExternalSecretNamespaceFailure
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Failed namespaces are the namespaces that failed to apply an ExternalSecret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provisionedNamespaces</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ProvisionedNamespaces are the namespaces where the ClusterExternalSecret has secrets</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">
- []ClusterExternalSecretStatusCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretConditionType">
- ClusterExternalSecretConditionType
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
- Kubernetes core/v1.ConditionStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>message</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore
- </h3>
- <p>
- <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
- SecretStoreSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select the correct KES controller (think: ingress.ingressClassName)
- The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
- SecretStoreProvider
- </a>
- </em>
- </td>
- <td>
- <p>Used to configure the provider. Only one provider may be set</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrySettings</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
- SecretStoreRetrySettings
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure http retries if failed</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
- []ClusterSecretStoreCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
- SecretStoreStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ClusterSecretStoreCondition">ClusterSecretStoreCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
- </p>
- <p>
- <p>ClusterSecretStoreCondition describes a condition by which to choose namespaces to process ExternalSecrets in
- for a ClusterSecretStore instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>namespaceSelector</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
- Kubernetes meta/v1.LabelSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Choose namespace using a labelSelector</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespaces</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <p>Choose namespaces by name</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.DopplerAuth">DopplerAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.DopplerProvider">DopplerProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.DopplerAuthSecretRef">
- DopplerAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.DopplerAuthSecretRef">DopplerAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.DopplerAuth">DopplerAuth</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>dopplerToken</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The DopplerToken is used for authentication.
- See <a href="https://docs.doppler.com/reference/api#authentication">https://docs.doppler.com/reference/api#authentication</a> for auth token types.
- The Key attribute defaults to dopplerToken if not specified.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.DopplerProvider">DopplerProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>DopplerProvider configures a store to sync secrets using the Doppler provider.
- Project and Config are required if not using a Service Token.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.DopplerAuth">
- DopplerAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how the Operator authenticates with the Doppler API</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>project</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Doppler project (required if not using a Service Token)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>config</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Doppler config (required if not using a Service Token)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>nameTransformer</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Environment variable compatible name transforms that change secret names to a different format</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>format</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Format enables the downloading of secrets as a file (string)</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecret">ExternalSecret
- </h3>
- <p>
- <p>ExternalSecret is the Schema for the external-secrets API.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
- ExternalSecretSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>secretStoreRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreRef">
- SecretStoreRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>target</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
- ExternalSecretTarget
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
- Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”
- May be set to zero to fetch and create it once. Defaults to 1h.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretData">
- []ExternalSecretData
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>dataFrom</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
- []ExternalSecretDataFromRemoteRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>DataFrom is used to fetch all properties from a specific Provider data
- If multiple entries are specified, the Secret keys are merged in the specified order</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">
- ExternalSecretStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretConditionType">ExternalSecretConditionType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Deleted"</p></td>
- <td></td>
- </tr><tr><td><p>"Ready"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretConversionStrategy">ExternalSecretConversionStrategy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
- <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Default"</p></td>
- <td></td>
- </tr><tr><td><p>"Unicode"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
- </p>
- <p>
- <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Merge"</p></td>
- <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
- </td>
- </tr><tr><td><p>"None"</p></td>
- <td><p>None does not create a Secret (future use with injector).</p>
- </td>
- </tr><tr><td><p>"Orphan"</p></td>
- <td><p>Orphan creates the Secret and does not set the ownerReference.
- I.e. it will be orphaned after the deletion of the ExternalSecret.</p>
- </td>
- </tr><tr><td><p>"Owner"</p></td>
- <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretKey</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>SecretKey defines the key in which the controller stores
- the value. This is the key in the Kind=Secret</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>remoteRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
- ExternalSecretDataRemoteRef
- </a>
- </em>
- </td>
- <td>
- <p>RemoteRef points to the remote secret and defines
- which secret (version/property/..) to fetch.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sourceRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SourceRef">
- SourceRef
- </a>
- </em>
- </td>
- <td>
- <p>SourceRef allows you to override the source
- from which the value will pulled from.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>extract</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
- ExternalSecretDataRemoteRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to extract multiple key/value pairs from one secret
- Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>find</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretFind">
- ExternalSecretFind
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to find secrets based on tags or regular expressions
- Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>rewrite</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">
- []ExternalSecretRewrite
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to rewrite secret Keys after getting them from the secret Provider
- Multiple Rewrite operations can be provided. They are applied in a layered order (first to last)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>sourceRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SourceRef">
- SourceRef
- </a>
- </em>
- </td>
- <td>
- <p>SourceRef points to a store or generator
- which contains secret values ready to use.
- Use this in combination with Extract or Find pull values out of
- a specific SecretStore.
- When sourceRef points to a generator Extract or Find is not supported.
- The generator returns a static map of values</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>,
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
- </p>
- <p>
- <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Key is the key used in the Provider, mandatory</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>metadataPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">
- ExternalSecretMetadataPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>property</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select a specific property of the Provider value (if a map), if supported</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>version</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select a specific version of the Provider value, if supported</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conversionStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
- ExternalSecretConversionStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a conversion Strategy</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>decodingStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
- ExternalSecretDecodingStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a decoding Strategy</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">ExternalSecretDecodingStrategy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
- <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Auto"</p></td>
- <td></td>
- </tr><tr><td><p>"Base64"</p></td>
- <td></td>
- </tr><tr><td><p>"Base64URL"</p></td>
- <td></td>
- </tr><tr><td><p>"None"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">ExternalSecretDeletionPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
- </p>
- <p>
- <p>ExternalSecretDeletionPolicy defines rules on how to delete the resulting Secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Delete"</p></td>
- <td><p>Delete deletes the secret if all provider secrets are deleted.
- If a secret gets deleted on the provider side and is not accessible
- anymore this is not considered an error and the ExternalSecret
- does not go into SecretSyncedError status.</p>
- </td>
- </tr><tr><td><p>"Merge"</p></td>
- <td><p>Merge removes keys in the secret, but not the secret itself.
- If a secret gets deleted on the provider side and is not accessible
- anymore this is not considered an error and the ExternalSecret
- does not go into SecretSyncedError status.</p>
- </td>
- </tr><tr><td><p>"Retain"</p></td>
- <td><p>Retain will retain the secret if all provider secrets have been deleted.
- If a provider secret does not exist the ExternalSecret gets into the
- SecretSyncedError status.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>A root path to start the find operations.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.FindName">
- FindName
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Finds secrets based on the name.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tags</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Find secrets based on tags.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conversionStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
- ExternalSecretConversionStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a conversion Strategy</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>decodingStrategy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
- ExternalSecretDecodingStrategy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to define a decoding Strategy</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">ExternalSecretMetadataPolicy
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Fetch"</p></td>
- <td></td>
- </tr><tr><td><p>"None"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>regexp</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">
- ExternalSecretRewriteRegexp
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to rewrite with regular expressions.
- The resulting key will be the output of a regexp.ReplaceAll operation.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">ExternalSecretRewriteRegexp
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>source</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Used to define the regular expression of a re.Compiler.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>target</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Used to define the target pattern of a ReplaceAll operation.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>,
- <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
- </p>
- <p>
- <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretStoreRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreRef">
- SecretStoreRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>target</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
- ExternalSecretTarget
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
- Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”
- May be set to zero to fetch and create it once. Defaults to 1h.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretData">
- []ExternalSecretData
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>dataFrom</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
- []ExternalSecretDataFromRemoteRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>DataFrom is used to fetch all properties from a specific Provider data
- If multiple entries are specified, the Secret keys are merged in the specified order</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>refreshTime</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <p>refreshTime is the time and date the external secret was fetched and
- the target secret updated</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>syncedResourceVersion</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>SyncedResourceVersion keeps track of the last synced version</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">
- []ExternalSecretStatusCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretConditionType">
- ExternalSecretConditionType
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
- Kubernetes core/v1.ConditionStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>reason</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>message</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>lastTransitionTime</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
- </p>
- <p>
- <p>ExternalSecretTarget defines the Kubernetes Secret to be created
- There can be only one target per ExternalSecret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Name defines the name of the Secret resource to be managed
- This field is immutable
- Defaults to the .metadata.name of the ExternalSecret resource</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>creationPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretCreationPolicy">
- ExternalSecretCreationPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CreationPolicy defines rules on how to create the resulting Secret
- Defaults to ‘Owner’</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>deletionPolicy</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">
- ExternalSecretDeletionPolicy
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>DeletionPolicy defines rules on how to delete the resulting Secret
- Defaults to ‘Retain’</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>template</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">
- ExternalSecretTemplate
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Template defines a blueprint for the created Secret resource.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>immutable</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Immutable defines if the final secret will be immutable</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
- </p>
- <p>
- <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
- 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>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secrettype-v1-core">
- Kubernetes core/v1.SecretType
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>engineVersion</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateEngineVersion">
- TemplateEngineVersion
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">
- ExternalSecretTemplateMetadata
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>templateFrom</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateFrom">
- []TemplateFrom
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
- </p>
- <p>
- <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>annotations</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>labels</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ExternalSecretValidator">ExternalSecretValidator
- </h3>
- <p>
- </p>
- <h3 id="external-secrets.io/v1beta1.FakeProvider">FakeProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>FakeProvider configures a fake provider that returns static values.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>data</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.FakeProviderData">
- []FakeProviderData
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.FakeProviderData">FakeProviderData
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.FakeProvider">FakeProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>valueMap</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>version</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.FindName">FindName
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>regexp</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Finds secrets base</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GCPSMAuthSecretRef">
- GCPSMAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>workloadIdentity</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GCPWorkloadIdentity">
- GCPWorkloadIdentity
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretAccessKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The SecretAccessKey is used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GCPSMAuth">
- GCPSMAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth defines the information necessary to authenticate against GCP</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectID project where secret is located</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GCPWorkloadIdentity">GCPWorkloadIdentity
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clusterLocation</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clusterName</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clusterProjectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GeneratorRef">GeneratorRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SourceRef">SourceRef</a>)
- </p>
- <p>
- <p>GeneratorRef points to a generator custom resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiVersion</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Specify the apiVersion of the generator resource</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kind</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Specify the Kind of the resource, e.g. Password, ACRAccessToken etc.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Specify the name of the generator resource</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GenericStore">GenericStore
- </h3>
- <p>
- <p>GenericStore is a common interface for interacting with ClusterSecretStore
- or a namespaced SecretStore.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.GenericStoreValidator">GenericStoreValidator
- </h3>
- <p>
- </p>
- <h3 id="external-secrets.io/v1beta1.GitlabAuth">GitlabAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.GitlabProvider">GitlabProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>SecretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GitlabSecretRef">
- GitlabSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GitlabProvider">GitlabProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>Configures a store to sync secrets with a GitLab instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GitlabAuth">
- GitlabAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ProjectID specifies a project where secrets are located.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>inheritFromGroups</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <p>InheritFromGroups specifies whether parent groups should be discovered and checked for secrets.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>groupIDs</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <p>GroupIDs specify, which gitlab groups to pull secrets from. Group secrets are read from left to right followed by the project variables.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>environment</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.GitlabSecretRef">GitlabSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.GitlabAuth">GitlabAuth</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>accessToken</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>AccessToken is used for authentication.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.IBMAuth">IBMAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.IBMProvider">IBMProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.IBMAuthSecretRef">
- IBMAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>containerAuth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.IBMAuthContainerAuth">
- IBMAuthContainerAuth
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.IBMAuthContainerAuth">IBMAuthContainerAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
- </p>
- <p>
- <p>IBM Container-based auth with IAM Trusted Profile.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>profile</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>the IBM Trusted Profile</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>tokenLocation</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Location the token is mounted on the pod</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>iamEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.IBMAuthSecretRef">IBMAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretApiKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The SecretAccessKey is used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.IBMProvider">IBMProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
- backend.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.IBMAuth">
- IBMAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.KeeperSecurityProvider">KeeperSecurityProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>KeeperSecurityProvider Configures a store to sync secrets using Keeper Security.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>authRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>folderID</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>cert</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CertAuth">
- CertAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>has both clientCert and clientKey as secretKeySelector</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>token</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TokenAuth">
- TokenAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>use static token to authenticate with</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccount</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>points to a service account that should be used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>Configures a store to sync secrets with a Kubernetes instance.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>server</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.KubernetesServer">
- KubernetesServer
- </a>
- </em>
- </td>
- <td>
- <p>configures the Kubernetes server Address.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.KubernetesAuth">
- KubernetesAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with a Kubernetes instance.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>remoteNamespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Remote namespace to fetch the secrets from</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.KubernetesServer">KubernetesServer
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>configures the Kubernetes server Address.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>CABundle is a base64-encoded CA certificate</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.NoSecretError">NoSecretError
- </h3>
- <p>
- <p>NoSecretError shall be returned when a GetSecret can not find the
- desired secret. This is used for deletionPolicy.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider</a>)
- </p>
- <p>
- <p>OnePasswordAuth contains a secretRef for credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OnePasswordAuthSecretRef">
- OnePasswordAuthSecretRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.OnePasswordAuthSecretRef">OnePasswordAuthSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth</a>)
- </p>
- <p>
- <p>OnePasswordAuthSecretRef holds secret references for 1Password credentials.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>connectTokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>The ConnectToken is used for authentication to a 1Password Connect Server.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>OnePasswordProvider configures a store to sync secrets using the 1Password Secret Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OnePasswordAuth">
- OnePasswordAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against OnePassword Connect Server</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>connectHost</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>ConnectHost defines the OnePassword Connect Server to connect to</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vaults</code></br>
- <em>
- map[string]int
- </em>
- </td>
- <td>
- <p>Vaults defines which OnePassword vaults to search in which order</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.OracleAuth">OracleAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>tenancy</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Tenancy is the tenancy OCID where user is located.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>user</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>User is an access OCID specific to the account.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OracleSecretRef">
- OracleSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>SecretRef to pass through sensitive information.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.OracleProvider">OracleProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>Configures an store to sync secrets using a Oracle Vault
- backend.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Region is the region where vault is located.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vault</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Vault is the vault’s OCID of the specific vault where secret is located.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OracleAuth">
- OracleAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Auth configures how secret-manager authenticates with the Oracle Vault.
- If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.OracleSecretRef">OracleSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.OracleAuth">OracleAuth</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>privatekey</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>PrivateKey is the user’s API Signing Key in PEM format, used for authentication.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>fingerprint</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Fingerprint is the fingerprint of the API private key.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.Provider">Provider
- </h3>
- <p>
- <p>Provider is a common interface for interacting with secret backends.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.PushRemoteRef">PushRemoteRef
- </h3>
- <p>
- <p>This interface is to allow using v1alpha1 content in Provider registered in v1beta1.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.ScalewayProvider">ScalewayProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiUrl</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>APIURL is the url of the api to use. Defaults to <a href="https://api.scaleway.com">https://api.scaleway.com</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>region</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>projectId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <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>
- </td>
- </tr>
- <tr>
- <td>
- <code>accessKey</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ScalewayProviderSecretRef">
- ScalewayProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>AccessKey is the non-secret part of the api key.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretKey</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ScalewayProviderSecretRef">
- ScalewayProviderSecretRef
- </a>
- </em>
- </td>
- <td>
- <p>SecretKey is the non-secret part of the api key.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ScalewayProviderSecretRef">ScalewayProviderSecretRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ScalewayProvider">ScalewayProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>value</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Value can be specified directly to set a value without using a secret.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>SecretRef references a key in a secret that will be used as value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStore">SecretStore
- </h3>
- <p>
- <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>metadata</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
- Kubernetes meta/v1.ObjectMeta
- </a>
- </em>
- </td>
- <td>
- Refer to the Kubernetes API documentation for the fields of the
- <code>metadata</code> field.
- </td>
- </tr>
- <tr>
- <td>
- <code>spec</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
- SecretStoreSpec
- </a>
- </em>
- </td>
- <td>
- <br/>
- <br/>
- <table>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select the correct KES controller (think: ingress.ingressClassName)
- The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
- SecretStoreProvider
- </a>
- </em>
- </td>
- <td>
- <p>Used to configure the provider. Only one provider may be set</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrySettings</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
- SecretStoreRetrySettings
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure http retries if failed</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
- []ClusterSecretStoreCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
- </td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
- SecretStoreStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreCapabilities">SecretStoreCapabilities
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
- </p>
- <p>
- <p>SecretStoreCapabilities defines the possible operations a SecretStore can do.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ReadOnly"</p></td>
- <td></td>
- </tr><tr><td><p>"ReadWrite"</p></td>
- <td></td>
- </tr><tr><td><p>"WriteOnly"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreConditionType">SecretStoreConditionType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Ready"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
- </p>
- <p>
- <p>SecretStoreProvider contains the provider-specific configuration.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>aws</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AWSProvider">
- AWSProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>azurekv</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AzureKVProvider">
- AzureKVProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>akeyless</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AkeylessProvider">
- AkeylessProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>vault</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultProvider">
- VaultProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Vault configures this store to sync secrets using Hashi provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>gcpsm</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GCPSMProvider">
- GCPSMProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>oracle</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OracleProvider">
- OracleProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>ibm</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.IBMProvider">
- IBMProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>yandexcertificatemanager</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">
- YandexCertificateManagerProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>YandexCertificateManager configures this store to sync secrets using Yandex Certificate Manager provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>yandexlockbox</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">
- YandexLockboxProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>gitlab</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GitlabProvider">
- GitlabProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Gitlab configures this store to sync secrets using Gitlab Variables provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>alibaba</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.AlibabaProvider">
- AlibabaProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>onepassword</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.OnePasswordProvider">
- OnePasswordProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>OnePassword configures this store to sync secrets using the 1Password Cloud provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>webhook</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.WebhookProvider">
- WebhookProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Webhook configures this store to sync secrets using a generic templated webhook</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetes</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.KubernetesProvider">
- KubernetesProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kubernetes configures this store to sync secrets using a Kubernetes cluster provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>fake</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.FakeProvider">
- FakeProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Fake configures a store with static key/value pairs</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>senhasegura</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">
- SenhaseguraProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Senhasegura configures this store to sync secrets using senhasegura provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>scaleway</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ScalewayProvider">
- ScalewayProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Scaleway</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>doppler</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.DopplerProvider">
- DopplerProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Doppler configures this store to sync secrets using the Doppler provider</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>keepersecurity</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.KeeperSecurityProvider">
- KeeperSecurityProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>KeeperSecurity configures this store to sync secrets using the KeeperSecurity provider</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreRef">SecretStoreRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>,
- <a href="#external-secrets.io/v1beta1.SourceRef">SourceRef</a>)
- </p>
- <p>
- <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name of the SecretStore resource</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kind</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
- Defaults to <code>SecretStore</code></p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreRetrySettings">SecretStoreRetrySettings
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>maxRetries</code></br>
- <em>
- int32
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>retryInterval</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
- <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
- </p>
- <p>
- <p>SecretStoreSpec defines the desired state of SecretStore.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>controller</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to select the correct KES controller (think: ingress.ingressClassName)
- The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>provider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
- SecretStoreProvider
- </a>
- </em>
- </td>
- <td>
- <p>Used to configure the provider. Only one provider may be set</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>retrySettings</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
- SecretStoreRetrySettings
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure http retries if failed</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>refreshInterval</code></br>
- <em>
- int
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
- []ClusterSecretStoreCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
- <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
- </p>
- <p>
- <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>conditions</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">
- []SecretStoreStatusCondition
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>capabilities</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreCapabilities">
- SecretStoreCapabilities
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreConditionType">
- SecretStoreConditionType
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>status</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
- Kubernetes core/v1.ConditionStatus
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>reason</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>message</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>lastTransitionTime</code></br>
- <em>
- <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
- Kubernetes meta/v1.Time
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SecretsClient">SecretsClient
- </h3>
- <p>
- <p>SecretsClient provides access to secrets.</p>
- </p>
- <h3 id="external-secrets.io/v1beta1.SenhaseguraAuth">SenhaseguraAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
- </p>
- <p>
- <p>SenhaseguraAuth tells the controller how to do auth in senhasegura.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>clientSecretSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SenhaseguraModuleType">SenhaseguraModuleType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
- </p>
- <p>
- <p>SenhaseguraModuleType enum defines senhasegura target module to fetch secrets</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"DSM"</p></td>
- <td><pre><code> SenhaseguraModuleDSM is the senhasegura DevOps Secrets Management module
- see: https://senhasegura.com/devops
- </code></pre>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>SenhaseguraProvider setup a store to sync secrets with senhasegura.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>URL of senhasegura</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>module</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SenhaseguraModuleType">
- SenhaseguraModuleType
- </a>
- </em>
- </td>
- <td>
- <p>Module defines which senhasegura module should be used to get secrets</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SenhaseguraAuth">
- SenhaseguraAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines parameters to authenticate in senhasegura</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>ignoreSslCertificate</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <p>IgnoreSslCertificate defines if SSL certificate must be ignored</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.SourceRef">SourceRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>,
- <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
- </p>
- <p>
- <p>SourceRef allows you to override the source
- from which the secret will be pulled from.
- You can define at maximum one property.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>storeRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.SecretStoreRef">
- SecretStoreRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>generatorRef</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.GeneratorRef">
- GeneratorRef
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>GeneratorRef points to a generator custom resource in</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TemplateEngineVersion">TemplateEngineVersion
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"v1"</p></td>
- <td></td>
- </tr><tr><td><p>"v2"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TemplateFrom">TemplateFrom
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>configMap</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateRef">
- TemplateRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>secret</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateRef">
- TemplateRef
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>target</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateTarget">
- TemplateTarget
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- <tr>
- <td>
- <code>literal</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TemplateRef">TemplateRef
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>items</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateRefItem">
- []TemplateRefItem
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.TemplateRef">TemplateRef</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- </td>
- </tr>
- <tr>
- <td>
- <code>templateAs</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.TemplateScope">
- TemplateScope
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TemplateScope">TemplateScope
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"KeysAndValues"</p></td>
- <td></td>
- </tr><tr><td><p>"Values"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TemplateTarget">TemplateTarget
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"Annotations"</p></td>
- <td></td>
- </tr><tr><td><p>"Data"</p></td>
- <td></td>
- </tr><tr><td><p>"Labels"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.TokenAuth">TokenAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>bearerToken</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.ValidationResult">ValidationResult
- (<code>byte</code> alias)</p></h3>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>2</p></td>
- <td><p>Error indicates that there is a misconfiguration.</p>
- </td>
- </tr><tr><td><p>0</p></td>
- <td><p>Ready indicates that the client is configured correctly
- and can be used.</p>
- </td>
- </tr><tr><td><p>1</p></td>
- <td><p>Unknown indicates that the client can be used
- but information is missing and it can not be validated.</p>
- </td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultAppRole">VaultAppRole
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
- with the role and secret stored in a Kubernetes Secret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the App Role authentication backend is mounted
- in Vault, e.g: “approle”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>roleId</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>RoleID configured in the App Role authentication backend when setting
- up the authentication backend in Vault.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Reference to a key in a Secret that contains the App Role secret used
- to authenticate with Vault.
- The <code>key</code> field must be specified and denotes which entry within the Secret
- resource is used as the app role secret.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultAuth">VaultAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
- </p>
- <p>
- <p>VaultAuth is the configuration used to authenticate with a Vault server.
- Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>jwt</code> or <code>cert</code>
- can be specified.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>tokenSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>appRole</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultAppRole">
- VaultAppRole
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>AppRole authenticates with Vault using the App Role auth mechanism,
- with the role and secret stored in a Kubernetes Secret resource.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetes</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultKubernetesAuth">
- VaultKubernetesAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Kubernetes authenticates with Vault by passing the ServiceAccount
- token stored in the named Secret resource to the Vault server.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>ldap</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultLdapAuth">
- VaultLdapAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Ldap authenticates with Vault by passing username/password pair using
- the LDAP authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>jwt</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultJwtAuth">
- VaultJwtAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Jwt authenticates with Vault by passing role and JWT token using the
- JWT/OIDC authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>cert</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultCertAuth">
- VaultCertAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
- Cert authentication method</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultCertAuth">VaultCertAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
- method, with the role name and token stored in a Kubernetes Secret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>clientCert</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ClientCert is a certificate to authenticate using the Cert Vault
- authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>SecretRef to a key in a Secret resource containing client private key to
- authenticate with Vault using the Cert authentication method</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
- method, with the role name and a token stored in a Kubernetes Secret resource or
- a Kubernetes service account token retrieved via <code>TokenRequest</code>.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the JWT authentication backend is mounted
- in Vault, e.g: “jwt”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
- authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
- authenticate with Vault using the JWT/OIDC authentication method.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>kubernetesServiceAccountToken</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">
- VaultKubernetesServiceAccountTokenAuth
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional ServiceAccountToken specifies the Kubernetes service account for which to request
- a token for with the <code>TokenRequest</code> API.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultKVStoreVersion">VaultKVStoreVersion
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"v1"</p></td>
- <td></td>
- </tr><tr><td><p>"v2"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultKubernetesAuth">VaultKubernetesAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
- a Secret.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>mountPath</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
- “kubernetes”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional service account field containing the name of a kubernetes ServiceAccount.
- If the service account is specified, the service account secret token JWT will be used
- for authenticating with Vault. If the service account selector is not supplied,
- the secretRef will be used instead.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
- for authenticating with Vault. If a name is specified without a key,
- <code>token</code> is the default. If one is not specified, the one bound to
- the controller will be used.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>role</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>A required field containing the Vault Role to assume. A Role binds a
- Kubernetes ServiceAccount with a set of Vault policies.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">VaultKubernetesServiceAccountTokenAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth</a>)
- </p>
- <p>
- <p>VaultKubernetesServiceAccountTokenAuth authenticates with Vault using a temporary
- Kubernetes service account token retrieved by the <code>TokenRequest</code> API.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>serviceAccountRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
- External Secrets meta/v1.ServiceAccountSelector
- </a>
- </em>
- </td>
- <td>
- <p>Service account field containing the name of a kubernetes ServiceAccount.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>audiences</code></br>
- <em>
- []string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional audiences field that will be used to request a temporary Kubernetes service
- account token for the service account referenced by <code>serviceAccountRef</code>.
- Defaults to a single audience <code>vault</code> it not specified.
- Deprecated: use serviceAccountRef.Audiences instead</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>expirationSeconds</code></br>
- <em>
- int64
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Optional expiration time in seconds that will be used to request a temporary
- Kubernetes service account token for the service account referenced by
- <code>serviceAccountRef</code>.
- Deprecated: this will be removed in the future.
- Defaults to 10 minutes.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultLdapAuth">VaultLdapAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
- </p>
- <p>
- <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
- with the username and password stored in a Kubernetes Secret resource.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Path where the LDAP authentication backend is mounted
- in Vault, e.g: “ldap”</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>username</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Username is a LDAP user name used to authenticate using the LDAP Vault
- authentication method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>SecretRef to a key in a Secret resource containing password for the LDAP
- user used to authenticate with Vault using the LDAP authentication
- method</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.VaultProvider">VaultProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>Configures an store to sync secrets using a HashiCorp Vault
- KV backend.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultAuth">
- VaultAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth configures how secret-manager authenticates with the Vault server.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>server</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Server is the connection address for the Vault server, e.g: “<a href="https://vault.example.com:8200"">https://vault.example.com:8200”</a>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>path</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Path is the mount path of the Vault KV backend endpoint, e.g:
- “secret”. The v2 KV secret engine version specific “/data” path suffix
- for fetching secrets from Vault is optional and will be appended
- if not present in specified path.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>version</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.VaultKVStoreVersion">
- VaultKVStoreVersion
- </a>
- </em>
- </td>
- <td>
- <p>Version is the Vault KV secret engine version. This can be either “v1” or
- “v2”. Version defaults to “v2”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
- Vault environments to support Secure Multi-tenancy. e.g: “ns1”.
- 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>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
- if the Server URL is using HTTPS protocol. This parameter is ignored for
- plain HTTP protocol connection. If not set the system root certificates
- are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.CAProvider">
- CAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>readYourWrites</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ReadYourWrites ensures isolated read-after-write semantics by
- providing discovered cluster replication states in each request.
- More information about eventual consistency in Vault can be found here
- <a href="https://www.vaultproject.io/docs/enterprise/consistency">https://www.vaultproject.io/docs/enterprise/consistency</a></p>
- </td>
- </tr>
- <tr>
- <td>
- <code>forwardInconsistent</code></br>
- <em>
- bool
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
- leader instead of simply retrying within a loop. This can increase performance if
- the option is enabled serverside.
- <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>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
- </p>
- <p>
- <p>Defines a location to fetch the cert for the webhook provider from.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>type</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.WebhookCAProviderType">
- WebhookCAProviderType
- </a>
- </em>
- </td>
- <td>
- <p>The type of provider to use such as “Secret”, or “ConfigMap”.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The name of the object located at the provider type.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>key</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>The key the value inside of the provider type to use, only used with “Secret” type</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>namespace</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The namespace the Provider type is in.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.WebhookCAProviderType">WebhookCAProviderType
- (<code>string</code> alias)</p></h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody><tr><td><p>"ConfigMap"</p></td>
- <td></td>
- </tr><tr><td><p>"Secret"</p></td>
- <td></td>
- </tr></tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.WebhookProvider">WebhookProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>method</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Webhook Method</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>url</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Webhook url to call</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>headers</code></br>
- <em>
- map[string]string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Headers</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>body</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Body</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>timeout</code></br>
- <em>
- <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
- Kubernetes meta/v1.Duration
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Timeout</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>result</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.WebhookResult">
- WebhookResult
- </a>
- </em>
- </td>
- <td>
- <p>Result formatting</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secrets</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.WebhookSecret">
- []WebhookSecret
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Secrets to fill in templates
- These secrets will be passed to the templating function as key value pairs under the given name</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caBundle</code></br>
- <em>
- []byte
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
- if the Server URL is using HTTPS protocol. This parameter is ignored for
- plain HTTP protocol connection. If not set the system root certificates
- are used to validate the TLS connection.</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.WebhookCAProvider">
- WebhookCAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.WebhookResult">WebhookResult
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>jsonPath</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Json path of return value</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.WebhookSecret">WebhookSecret
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>name</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <p>Name of this secret in templates</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>secretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <p>Secret ref to fill in credentials</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerAuth">YandexCertificateManagerAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>authorizedKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The authorized key used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">YandexCertificateManagerCAProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>certSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>YandexCertificateManagerProvider Configures a store to sync secrets using the Yandex Certificate Manager provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Yandex.Cloud API endpoint (e.g. ‘api.cloud.yandex.net:443’)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.YandexCertificateManagerAuth">
- YandexCertificateManagerAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against Yandex Certificate Manager</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">
- YandexCertificateManagerCAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.YandexLockboxAuth">YandexLockboxAuth
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>authorizedKeySecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The authorized key used for authentication</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.YandexLockboxCAProvider">YandexLockboxCAProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
- </p>
- <p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>certSecretRef</code></br>
- <em>
- <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
- External Secrets meta/v1.SecretKeySelector
- </a>
- </em>
- </td>
- <td>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider
- </h3>
- <p>
- (<em>Appears on:</em>
- <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
- </p>
- <p>
- <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
- </p>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>apiEndpoint</code></br>
- <em>
- string
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>Yandex.Cloud API endpoint (e.g. ‘api.cloud.yandex.net:443’)</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>auth</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.YandexLockboxAuth">
- YandexLockboxAuth
- </a>
- </em>
- </td>
- <td>
- <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
- </td>
- </tr>
- <tr>
- <td>
- <code>caProvider</code></br>
- <em>
- <a href="#external-secrets.io/v1beta1.YandexLockboxCAProvider">
- YandexLockboxCAProvider
- </a>
- </em>
- </td>
- <td>
- <em>(Optional)</em>
- <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <hr/>
- <p><em>
- Generated with <code>gen-crd-api-reference-docs</code>.
- </em></p>
-
- </article>
- </div>
- </div>
-
- </main>
-
- <footer class="md-footer">
-
- <nav class="md-footer__inner md-grid" aria-label="Footer">
-
-
- <a href="../generator/fake/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Fake" rel="prev">
- <div class="md-footer__button md-icon">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
- </div>
- <div class="md-footer__title">
- <div class="md-ellipsis">
- <span class="md-footer__direction">
- Previous
- </span>
- Fake
- </div>
- </div>
- </a>
-
-
-
- <a href="../controller-options/" class="md-footer__link md-footer__link--next" aria-label="Next: Controller Options" rel="next">
- <div class="md-footer__title">
- <div class="md-ellipsis">
- <span class="md-footer__direction">
- Next
- </span>
- Controller Options
- </div>
- </div>
- <div class="md-footer__button md-icon">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
- </div>
- </a>
-
- </nav>
-
- <div class="md-footer-meta md-typeset">
- <div class="md-footer-meta__inner md-grid">
- <div class="md-copyright">
-
- <div class="md-copyright__highlight">
- © 2023 The external-secrets Authors.<br/>
- © 2023 The Linux Foundation. All rights reserved.<br/><br/>
- The Linux Foundation has registered trademarks and uses trademarks.<br/>
- For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
- </div>
-
-
- Made with
- <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
- Material for MkDocs
- </a>
-
- </div>
-
- </div>
- </div>
- </footer>
-
- </div>
- <div class="md-dialog" data-md-component="dialog">
- <div class="md-dialog__inner md-typeset"></div>
- </div>
- <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
-
-
- <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
-
-
- </body>
- </html>
|
