index.html 130 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="icon" href="../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
  8. <title>API specification - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <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>
  15. <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&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. </div>
  24. <div data-md-component="announce">
  25. </div>
  26. <div data-md-component="outdated" hidden>
  27. <aside class="md-banner md-banner--warning">
  28. <div class="md-banner__inner md-grid md-typeset">
  29. You're not viewing the latest version.
  30. <a href="../..">
  31. <strong>Click here to go to latest.</strong>
  32. </a>
  33. </div>
  34. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  35. </aside>
  36. </div>
  37. <header class="md-header" data-md-component="header">
  38. <nav class="md-header__inner md-grid" aria-label="Header">
  39. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  40. <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>
  41. </a>
  42. <label class="md-header__button md-icon" for="__drawer">
  43. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  44. </label>
  45. <div class="md-header__title" data-md-component="header-title">
  46. <div class="md-header__ellipsis">
  47. <div class="md-header__topic">
  48. <span class="md-ellipsis">
  49. External Secrets Operator
  50. </span>
  51. </div>
  52. <div class="md-header__topic" data-md-component="header-topic">
  53. <span class="md-ellipsis">
  54. API specification
  55. </span>
  56. </div>
  57. </div>
  58. </div>
  59. <label class="md-header__button md-icon" for="__search">
  60. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  61. </label>
  62. <div class="md-search" data-md-component="search" role="dialog">
  63. <label class="md-search__overlay" for="__search"></label>
  64. <div class="md-search__inner" role="search">
  65. <form class="md-search__form" name="search">
  66. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  67. <label class="md-search__icon md-icon" for="__search">
  68. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  69. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  70. </label>
  71. <nav class="md-search__options" aria-label="Search">
  72. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  73. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  74. </button>
  75. </nav>
  76. </form>
  77. <div class="md-search__output">
  78. <div class="md-search__scrollwrap" data-md-scrollfix>
  79. <div class="md-search-result" data-md-component="search-result">
  80. <div class="md-search-result__meta">
  81. Initializing search
  82. </div>
  83. <ol class="md-search-result__list"></ol>
  84. </div>
  85. </div>
  86. </div>
  87. </div>
  88. </div>
  89. <div class="md-header__source">
  90. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  91. <div class="md-source__icon md-icon">
  92. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  93. </div>
  94. <div class="md-source__repository">
  95. External Secrets Operator
  96. </div>
  97. </a>
  98. </div>
  99. </nav>
  100. </header>
  101. <div class="md-container" data-md-component="container">
  102. <main class="md-main" data-md-component="main">
  103. <div class="md-main__inner md-grid">
  104. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  105. <div class="md-sidebar__scrollwrap">
  106. <div class="md-sidebar__inner">
  107. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  108. <label class="md-nav__title" for="__drawer">
  109. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  110. <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>
  111. </a>
  112. External Secrets Operator
  113. </label>
  114. <div class="md-nav__source">
  115. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  116. <div class="md-source__icon md-icon">
  117. <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>
  118. </div>
  119. <div class="md-source__repository">
  120. External Secrets Operator
  121. </div>
  122. </a>
  123. </div>
  124. <ul class="md-nav__list" data-md-scrollfix>
  125. <li class="md-nav__item">
  126. <a href=".." class="md-nav__link">
  127. Introduction
  128. </a>
  129. </li>
  130. <li class="md-nav__item">
  131. <a href="../api-overview/" class="md-nav__link">
  132. Overview
  133. </a>
  134. </li>
  135. <li class="md-nav__item md-nav__item--nested">
  136. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  137. <label class="md-nav__link" for="__nav_3">
  138. API Types
  139. <span class="md-nav__icon md-icon"></span>
  140. </label>
  141. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  142. <label class="md-nav__title" for="__nav_3">
  143. <span class="md-nav__icon md-icon"></span>
  144. API Types
  145. </label>
  146. <ul class="md-nav__list" data-md-scrollfix>
  147. <li class="md-nav__item">
  148. <a href="../api-externalsecret/" class="md-nav__link">
  149. ExternalSecret
  150. </a>
  151. </li>
  152. <li class="md-nav__item">
  153. <a href="../api-secretstore/" class="md-nav__link">
  154. SecretStore
  155. </a>
  156. </li>
  157. <li class="md-nav__item">
  158. <a href="../api-clustersecretstore/" class="md-nav__link">
  159. ClusterSecretStore
  160. </a>
  161. </li>
  162. <li class="md-nav__item">
  163. <a href="../api-clusterexternalsecret/" class="md-nav__link">
  164. ClusterExternalSecret
  165. </a>
  166. </li>
  167. </ul>
  168. </nav>
  169. </li>
  170. <li class="md-nav__item md-nav__item--nested">
  171. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  172. <label class="md-nav__link" for="__nav_4">
  173. Guides
  174. <span class="md-nav__icon md-icon"></span>
  175. </label>
  176. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  177. <label class="md-nav__title" for="__nav_4">
  178. <span class="md-nav__icon md-icon"></span>
  179. Guides
  180. </label>
  181. <ul class="md-nav__list" data-md-scrollfix>
  182. <li class="md-nav__item">
  183. <a href="../guides-introduction/" class="md-nav__link">
  184. Introduction
  185. </a>
  186. </li>
  187. <li class="md-nav__item">
  188. <a href="../guides-getting-started/" class="md-nav__link">
  189. Getting started
  190. </a>
  191. </li>
  192. <li class="md-nav__item md-nav__item--nested">
  193. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  194. <label class="md-nav__link" for="__nav_4_3">
  195. Advanced Templating
  196. <span class="md-nav__icon md-icon"></span>
  197. </label>
  198. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  199. <label class="md-nav__title" for="__nav_4_3">
  200. <span class="md-nav__icon md-icon"></span>
  201. Advanced Templating
  202. </label>
  203. <ul class="md-nav__list" data-md-scrollfix>
  204. <li class="md-nav__item">
  205. <a href="../guides-templating/" class="md-nav__link">
  206. v2
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../guides-templating-v1/" class="md-nav__link">
  211. v1
  212. </a>
  213. </li>
  214. </ul>
  215. </nav>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  219. All keys, One secret
  220. </a>
  221. </li>
  222. <li class="md-nav__item">
  223. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  224. Common K8S Secret Types
  225. </a>
  226. </li>
  227. <li class="md-nav__item">
  228. <a href="../guides-controller-class/" class="md-nav__link">
  229. Controller Classes
  230. </a>
  231. </li>
  232. <li class="md-nav__item">
  233. <a href="../guides-ownership-deletion-policy/" class="md-nav__link">
  234. Lifecycle: ownership & deletion
  235. </a>
  236. </li>
  237. <li class="md-nav__item">
  238. <a href="../guides-decoding-strategy/" class="md-nav__link">
  239. Decoding Strategies
  240. </a>
  241. </li>
  242. <li class="md-nav__item">
  243. <a href="../guides-getallsecrets/" class="md-nav__link">
  244. Getting Multiple Secrets
  245. </a>
  246. </li>
  247. <li class="md-nav__item">
  248. <a href="../guides-multi-tenancy/" class="md-nav__link">
  249. Multi Tenancy
  250. </a>
  251. </li>
  252. <li class="md-nav__item">
  253. <a href="../guides-metrics/" class="md-nav__link">
  254. Metrics
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="../guides-v1beta1/" class="md-nav__link">
  259. Upgrading to v1beta1
  260. </a>
  261. </li>
  262. <li class="md-nav__item">
  263. <a href="../guides-using-latest-image/" class="md-nav__link">
  264. Using Latest Image
  265. </a>
  266. </li>
  267. </ul>
  268. </nav>
  269. </li>
  270. <li class="md-nav__item md-nav__item--nested">
  271. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  272. <label class="md-nav__link" for="__nav_5">
  273. Provider
  274. <span class="md-nav__icon md-icon"></span>
  275. </label>
  276. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  277. <label class="md-nav__title" for="__nav_5">
  278. <span class="md-nav__icon md-icon"></span>
  279. Provider
  280. </label>
  281. <ul class="md-nav__list" data-md-scrollfix>
  282. <li class="md-nav__item md-nav__item--nested">
  283. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  284. <label class="md-nav__link" for="__nav_5_1">
  285. AWS
  286. <span class="md-nav__icon md-icon"></span>
  287. </label>
  288. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  289. <label class="md-nav__title" for="__nav_5_1">
  290. <span class="md-nav__icon md-icon"></span>
  291. AWS
  292. </label>
  293. <ul class="md-nav__list" data-md-scrollfix>
  294. <li class="md-nav__item">
  295. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  296. Secrets Manager
  297. </a>
  298. </li>
  299. <li class="md-nav__item">
  300. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  301. Parameter Store
  302. </a>
  303. </li>
  304. </ul>
  305. </nav>
  306. </li>
  307. <li class="md-nav__item md-nav__item--nested">
  308. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  309. <label class="md-nav__link" for="__nav_5_2">
  310. Azure
  311. <span class="md-nav__icon md-icon"></span>
  312. </label>
  313. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  314. <label class="md-nav__title" for="__nav_5_2">
  315. <span class="md-nav__icon md-icon"></span>
  316. Azure
  317. </label>
  318. <ul class="md-nav__list" data-md-scrollfix>
  319. <li class="md-nav__item">
  320. <a href="../provider-azure-key-vault/" class="md-nav__link">
  321. Key Vault
  322. </a>
  323. </li>
  324. </ul>
  325. </nav>
  326. </li>
  327. <li class="md-nav__item md-nav__item--nested">
  328. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  329. <label class="md-nav__link" for="__nav_5_3">
  330. Google
  331. <span class="md-nav__icon md-icon"></span>
  332. </label>
  333. <nav class="md-nav" aria-label="Google" data-md-level="2">
  334. <label class="md-nav__title" for="__nav_5_3">
  335. <span class="md-nav__icon md-icon"></span>
  336. Google
  337. </label>
  338. <ul class="md-nav__list" data-md-scrollfix>
  339. <li class="md-nav__item">
  340. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  341. Secret Manager
  342. </a>
  343. </li>
  344. </ul>
  345. </nav>
  346. </li>
  347. <li class="md-nav__item md-nav__item--nested">
  348. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  349. <label class="md-nav__link" for="__nav_5_4">
  350. IBM
  351. <span class="md-nav__icon md-icon"></span>
  352. </label>
  353. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  354. <label class="md-nav__title" for="__nav_5_4">
  355. <span class="md-nav__icon md-icon"></span>
  356. IBM
  357. </label>
  358. <ul class="md-nav__list" data-md-scrollfix>
  359. <li class="md-nav__item">
  360. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  361. Secrets Manager
  362. </a>
  363. </li>
  364. </ul>
  365. </nav>
  366. </li>
  367. <li class="md-nav__item">
  368. <a href="../provider-akeyless/" class="md-nav__link">
  369. Akeyless
  370. </a>
  371. </li>
  372. <li class="md-nav__item">
  373. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  374. HashiCorp Vault
  375. </a>
  376. </li>
  377. <li class="md-nav__item md-nav__item--nested">
  378. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  379. <label class="md-nav__link" for="__nav_5_7">
  380. Yandex
  381. <span class="md-nav__icon md-icon"></span>
  382. </label>
  383. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  384. <label class="md-nav__title" for="__nav_5_7">
  385. <span class="md-nav__icon md-icon"></span>
  386. Yandex
  387. </label>
  388. <ul class="md-nav__list" data-md-scrollfix>
  389. <li class="md-nav__item">
  390. <a href="../provider-yandex-certificate-manager/" class="md-nav__link">
  391. Certificate Manager
  392. </a>
  393. </li>
  394. <li class="md-nav__item">
  395. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  396. Lockbox
  397. </a>
  398. </li>
  399. </ul>
  400. </nav>
  401. </li>
  402. <li class="md-nav__item md-nav__item--nested">
  403. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  404. <label class="md-nav__link" for="__nav_5_8">
  405. Gitlab
  406. <span class="md-nav__icon md-icon"></span>
  407. </label>
  408. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  409. <label class="md-nav__title" for="__nav_5_8">
  410. <span class="md-nav__icon md-icon"></span>
  411. Gitlab
  412. </label>
  413. <ul class="md-nav__list" data-md-scrollfix>
  414. <li class="md-nav__item">
  415. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  416. Gitlab Project Variables
  417. </a>
  418. </li>
  419. </ul>
  420. </nav>
  421. </li>
  422. <li class="md-nav__item md-nav__item--nested">
  423. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  424. <label class="md-nav__link" for="__nav_5_9">
  425. Oracle
  426. <span class="md-nav__icon md-icon"></span>
  427. </label>
  428. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  429. <label class="md-nav__title" for="__nav_5_9">
  430. <span class="md-nav__icon md-icon"></span>
  431. Oracle
  432. </label>
  433. <ul class="md-nav__list" data-md-scrollfix>
  434. <li class="md-nav__item">
  435. <a href="../provider-oracle-vault/" class="md-nav__link">
  436. Oracle Vault
  437. </a>
  438. </li>
  439. </ul>
  440. </nav>
  441. </li>
  442. <li class="md-nav__item md-nav__item--nested">
  443. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  444. <label class="md-nav__link" for="__nav_5_10">
  445. 1Password
  446. <span class="md-nav__icon md-icon"></span>
  447. </label>
  448. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  449. <label class="md-nav__title" for="__nav_5_10">
  450. <span class="md-nav__icon md-icon"></span>
  451. 1Password
  452. </label>
  453. <ul class="md-nav__list" data-md-scrollfix>
  454. <li class="md-nav__item">
  455. <a href="../provider-1password-automation/" class="md-nav__link">
  456. Secrets Automation
  457. </a>
  458. </li>
  459. </ul>
  460. </nav>
  461. </li>
  462. <li class="md-nav__item">
  463. <a href="../provider-webhook/" class="md-nav__link">
  464. Webhook
  465. </a>
  466. </li>
  467. <li class="md-nav__item">
  468. <a href="../provider-fake/" class="md-nav__link">
  469. Fake
  470. </a>
  471. </li>
  472. <li class="md-nav__item">
  473. <a href="../provider-kubernetes/" class="md-nav__link">
  474. Kubernetes
  475. </a>
  476. </li>
  477. <li class="md-nav__item md-nav__item--nested">
  478. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  479. <label class="md-nav__link" for="__nav_5_14">
  480. senhasegura
  481. <span class="md-nav__icon md-icon"></span>
  482. </label>
  483. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  484. <label class="md-nav__title" for="__nav_5_14">
  485. <span class="md-nav__icon md-icon"></span>
  486. senhasegura
  487. </label>
  488. <ul class="md-nav__list" data-md-scrollfix>
  489. <li class="md-nav__item">
  490. <a href="../provider-senhasegura-dsm/" class="md-nav__link">
  491. DevOps Secrets Management (DSM)
  492. </a>
  493. </li>
  494. </ul>
  495. </nav>
  496. </li>
  497. </ul>
  498. </nav>
  499. </li>
  500. <li class="md-nav__item md-nav__item--nested">
  501. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  502. <label class="md-nav__link" for="__nav_6">
  503. Examples
  504. <span class="md-nav__icon md-icon"></span>
  505. </label>
  506. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  507. <label class="md-nav__title" for="__nav_6">
  508. <span class="md-nav__icon md-icon"></span>
  509. Examples
  510. </label>
  511. <ul class="md-nav__list" data-md-scrollfix>
  512. <li class="md-nav__item">
  513. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  514. FluxCD
  515. </a>
  516. </li>
  517. <li class="md-nav__item">
  518. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  519. Anchore Engine
  520. </a>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  524. Jenkins
  525. </a>
  526. </li>
  527. </ul>
  528. </nav>
  529. </li>
  530. <li class="md-nav__item md-nav__item--nested">
  531. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  532. <label class="md-nav__link" for="__nav_7">
  533. External Resources
  534. <span class="md-nav__icon md-icon"></span>
  535. </label>
  536. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  537. <label class="md-nav__title" for="__nav_7">
  538. <span class="md-nav__icon md-icon"></span>
  539. External Resources
  540. </label>
  541. <ul class="md-nav__list" data-md-scrollfix>
  542. <li class="md-nav__item">
  543. <a href="../eso-talks/" class="md-nav__link">
  544. Talks
  545. </a>
  546. </li>
  547. <li class="md-nav__item">
  548. <a href="../eso-demos/" class="md-nav__link">
  549. Demos
  550. </a>
  551. </li>
  552. <li class="md-nav__item">
  553. <a href="../eso-blogs/" class="md-nav__link">
  554. Blogs
  555. </a>
  556. </li>
  557. </ul>
  558. </nav>
  559. </li>
  560. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  561. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" checked>
  562. <label class="md-nav__link" for="__nav_8">
  563. References
  564. <span class="md-nav__icon md-icon"></span>
  565. </label>
  566. <nav class="md-nav" aria-label="References" data-md-level="1">
  567. <label class="md-nav__title" for="__nav_8">
  568. <span class="md-nav__icon md-icon"></span>
  569. References
  570. </label>
  571. <ul class="md-nav__list" data-md-scrollfix>
  572. <li class="md-nav__item md-nav__item--active">
  573. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  574. <a href="./" class="md-nav__link md-nav__link--active">
  575. API specification
  576. </a>
  577. </li>
  578. </ul>
  579. </nav>
  580. </li>
  581. <li class="md-nav__item md-nav__item--nested">
  582. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  583. <label class="md-nav__link" for="__nav_9">
  584. Contributing
  585. <span class="md-nav__icon md-icon"></span>
  586. </label>
  587. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  588. <label class="md-nav__title" for="__nav_9">
  589. <span class="md-nav__icon md-icon"></span>
  590. Contributing
  591. </label>
  592. <ul class="md-nav__list" data-md-scrollfix>
  593. <li class="md-nav__item">
  594. <a href="../contributing-devguide/" class="md-nav__link">
  595. Developer guide
  596. </a>
  597. </li>
  598. <li class="md-nav__item">
  599. <a href="../contributing-process/" class="md-nav__link">
  600. Contributing Process
  601. </a>
  602. </li>
  603. <li class="md-nav__item">
  604. <a href="../contributing-release/" class="md-nav__link">
  605. Release Process
  606. </a>
  607. </li>
  608. <li class="md-nav__item">
  609. <a href="../contributing-coc/" class="md-nav__link">
  610. Code of Conduct
  611. </a>
  612. </li>
  613. </ul>
  614. </nav>
  615. </li>
  616. <li class="md-nav__item">
  617. <a href="../roadmap/" class="md-nav__link">
  618. Roadmap
  619. </a>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../faq/" class="md-nav__link">
  623. FAQ
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../stability-support/" class="md-nav__link">
  628. Stability and Support
  629. </a>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="../deprecation-policy/" class="md-nav__link">
  633. Deprecation Policy
  634. </a>
  635. </li>
  636. </ul>
  637. </nav>
  638. </div>
  639. </div>
  640. </div>
  641. <div class="md-content" data-md-component="content">
  642. <article class="md-content__inner md-typeset">
  643. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/spec.md" title="Edit this page" class="md-content__button md-icon">
  644. <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>
  645. </a>
  646. <h1>API specification</h1>
  647. <p>Packages:</p>
  648. <ul>
  649. <li>
  650. <a href="#external-secrets.io%2fv1beta1">external-secrets.io/v1beta1</a>
  651. </li>
  652. </ul>
  653. <h2 id="external-secrets.io/v1beta1">external-secrets.io/v1beta1</h2>
  654. <p>
  655. <p>Package v1beta1 contains resources for external-secrets</p>
  656. </p>
  657. <p>Resource Types:</p>
  658. <ul></ul>
  659. <h3 id="external-secrets.io/v1beta1.AWSAuth">AWSAuth
  660. </h3>
  661. <p>
  662. (<em>Appears on:</em>
  663. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  664. </p>
  665. <p>
  666. <p>AWSAuth tells the controller how to do authentication with aws.
  667. Only one of secretRef or jwt can be specified.
  668. if none is specified the controller will load credentials using the aws sdk defaults.</p>
  669. </p>
  670. <table>
  671. <thead>
  672. <tr>
  673. <th>Field</th>
  674. <th>Description</th>
  675. </tr>
  676. </thead>
  677. <tbody>
  678. <tr>
  679. <td>
  680. <code>secretRef</code></br>
  681. <em>
  682. <a href="#external-secrets.io/v1beta1.AWSAuthSecretRef">
  683. AWSAuthSecretRef
  684. </a>
  685. </em>
  686. </td>
  687. <td>
  688. <em>(Optional)</em>
  689. </td>
  690. </tr>
  691. <tr>
  692. <td>
  693. <code>jwt</code></br>
  694. <em>
  695. <a href="#external-secrets.io/v1beta1.AWSJWTAuth">
  696. AWSJWTAuth
  697. </a>
  698. </em>
  699. </td>
  700. <td>
  701. <em>(Optional)</em>
  702. </td>
  703. </tr>
  704. </tbody>
  705. </table>
  706. <h3 id="external-secrets.io/v1beta1.AWSAuthSecretRef">AWSAuthSecretRef
  707. </h3>
  708. <p>
  709. (<em>Appears on:</em>
  710. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  711. </p>
  712. <p>
  713. <p>AWSAuthSecretRef holds secret references for AWS credentials
  714. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  715. </p>
  716. <table>
  717. <thead>
  718. <tr>
  719. <th>Field</th>
  720. <th>Description</th>
  721. </tr>
  722. </thead>
  723. <tbody>
  724. <tr>
  725. <td>
  726. <code>accessKeyIDSecretRef</code></br>
  727. <em>
  728. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  729. </em>
  730. </td>
  731. <td>
  732. <p>The AccessKeyID is used for authentication</p>
  733. </td>
  734. </tr>
  735. <tr>
  736. <td>
  737. <code>secretAccessKeySecretRef</code></br>
  738. <em>
  739. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  740. </em>
  741. </td>
  742. <td>
  743. <p>The SecretAccessKey is used for authentication</p>
  744. </td>
  745. </tr>
  746. </tbody>
  747. </table>
  748. <h3 id="external-secrets.io/v1beta1.AWSJWTAuth">AWSJWTAuth
  749. </h3>
  750. <p>
  751. (<em>Appears on:</em>
  752. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  753. </p>
  754. <p>
  755. <p>Authenticate against AWS using service account tokens.</p>
  756. </p>
  757. <table>
  758. <thead>
  759. <tr>
  760. <th>Field</th>
  761. <th>Description</th>
  762. </tr>
  763. </thead>
  764. <tbody>
  765. <tr>
  766. <td>
  767. <code>serviceAccountRef</code></br>
  768. <em>
  769. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  770. </em>
  771. </td>
  772. <td>
  773. </td>
  774. </tr>
  775. </tbody>
  776. </table>
  777. <h3 id="external-secrets.io/v1beta1.AWSProvider">AWSProvider
  778. </h3>
  779. <p>
  780. (<em>Appears on:</em>
  781. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  782. </p>
  783. <p>
  784. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  785. </p>
  786. <table>
  787. <thead>
  788. <tr>
  789. <th>Field</th>
  790. <th>Description</th>
  791. </tr>
  792. </thead>
  793. <tbody>
  794. <tr>
  795. <td>
  796. <code>service</code></br>
  797. <em>
  798. <a href="#external-secrets.io/v1beta1.AWSServiceType">
  799. AWSServiceType
  800. </a>
  801. </em>
  802. </td>
  803. <td>
  804. <p>Service defines which service should be used to fetch the secrets</p>
  805. </td>
  806. </tr>
  807. <tr>
  808. <td>
  809. <code>auth</code></br>
  810. <em>
  811. <a href="#external-secrets.io/v1beta1.AWSAuth">
  812. AWSAuth
  813. </a>
  814. </em>
  815. </td>
  816. <td>
  817. <em>(Optional)</em>
  818. <p>Auth defines the information necessary to authenticate against AWS
  819. if not set aws sdk will infer credentials from your environment
  820. 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>
  821. </td>
  822. </tr>
  823. <tr>
  824. <td>
  825. <code>role</code></br>
  826. <em>
  827. string
  828. </em>
  829. </td>
  830. <td>
  831. <em>(Optional)</em>
  832. <p>Role is a Role ARN which the SecretManager provider will assume</p>
  833. </td>
  834. </tr>
  835. <tr>
  836. <td>
  837. <code>region</code></br>
  838. <em>
  839. string
  840. </em>
  841. </td>
  842. <td>
  843. <p>AWS Region to be used for the provider</p>
  844. </td>
  845. </tr>
  846. </tbody>
  847. </table>
  848. <h3 id="external-secrets.io/v1beta1.AWSServiceType">AWSServiceType
  849. (<code>string</code> alias)</p></h3>
  850. <p>
  851. (<em>Appears on:</em>
  852. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  853. </p>
  854. <p>
  855. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  856. </p>
  857. <table>
  858. <thead>
  859. <tr>
  860. <th>Value</th>
  861. <th>Description</th>
  862. </tr>
  863. </thead>
  864. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  865. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore.
  866. 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>
  867. </td>
  868. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  869. <td><p>AWSServiceSecretsManager is the AWS SecretsManager.
  870. 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>
  871. </td>
  872. </tr></tbody>
  873. </table>
  874. <h3 id="external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth
  875. </h3>
  876. <p>
  877. (<em>Appears on:</em>
  878. <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>)
  879. </p>
  880. <p>
  881. </p>
  882. <table>
  883. <thead>
  884. <tr>
  885. <th>Field</th>
  886. <th>Description</th>
  887. </tr>
  888. </thead>
  889. <tbody>
  890. <tr>
  891. <td>
  892. <code>secretRef</code></br>
  893. <em>
  894. <a href="#external-secrets.io/v1beta1.AkeylessAuthSecretRef">
  895. AkeylessAuthSecretRef
  896. </a>
  897. </em>
  898. </td>
  899. <td>
  900. </td>
  901. </tr>
  902. </tbody>
  903. </table>
  904. <h3 id="external-secrets.io/v1beta1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
  905. </h3>
  906. <p>
  907. (<em>Appears on:</em>
  908. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  909. </p>
  910. <p>
  911. <p>AkeylessAuthSecretRef
  912. AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
  913. </p>
  914. <table>
  915. <thead>
  916. <tr>
  917. <th>Field</th>
  918. <th>Description</th>
  919. </tr>
  920. </thead>
  921. <tbody>
  922. <tr>
  923. <td>
  924. <code>accessID</code></br>
  925. <em>
  926. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  927. </em>
  928. </td>
  929. <td>
  930. <p>The SecretAccessID is used for authentication</p>
  931. </td>
  932. </tr>
  933. <tr>
  934. <td>
  935. <code>accessType</code></br>
  936. <em>
  937. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  938. </em>
  939. </td>
  940. <td>
  941. </td>
  942. </tr>
  943. <tr>
  944. <td>
  945. <code>accessTypeParam</code></br>
  946. <em>
  947. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  948. </em>
  949. </td>
  950. <td>
  951. </td>
  952. </tr>
  953. </tbody>
  954. </table>
  955. <h3 id="external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider
  956. </h3>
  957. <p>
  958. (<em>Appears on:</em>
  959. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  960. </p>
  961. <p>
  962. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  963. </p>
  964. <table>
  965. <thead>
  966. <tr>
  967. <th>Field</th>
  968. <th>Description</th>
  969. </tr>
  970. </thead>
  971. <tbody>
  972. <tr>
  973. <td>
  974. <code>akeylessGWApiURL</code></br>
  975. <em>
  976. string
  977. </em>
  978. </td>
  979. <td>
  980. <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
  981. </td>
  982. </tr>
  983. <tr>
  984. <td>
  985. <code>authSecretRef</code></br>
  986. <em>
  987. <a href="#external-secrets.io/v1beta1.AkeylessAuth">
  988. AkeylessAuth
  989. </a>
  990. </em>
  991. </td>
  992. <td>
  993. <p>Auth configures how the operator authenticates with Akeyless.</p>
  994. </td>
  995. </tr>
  996. </tbody>
  997. </table>
  998. <h3 id="external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth
  999. </h3>
  1000. <p>
  1001. (<em>Appears on:</em>
  1002. <a href="#external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider</a>)
  1003. </p>
  1004. <p>
  1005. <p>AlibabaAuth contains a secretRef for credentials.</p>
  1006. </p>
  1007. <table>
  1008. <thead>
  1009. <tr>
  1010. <th>Field</th>
  1011. <th>Description</th>
  1012. </tr>
  1013. </thead>
  1014. <tbody>
  1015. <tr>
  1016. <td>
  1017. <code>secretRef</code></br>
  1018. <em>
  1019. <a href="#external-secrets.io/v1beta1.AlibabaAuthSecretRef">
  1020. AlibabaAuthSecretRef
  1021. </a>
  1022. </em>
  1023. </td>
  1024. <td>
  1025. </td>
  1026. </tr>
  1027. </tbody>
  1028. </table>
  1029. <h3 id="external-secrets.io/v1beta1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
  1030. </h3>
  1031. <p>
  1032. (<em>Appears on:</em>
  1033. <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
  1034. </p>
  1035. <p>
  1036. <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
  1037. </p>
  1038. <table>
  1039. <thead>
  1040. <tr>
  1041. <th>Field</th>
  1042. <th>Description</th>
  1043. </tr>
  1044. </thead>
  1045. <tbody>
  1046. <tr>
  1047. <td>
  1048. <code>accessKeyIDSecretRef</code></br>
  1049. <em>
  1050. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1051. </em>
  1052. </td>
  1053. <td>
  1054. <p>The AccessKeyID is used for authentication</p>
  1055. </td>
  1056. </tr>
  1057. <tr>
  1058. <td>
  1059. <code>accessKeySecretSecretRef</code></br>
  1060. <em>
  1061. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1062. </em>
  1063. </td>
  1064. <td>
  1065. <p>The AccessKeySecret is used for authentication</p>
  1066. </td>
  1067. </tr>
  1068. </tbody>
  1069. </table>
  1070. <h3 id="external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider
  1071. </h3>
  1072. <p>
  1073. (<em>Appears on:</em>
  1074. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1075. </p>
  1076. <p>
  1077. <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
  1078. </p>
  1079. <table>
  1080. <thead>
  1081. <tr>
  1082. <th>Field</th>
  1083. <th>Description</th>
  1084. </tr>
  1085. </thead>
  1086. <tbody>
  1087. <tr>
  1088. <td>
  1089. <code>auth</code></br>
  1090. <em>
  1091. <a href="#external-secrets.io/v1beta1.AlibabaAuth">
  1092. AlibabaAuth
  1093. </a>
  1094. </em>
  1095. </td>
  1096. <td>
  1097. </td>
  1098. </tr>
  1099. <tr>
  1100. <td>
  1101. <code>endpoint</code></br>
  1102. <em>
  1103. string
  1104. </em>
  1105. </td>
  1106. <td>
  1107. <em>(Optional)</em>
  1108. </td>
  1109. </tr>
  1110. <tr>
  1111. <td>
  1112. <code>regionID</code></br>
  1113. <em>
  1114. string
  1115. </em>
  1116. </td>
  1117. <td>
  1118. <p>Alibaba Region to be used for the provider</p>
  1119. </td>
  1120. </tr>
  1121. </tbody>
  1122. </table>
  1123. <h3 id="external-secrets.io/v1beta1.AzureAuthType">AzureAuthType
  1124. (<code>string</code> alias)</p></h3>
  1125. <p>
  1126. (<em>Appears on:</em>
  1127. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1128. </p>
  1129. <p>
  1130. <p>AuthType describes how to authenticate to the Azure Keyvault
  1131. Only one of the following auth types may be specified.
  1132. If none of the following auth type is specified, the default one
  1133. is ServicePrincipal.</p>
  1134. </p>
  1135. <table>
  1136. <thead>
  1137. <tr>
  1138. <th>Value</th>
  1139. <th>Description</th>
  1140. </tr>
  1141. </thead>
  1142. <tbody><tr><td><p>&#34;ManagedIdentity&#34;</p></td>
  1143. <td><p>Using Managed Identity to authenticate. Used with aad-pod-identity installed in the clister.</p>
  1144. </td>
  1145. </tr><tr><td><p>&#34;ServicePrincipal&#34;</p></td>
  1146. <td><p>Using service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.</p>
  1147. </td>
  1148. </tr><tr><td><p>&#34;WorkloadIdentity&#34;</p></td>
  1149. <td><p>Using Workload Identity service accounts to authenticate.</p>
  1150. </td>
  1151. </tr></tbody>
  1152. </table>
  1153. <h3 id="external-secrets.io/v1beta1.AzureKVAuth">AzureKVAuth
  1154. </h3>
  1155. <p>
  1156. (<em>Appears on:</em>
  1157. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1158. </p>
  1159. <p>
  1160. <p>Configuration used to authenticate with Azure.</p>
  1161. </p>
  1162. <table>
  1163. <thead>
  1164. <tr>
  1165. <th>Field</th>
  1166. <th>Description</th>
  1167. </tr>
  1168. </thead>
  1169. <tbody>
  1170. <tr>
  1171. <td>
  1172. <code>clientId</code></br>
  1173. <em>
  1174. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1175. </em>
  1176. </td>
  1177. <td>
  1178. <em>(Optional)</em>
  1179. <p>The Azure clientId of the service principle used for authentication.</p>
  1180. </td>
  1181. </tr>
  1182. <tr>
  1183. <td>
  1184. <code>clientSecret</code></br>
  1185. <em>
  1186. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1187. </em>
  1188. </td>
  1189. <td>
  1190. <em>(Optional)</em>
  1191. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  1192. </td>
  1193. </tr>
  1194. </tbody>
  1195. </table>
  1196. <h3 id="external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider
  1197. </h3>
  1198. <p>
  1199. (<em>Appears on:</em>
  1200. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1201. </p>
  1202. <p>
  1203. <p>Configures an store to sync secrets using Azure KV.</p>
  1204. </p>
  1205. <table>
  1206. <thead>
  1207. <tr>
  1208. <th>Field</th>
  1209. <th>Description</th>
  1210. </tr>
  1211. </thead>
  1212. <tbody>
  1213. <tr>
  1214. <td>
  1215. <code>authType</code></br>
  1216. <em>
  1217. <a href="#external-secrets.io/v1beta1.AzureAuthType">
  1218. AzureAuthType
  1219. </a>
  1220. </em>
  1221. </td>
  1222. <td>
  1223. <em>(Optional)</em>
  1224. <p>Auth type defines how to authenticate to the keyvault service.
  1225. Valid values are:
  1226. - &ldquo;ServicePrincipal&rdquo; (default): Using a service principal (tenantId, clientId, clientSecret)
  1227. - &ldquo;ManagedIdentity&rdquo;: Using Managed Identity assigned to the pod (see aad-pod-identity)</p>
  1228. </td>
  1229. </tr>
  1230. <tr>
  1231. <td>
  1232. <code>vaultUrl</code></br>
  1233. <em>
  1234. string
  1235. </em>
  1236. </td>
  1237. <td>
  1238. <p>Vault Url from which the secrets to be fetched from.</p>
  1239. </td>
  1240. </tr>
  1241. <tr>
  1242. <td>
  1243. <code>tenantId</code></br>
  1244. <em>
  1245. string
  1246. </em>
  1247. </td>
  1248. <td>
  1249. <em>(Optional)</em>
  1250. <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type.</p>
  1251. </td>
  1252. </tr>
  1253. <tr>
  1254. <td>
  1255. <code>authSecretRef</code></br>
  1256. <em>
  1257. <a href="#external-secrets.io/v1beta1.AzureKVAuth">
  1258. AzureKVAuth
  1259. </a>
  1260. </em>
  1261. </td>
  1262. <td>
  1263. <em>(Optional)</em>
  1264. <p>Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type.</p>
  1265. </td>
  1266. </tr>
  1267. <tr>
  1268. <td>
  1269. <code>serviceAccountRef</code></br>
  1270. <em>
  1271. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  1272. </em>
  1273. </td>
  1274. <td>
  1275. <em>(Optional)</em>
  1276. <p>ServiceAccountRef specified the service account
  1277. that should be used when authenticating with WorkloadIdentity.</p>
  1278. </td>
  1279. </tr>
  1280. <tr>
  1281. <td>
  1282. <code>identityId</code></br>
  1283. <em>
  1284. string
  1285. </em>
  1286. </td>
  1287. <td>
  1288. <em>(Optional)</em>
  1289. <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
  1290. </td>
  1291. </tr>
  1292. </tbody>
  1293. </table>
  1294. <h3 id="external-secrets.io/v1beta1.CAProvider">CAProvider
  1295. </h3>
  1296. <p>
  1297. (<em>Appears on:</em>
  1298. <a href="#external-secrets.io/v1beta1.KubernetesServer">KubernetesServer</a>,
  1299. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  1300. </p>
  1301. <p>
  1302. <p>Defines a location to fetch the cert for the vault provider from.</p>
  1303. </p>
  1304. <table>
  1305. <thead>
  1306. <tr>
  1307. <th>Field</th>
  1308. <th>Description</th>
  1309. </tr>
  1310. </thead>
  1311. <tbody>
  1312. <tr>
  1313. <td>
  1314. <code>type</code></br>
  1315. <em>
  1316. <a href="#external-secrets.io/v1beta1.CAProviderType">
  1317. CAProviderType
  1318. </a>
  1319. </em>
  1320. </td>
  1321. <td>
  1322. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  1323. </td>
  1324. </tr>
  1325. <tr>
  1326. <td>
  1327. <code>name</code></br>
  1328. <em>
  1329. string
  1330. </em>
  1331. </td>
  1332. <td>
  1333. <p>The name of the object located at the provider type.</p>
  1334. </td>
  1335. </tr>
  1336. <tr>
  1337. <td>
  1338. <code>key</code></br>
  1339. <em>
  1340. string
  1341. </em>
  1342. </td>
  1343. <td>
  1344. <p>The key the value inside of the provider type to use, only used with &ldquo;Secret&rdquo; type</p>
  1345. </td>
  1346. </tr>
  1347. <tr>
  1348. <td>
  1349. <code>namespace</code></br>
  1350. <em>
  1351. string
  1352. </em>
  1353. </td>
  1354. <td>
  1355. <em>(Optional)</em>
  1356. <p>The namespace the Provider type is in.</p>
  1357. </td>
  1358. </tr>
  1359. </tbody>
  1360. </table>
  1361. <h3 id="external-secrets.io/v1beta1.CAProviderType">CAProviderType
  1362. (<code>string</code> alias)</p></h3>
  1363. <p>
  1364. (<em>Appears on:</em>
  1365. <a href="#external-secrets.io/v1beta1.CAProvider">CAProvider</a>)
  1366. </p>
  1367. <p>
  1368. </p>
  1369. <table>
  1370. <thead>
  1371. <tr>
  1372. <th>Value</th>
  1373. <th>Description</th>
  1374. </tr>
  1375. </thead>
  1376. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  1377. <td></td>
  1378. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  1379. <td></td>
  1380. </tr></tbody>
  1381. </table>
  1382. <h3 id="external-secrets.io/v1beta1.CertAuth">CertAuth
  1383. </h3>
  1384. <p>
  1385. (<em>Appears on:</em>
  1386. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  1387. </p>
  1388. <p>
  1389. </p>
  1390. <table>
  1391. <thead>
  1392. <tr>
  1393. <th>Field</th>
  1394. <th>Description</th>
  1395. </tr>
  1396. </thead>
  1397. <tbody>
  1398. <tr>
  1399. <td>
  1400. <code>clientCert</code></br>
  1401. <em>
  1402. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1403. </em>
  1404. </td>
  1405. <td>
  1406. </td>
  1407. </tr>
  1408. <tr>
  1409. <td>
  1410. <code>clientKey</code></br>
  1411. <em>
  1412. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1413. </em>
  1414. </td>
  1415. <td>
  1416. </td>
  1417. </tr>
  1418. </tbody>
  1419. </table>
  1420. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret
  1421. </h3>
  1422. <p>
  1423. <p>ClusterExternalSecret is the Schema for the clusterexternalsecrets API.</p>
  1424. </p>
  1425. <table>
  1426. <thead>
  1427. <tr>
  1428. <th>Field</th>
  1429. <th>Description</th>
  1430. </tr>
  1431. </thead>
  1432. <tbody>
  1433. <tr>
  1434. <td>
  1435. <code>metadata</code></br>
  1436. <em>
  1437. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1438. Kubernetes meta/v1.ObjectMeta
  1439. </a>
  1440. </em>
  1441. </td>
  1442. <td>
  1443. Refer to the Kubernetes API documentation for the fields of the
  1444. <code>metadata</code> field.
  1445. </td>
  1446. </tr>
  1447. <tr>
  1448. <td>
  1449. <code>spec</code></br>
  1450. <em>
  1451. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">
  1452. ClusterExternalSecretSpec
  1453. </a>
  1454. </em>
  1455. </td>
  1456. <td>
  1457. <br/>
  1458. <br/>
  1459. <table>
  1460. <tr>
  1461. <td>
  1462. <code>externalSecretSpec</code></br>
  1463. <em>
  1464. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  1465. ExternalSecretSpec
  1466. </a>
  1467. </em>
  1468. </td>
  1469. <td>
  1470. <p>The spec for the ExternalSecrets to be created</p>
  1471. </td>
  1472. </tr>
  1473. <tr>
  1474. <td>
  1475. <code>externalSecretName</code></br>
  1476. <em>
  1477. string
  1478. </em>
  1479. </td>
  1480. <td>
  1481. <em>(Optional)</em>
  1482. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  1483. </td>
  1484. </tr>
  1485. <tr>
  1486. <td>
  1487. <code>namespaceSelector</code></br>
  1488. <em>
  1489. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#labelselector-v1-meta">
  1490. Kubernetes meta/v1.LabelSelector
  1491. </a>
  1492. </em>
  1493. </td>
  1494. <td>
  1495. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
  1496. </td>
  1497. </tr>
  1498. <tr>
  1499. <td>
  1500. <code>refreshTime</code></br>
  1501. <em>
  1502. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1503. Kubernetes meta/v1.Duration
  1504. </a>
  1505. </em>
  1506. </td>
  1507. <td>
  1508. <p>The time in which the controller should reconcile it&rsquo;s objects and recheck namespaces for labels.</p>
  1509. </td>
  1510. </tr>
  1511. </table>
  1512. </td>
  1513. </tr>
  1514. <tr>
  1515. <td>
  1516. <code>status</code></br>
  1517. <em>
  1518. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">
  1519. ClusterExternalSecretStatus
  1520. </a>
  1521. </em>
  1522. </td>
  1523. <td>
  1524. </td>
  1525. </tr>
  1526. </tbody>
  1527. </table>
  1528. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretConditionType">ClusterExternalSecretConditionType
  1529. (<code>string</code> alias)</p></h3>
  1530. <p>
  1531. (<em>Appears on:</em>
  1532. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition</a>)
  1533. </p>
  1534. <p>
  1535. </p>
  1536. <table>
  1537. <thead>
  1538. <tr>
  1539. <th>Value</th>
  1540. <th>Description</th>
  1541. </tr>
  1542. </thead>
  1543. <tbody><tr><td><p>&#34;NotReady&#34;</p></td>
  1544. <td></td>
  1545. </tr><tr><td><p>&#34;PartiallyReady&#34;</p></td>
  1546. <td></td>
  1547. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  1548. <td></td>
  1549. </tr></tbody>
  1550. </table>
  1551. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">ClusterExternalSecretNamespaceFailure
  1552. </h3>
  1553. <p>
  1554. (<em>Appears on:</em>
  1555. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  1556. </p>
  1557. <p>
  1558. <p>ClusterExternalSecretNamespaceFailure represents a failed namespace deployment and it&rsquo;s reason.</p>
  1559. </p>
  1560. <table>
  1561. <thead>
  1562. <tr>
  1563. <th>Field</th>
  1564. <th>Description</th>
  1565. </tr>
  1566. </thead>
  1567. <tbody>
  1568. <tr>
  1569. <td>
  1570. <code>namespace</code></br>
  1571. <em>
  1572. string
  1573. </em>
  1574. </td>
  1575. <td>
  1576. <p>Namespace is the namespace that failed when trying to apply an ExternalSecret</p>
  1577. </td>
  1578. </tr>
  1579. <tr>
  1580. <td>
  1581. <code>reason</code></br>
  1582. <em>
  1583. string
  1584. </em>
  1585. </td>
  1586. <td>
  1587. <em>(Optional)</em>
  1588. <p>Reason is why the ExternalSecret failed to apply to the namespace</p>
  1589. </td>
  1590. </tr>
  1591. </tbody>
  1592. </table>
  1593. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec
  1594. </h3>
  1595. <p>
  1596. (<em>Appears on:</em>
  1597. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  1598. </p>
  1599. <p>
  1600. <p>ClusterExternalSecretSpec defines the desired state of ClusterExternalSecret.</p>
  1601. </p>
  1602. <table>
  1603. <thead>
  1604. <tr>
  1605. <th>Field</th>
  1606. <th>Description</th>
  1607. </tr>
  1608. </thead>
  1609. <tbody>
  1610. <tr>
  1611. <td>
  1612. <code>externalSecretSpec</code></br>
  1613. <em>
  1614. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  1615. ExternalSecretSpec
  1616. </a>
  1617. </em>
  1618. </td>
  1619. <td>
  1620. <p>The spec for the ExternalSecrets to be created</p>
  1621. </td>
  1622. </tr>
  1623. <tr>
  1624. <td>
  1625. <code>externalSecretName</code></br>
  1626. <em>
  1627. string
  1628. </em>
  1629. </td>
  1630. <td>
  1631. <em>(Optional)</em>
  1632. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  1633. </td>
  1634. </tr>
  1635. <tr>
  1636. <td>
  1637. <code>namespaceSelector</code></br>
  1638. <em>
  1639. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#labelselector-v1-meta">
  1640. Kubernetes meta/v1.LabelSelector
  1641. </a>
  1642. </em>
  1643. </td>
  1644. <td>
  1645. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
  1646. </td>
  1647. </tr>
  1648. <tr>
  1649. <td>
  1650. <code>refreshTime</code></br>
  1651. <em>
  1652. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1653. Kubernetes meta/v1.Duration
  1654. </a>
  1655. </em>
  1656. </td>
  1657. <td>
  1658. <p>The time in which the controller should reconcile it&rsquo;s objects and recheck namespaces for labels.</p>
  1659. </td>
  1660. </tr>
  1661. </tbody>
  1662. </table>
  1663. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus
  1664. </h3>
  1665. <p>
  1666. (<em>Appears on:</em>
  1667. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  1668. </p>
  1669. <p>
  1670. <p>ClusterExternalSecretStatus defines the observed state of ClusterExternalSecret.</p>
  1671. </p>
  1672. <table>
  1673. <thead>
  1674. <tr>
  1675. <th>Field</th>
  1676. <th>Description</th>
  1677. </tr>
  1678. </thead>
  1679. <tbody>
  1680. <tr>
  1681. <td>
  1682. <code>failedNamespaces</code></br>
  1683. <em>
  1684. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">
  1685. []ClusterExternalSecretNamespaceFailure
  1686. </a>
  1687. </em>
  1688. </td>
  1689. <td>
  1690. <em>(Optional)</em>
  1691. <p>Failed namespaces are the namespaces that failed to apply an ExternalSecret</p>
  1692. </td>
  1693. </tr>
  1694. <tr>
  1695. <td>
  1696. <code>provisionedNamespaces</code></br>
  1697. <em>
  1698. []string
  1699. </em>
  1700. </td>
  1701. <td>
  1702. <em>(Optional)</em>
  1703. <p>ProvisionedNamespaces are the namespaces where the ClusterExternalSecret has secrets</p>
  1704. </td>
  1705. </tr>
  1706. <tr>
  1707. <td>
  1708. <code>conditions</code></br>
  1709. <em>
  1710. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">
  1711. []ClusterExternalSecretStatusCondition
  1712. </a>
  1713. </em>
  1714. </td>
  1715. <td>
  1716. <em>(Optional)</em>
  1717. </td>
  1718. </tr>
  1719. </tbody>
  1720. </table>
  1721. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition
  1722. </h3>
  1723. <p>
  1724. (<em>Appears on:</em>
  1725. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  1726. </p>
  1727. <p>
  1728. </p>
  1729. <table>
  1730. <thead>
  1731. <tr>
  1732. <th>Field</th>
  1733. <th>Description</th>
  1734. </tr>
  1735. </thead>
  1736. <tbody>
  1737. <tr>
  1738. <td>
  1739. <code>type</code></br>
  1740. <em>
  1741. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretConditionType">
  1742. ClusterExternalSecretConditionType
  1743. </a>
  1744. </em>
  1745. </td>
  1746. <td>
  1747. </td>
  1748. </tr>
  1749. <tr>
  1750. <td>
  1751. <code>status</code></br>
  1752. <em>
  1753. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  1754. Kubernetes core/v1.ConditionStatus
  1755. </a>
  1756. </em>
  1757. </td>
  1758. <td>
  1759. </td>
  1760. </tr>
  1761. <tr>
  1762. <td>
  1763. <code>message</code></br>
  1764. <em>
  1765. string
  1766. </em>
  1767. </td>
  1768. <td>
  1769. <em>(Optional)</em>
  1770. </td>
  1771. </tr>
  1772. </tbody>
  1773. </table>
  1774. <h3 id="external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore
  1775. </h3>
  1776. <p>
  1777. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  1778. </p>
  1779. <table>
  1780. <thead>
  1781. <tr>
  1782. <th>Field</th>
  1783. <th>Description</th>
  1784. </tr>
  1785. </thead>
  1786. <tbody>
  1787. <tr>
  1788. <td>
  1789. <code>metadata</code></br>
  1790. <em>
  1791. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1792. Kubernetes meta/v1.ObjectMeta
  1793. </a>
  1794. </em>
  1795. </td>
  1796. <td>
  1797. Refer to the Kubernetes API documentation for the fields of the
  1798. <code>metadata</code> field.
  1799. </td>
  1800. </tr>
  1801. <tr>
  1802. <td>
  1803. <code>spec</code></br>
  1804. <em>
  1805. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  1806. SecretStoreSpec
  1807. </a>
  1808. </em>
  1809. </td>
  1810. <td>
  1811. <br/>
  1812. <br/>
  1813. <table>
  1814. <tr>
  1815. <td>
  1816. <code>controller</code></br>
  1817. <em>
  1818. string
  1819. </em>
  1820. </td>
  1821. <td>
  1822. <em>(Optional)</em>
  1823. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  1824. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  1825. </td>
  1826. </tr>
  1827. <tr>
  1828. <td>
  1829. <code>provider</code></br>
  1830. <em>
  1831. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  1832. SecretStoreProvider
  1833. </a>
  1834. </em>
  1835. </td>
  1836. <td>
  1837. <p>Used to configure the provider. Only one provider may be set</p>
  1838. </td>
  1839. </tr>
  1840. <tr>
  1841. <td>
  1842. <code>retrySettings</code></br>
  1843. <em>
  1844. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  1845. SecretStoreRetrySettings
  1846. </a>
  1847. </em>
  1848. </td>
  1849. <td>
  1850. <em>(Optional)</em>
  1851. <p>Used to configure http retries if failed</p>
  1852. </td>
  1853. </tr>
  1854. <tr>
  1855. <td>
  1856. <code>refreshInterval</code></br>
  1857. <em>
  1858. int
  1859. </em>
  1860. </td>
  1861. <td>
  1862. <em>(Optional)</em>
  1863. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  1864. </td>
  1865. </tr>
  1866. </table>
  1867. </td>
  1868. </tr>
  1869. <tr>
  1870. <td>
  1871. <code>status</code></br>
  1872. <em>
  1873. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  1874. SecretStoreStatus
  1875. </a>
  1876. </em>
  1877. </td>
  1878. <td>
  1879. </td>
  1880. </tr>
  1881. </tbody>
  1882. </table>
  1883. <h3 id="external-secrets.io/v1beta1.ExternalSecret">ExternalSecret
  1884. </h3>
  1885. <p>
  1886. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  1887. </p>
  1888. <table>
  1889. <thead>
  1890. <tr>
  1891. <th>Field</th>
  1892. <th>Description</th>
  1893. </tr>
  1894. </thead>
  1895. <tbody>
  1896. <tr>
  1897. <td>
  1898. <code>metadata</code></br>
  1899. <em>
  1900. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1901. Kubernetes meta/v1.ObjectMeta
  1902. </a>
  1903. </em>
  1904. </td>
  1905. <td>
  1906. Refer to the Kubernetes API documentation for the fields of the
  1907. <code>metadata</code> field.
  1908. </td>
  1909. </tr>
  1910. <tr>
  1911. <td>
  1912. <code>spec</code></br>
  1913. <em>
  1914. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  1915. ExternalSecretSpec
  1916. </a>
  1917. </em>
  1918. </td>
  1919. <td>
  1920. <br/>
  1921. <br/>
  1922. <table>
  1923. <tr>
  1924. <td>
  1925. <code>secretStoreRef</code></br>
  1926. <em>
  1927. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  1928. SecretStoreRef
  1929. </a>
  1930. </em>
  1931. </td>
  1932. <td>
  1933. </td>
  1934. </tr>
  1935. <tr>
  1936. <td>
  1937. <code>target</code></br>
  1938. <em>
  1939. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  1940. ExternalSecretTarget
  1941. </a>
  1942. </em>
  1943. </td>
  1944. <td>
  1945. <em>(Optional)</em>
  1946. </td>
  1947. </tr>
  1948. <tr>
  1949. <td>
  1950. <code>refreshInterval</code></br>
  1951. <em>
  1952. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1953. Kubernetes meta/v1.Duration
  1954. </a>
  1955. </em>
  1956. </td>
  1957. <td>
  1958. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  1959. Valid time units are &ldquo;ns&rdquo;, &ldquo;us&rdquo; (or &ldquo;µs&rdquo;), &ldquo;ms&rdquo;, &ldquo;s&rdquo;, &ldquo;m&rdquo;, &ldquo;h&rdquo;
  1960. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  1961. </td>
  1962. </tr>
  1963. <tr>
  1964. <td>
  1965. <code>data</code></br>
  1966. <em>
  1967. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  1968. []ExternalSecretData
  1969. </a>
  1970. </em>
  1971. </td>
  1972. <td>
  1973. <em>(Optional)</em>
  1974. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  1975. </td>
  1976. </tr>
  1977. <tr>
  1978. <td>
  1979. <code>dataFrom</code></br>
  1980. <em>
  1981. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  1982. []ExternalSecretDataFromRemoteRef
  1983. </a>
  1984. </em>
  1985. </td>
  1986. <td>
  1987. <em>(Optional)</em>
  1988. <p>DataFrom is used to fetch all properties from a specific Provider data
  1989. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  1990. </td>
  1991. </tr>
  1992. </table>
  1993. </td>
  1994. </tr>
  1995. <tr>
  1996. <td>
  1997. <code>status</code></br>
  1998. <em>
  1999. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">
  2000. ExternalSecretStatus
  2001. </a>
  2002. </em>
  2003. </td>
  2004. <td>
  2005. </td>
  2006. </tr>
  2007. </tbody>
  2008. </table>
  2009. <h3 id="external-secrets.io/v1beta1.ExternalSecretConditionType">ExternalSecretConditionType
  2010. (<code>string</code> alias)</p></h3>
  2011. <p>
  2012. (<em>Appears on:</em>
  2013. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  2014. </p>
  2015. <p>
  2016. </p>
  2017. <table>
  2018. <thead>
  2019. <tr>
  2020. <th>Value</th>
  2021. <th>Description</th>
  2022. </tr>
  2023. </thead>
  2024. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
  2025. <td></td>
  2026. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  2027. <td></td>
  2028. </tr></tbody>
  2029. </table>
  2030. <h3 id="external-secrets.io/v1beta1.ExternalSecretConversionStrategy">ExternalSecretConversionStrategy
  2031. (<code>string</code> alias)</p></h3>
  2032. <p>
  2033. (<em>Appears on:</em>
  2034. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  2035. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  2036. </p>
  2037. <p>
  2038. </p>
  2039. <table>
  2040. <thead>
  2041. <tr>
  2042. <th>Value</th>
  2043. <th>Description</th>
  2044. </tr>
  2045. </thead>
  2046. <tbody><tr><td><p>&#34;Default&#34;</p></td>
  2047. <td></td>
  2048. </tr><tr><td><p>&#34;Unicode&#34;</p></td>
  2049. <td></td>
  2050. </tr></tbody>
  2051. </table>
  2052. <h3 id="external-secrets.io/v1beta1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  2053. (<code>string</code> alias)</p></h3>
  2054. <p>
  2055. (<em>Appears on:</em>
  2056. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  2057. </p>
  2058. <p>
  2059. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  2060. </p>
  2061. <table>
  2062. <thead>
  2063. <tr>
  2064. <th>Value</th>
  2065. <th>Description</th>
  2066. </tr>
  2067. </thead>
  2068. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  2069. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  2070. </td>
  2071. </tr><tr><td><p>&#34;None&#34;</p></td>
  2072. <td><p>None does not create a Secret (future use with injector).</p>
  2073. </td>
  2074. </tr><tr><td><p>&#34;Orphan&#34;</p></td>
  2075. <td><p>Orphan creates the Secret and does not set the ownerReference.
  2076. I.e. it will be orphaned after the deletion of the ExternalSecret.</p>
  2077. </td>
  2078. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  2079. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  2080. </td>
  2081. </tr></tbody>
  2082. </table>
  2083. <h3 id="external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData
  2084. </h3>
  2085. <p>
  2086. (<em>Appears on:</em>
  2087. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2088. </p>
  2089. <p>
  2090. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  2091. </p>
  2092. <table>
  2093. <thead>
  2094. <tr>
  2095. <th>Field</th>
  2096. <th>Description</th>
  2097. </tr>
  2098. </thead>
  2099. <tbody>
  2100. <tr>
  2101. <td>
  2102. <code>secretKey</code></br>
  2103. <em>
  2104. string
  2105. </em>
  2106. </td>
  2107. <td>
  2108. </td>
  2109. </tr>
  2110. <tr>
  2111. <td>
  2112. <code>remoteRef</code></br>
  2113. <em>
  2114. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  2115. ExternalSecretDataRemoteRef
  2116. </a>
  2117. </em>
  2118. </td>
  2119. <td>
  2120. </td>
  2121. </tr>
  2122. </tbody>
  2123. </table>
  2124. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef
  2125. </h3>
  2126. <p>
  2127. (<em>Appears on:</em>
  2128. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2129. </p>
  2130. <p>
  2131. </p>
  2132. <table>
  2133. <thead>
  2134. <tr>
  2135. <th>Field</th>
  2136. <th>Description</th>
  2137. </tr>
  2138. </thead>
  2139. <tbody>
  2140. <tr>
  2141. <td>
  2142. <code>extract</code></br>
  2143. <em>
  2144. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  2145. ExternalSecretDataRemoteRef
  2146. </a>
  2147. </em>
  2148. </td>
  2149. <td>
  2150. <em>(Optional)</em>
  2151. <p>Used to extract multiple key/value pairs from one secret</p>
  2152. </td>
  2153. </tr>
  2154. <tr>
  2155. <td>
  2156. <code>find</code></br>
  2157. <em>
  2158. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">
  2159. ExternalSecretFind
  2160. </a>
  2161. </em>
  2162. </td>
  2163. <td>
  2164. <em>(Optional)</em>
  2165. <p>Used to find secrets based on tags or regular expressions</p>
  2166. </td>
  2167. </tr>
  2168. </tbody>
  2169. </table>
  2170. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  2171. </h3>
  2172. <p>
  2173. (<em>Appears on:</em>
  2174. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>,
  2175. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  2176. </p>
  2177. <p>
  2178. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  2179. </p>
  2180. <table>
  2181. <thead>
  2182. <tr>
  2183. <th>Field</th>
  2184. <th>Description</th>
  2185. </tr>
  2186. </thead>
  2187. <tbody>
  2188. <tr>
  2189. <td>
  2190. <code>key</code></br>
  2191. <em>
  2192. string
  2193. </em>
  2194. </td>
  2195. <td>
  2196. <p>Key is the key used in the Provider, mandatory</p>
  2197. </td>
  2198. </tr>
  2199. <tr>
  2200. <td>
  2201. <code>metadataPolicy</code></br>
  2202. <em>
  2203. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">
  2204. ExternalSecretMetadataPolicy
  2205. </a>
  2206. </em>
  2207. </td>
  2208. <td>
  2209. <em>(Optional)</em>
  2210. <p>Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None</p>
  2211. </td>
  2212. </tr>
  2213. <tr>
  2214. <td>
  2215. <code>property</code></br>
  2216. <em>
  2217. string
  2218. </em>
  2219. </td>
  2220. <td>
  2221. <em>(Optional)</em>
  2222. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  2223. </td>
  2224. </tr>
  2225. <tr>
  2226. <td>
  2227. <code>version</code></br>
  2228. <em>
  2229. string
  2230. </em>
  2231. </td>
  2232. <td>
  2233. <em>(Optional)</em>
  2234. <p>Used to select a specific version of the Provider value, if supported</p>
  2235. </td>
  2236. </tr>
  2237. <tr>
  2238. <td>
  2239. <code>conversionStrategy</code></br>
  2240. <em>
  2241. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  2242. ExternalSecretConversionStrategy
  2243. </a>
  2244. </em>
  2245. </td>
  2246. <td>
  2247. <em>(Optional)</em>
  2248. <p>Used to define a conversion Strategy</p>
  2249. </td>
  2250. </tr>
  2251. <tr>
  2252. <td>
  2253. <code>decodingStrategy</code></br>
  2254. <em>
  2255. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  2256. ExternalSecretDecodingStrategy
  2257. </a>
  2258. </em>
  2259. </td>
  2260. <td>
  2261. <em>(Optional)</em>
  2262. <p>Used to define a conversion Strategy</p>
  2263. </td>
  2264. </tr>
  2265. </tbody>
  2266. </table>
  2267. <h3 id="external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">ExternalSecretDecodingStrategy
  2268. (<code>string</code> alias)</p></h3>
  2269. <p>
  2270. (<em>Appears on:</em>
  2271. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  2272. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  2273. </p>
  2274. <p>
  2275. </p>
  2276. <table>
  2277. <thead>
  2278. <tr>
  2279. <th>Value</th>
  2280. <th>Description</th>
  2281. </tr>
  2282. </thead>
  2283. <tbody><tr><td><p>&#34;Auto&#34;</p></td>
  2284. <td></td>
  2285. </tr><tr><td><p>&#34;Base64&#34;</p></td>
  2286. <td></td>
  2287. </tr><tr><td><p>&#34;Base64URL&#34;</p></td>
  2288. <td></td>
  2289. </tr><tr><td><p>&#34;None&#34;</p></td>
  2290. <td></td>
  2291. </tr></tbody>
  2292. </table>
  2293. <h3 id="external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">ExternalSecretDeletionPolicy
  2294. (<code>string</code> alias)</p></h3>
  2295. <p>
  2296. (<em>Appears on:</em>
  2297. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  2298. </p>
  2299. <p>
  2300. <p>ExternalSecretDeletionPolicy defines rules on how to delete the resulting Secret.</p>
  2301. </p>
  2302. <table>
  2303. <thead>
  2304. <tr>
  2305. <th>Value</th>
  2306. <th>Description</th>
  2307. </tr>
  2308. </thead>
  2309. <tbody><tr><td><p>&#34;Delete&#34;</p></td>
  2310. <td><p>Delete deletes the secret if all provider secrets are deleted.
  2311. If a secret gets deleted on the provider side and is not accessible
  2312. anymore this is not considered an error and the ExternalSecret
  2313. does not go into SecretSyncedError status.</p>
  2314. </td>
  2315. </tr><tr><td><p>&#34;Merge&#34;</p></td>
  2316. <td><p>Merge removes keys in the secret, but not the secret itself.
  2317. If a secret gets deleted on the provider side and is not accessible
  2318. anymore this is not considered an error and the ExternalSecret
  2319. does not go into SecretSyncedError status.</p>
  2320. </td>
  2321. </tr><tr><td><p>&#34;Retain&#34;</p></td>
  2322. <td><p>Retain will retain the secret if all provider secrets have been deleted.
  2323. If a provider secret does not exist the ExternalSecret gets into the
  2324. SecretSyncedError status.</p>
  2325. </td>
  2326. </tr></tbody>
  2327. </table>
  2328. <h3 id="external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind
  2329. </h3>
  2330. <p>
  2331. (<em>Appears on:</em>
  2332. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  2333. </p>
  2334. <p>
  2335. </p>
  2336. <table>
  2337. <thead>
  2338. <tr>
  2339. <th>Field</th>
  2340. <th>Description</th>
  2341. </tr>
  2342. </thead>
  2343. <tbody>
  2344. <tr>
  2345. <td>
  2346. <code>path</code></br>
  2347. <em>
  2348. string
  2349. </em>
  2350. </td>
  2351. <td>
  2352. <em>(Optional)</em>
  2353. <p>A root path to start the find operations.</p>
  2354. </td>
  2355. </tr>
  2356. <tr>
  2357. <td>
  2358. <code>name</code></br>
  2359. <em>
  2360. <a href="#external-secrets.io/v1beta1.FindName">
  2361. FindName
  2362. </a>
  2363. </em>
  2364. </td>
  2365. <td>
  2366. <em>(Optional)</em>
  2367. <p>Finds secrets based on the name.</p>
  2368. </td>
  2369. </tr>
  2370. <tr>
  2371. <td>
  2372. <code>tags</code></br>
  2373. <em>
  2374. map[string]string
  2375. </em>
  2376. </td>
  2377. <td>
  2378. <em>(Optional)</em>
  2379. <p>Find secrets based on tags.</p>
  2380. </td>
  2381. </tr>
  2382. <tr>
  2383. <td>
  2384. <code>conversionStrategy</code></br>
  2385. <em>
  2386. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  2387. ExternalSecretConversionStrategy
  2388. </a>
  2389. </em>
  2390. </td>
  2391. <td>
  2392. <em>(Optional)</em>
  2393. <p>Used to define a conversion Strategy</p>
  2394. </td>
  2395. </tr>
  2396. <tr>
  2397. <td>
  2398. <code>decodingStrategy</code></br>
  2399. <em>
  2400. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  2401. ExternalSecretDecodingStrategy
  2402. </a>
  2403. </em>
  2404. </td>
  2405. <td>
  2406. <em>(Optional)</em>
  2407. <p>Used to define a conversion Strategy</p>
  2408. </td>
  2409. </tr>
  2410. </tbody>
  2411. </table>
  2412. <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">ExternalSecretMetadataPolicy
  2413. (<code>string</code> alias)</p></h3>
  2414. <p>
  2415. (<em>Appears on:</em>
  2416. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>)
  2417. </p>
  2418. <p>
  2419. </p>
  2420. <table>
  2421. <thead>
  2422. <tr>
  2423. <th>Value</th>
  2424. <th>Description</th>
  2425. </tr>
  2426. </thead>
  2427. <tbody><tr><td><p>&#34;Fetch&#34;</p></td>
  2428. <td></td>
  2429. </tr><tr><td><p>&#34;None&#34;</p></td>
  2430. <td></td>
  2431. </tr></tbody>
  2432. </table>
  2433. <h3 id="external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec
  2434. </h3>
  2435. <p>
  2436. (<em>Appears on:</em>
  2437. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>,
  2438. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  2439. </p>
  2440. <p>
  2441. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  2442. </p>
  2443. <table>
  2444. <thead>
  2445. <tr>
  2446. <th>Field</th>
  2447. <th>Description</th>
  2448. </tr>
  2449. </thead>
  2450. <tbody>
  2451. <tr>
  2452. <td>
  2453. <code>secretStoreRef</code></br>
  2454. <em>
  2455. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  2456. SecretStoreRef
  2457. </a>
  2458. </em>
  2459. </td>
  2460. <td>
  2461. </td>
  2462. </tr>
  2463. <tr>
  2464. <td>
  2465. <code>target</code></br>
  2466. <em>
  2467. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  2468. ExternalSecretTarget
  2469. </a>
  2470. </em>
  2471. </td>
  2472. <td>
  2473. <em>(Optional)</em>
  2474. </td>
  2475. </tr>
  2476. <tr>
  2477. <td>
  2478. <code>refreshInterval</code></br>
  2479. <em>
  2480. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  2481. Kubernetes meta/v1.Duration
  2482. </a>
  2483. </em>
  2484. </td>
  2485. <td>
  2486. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  2487. Valid time units are &ldquo;ns&rdquo;, &ldquo;us&rdquo; (or &ldquo;µs&rdquo;), &ldquo;ms&rdquo;, &ldquo;s&rdquo;, &ldquo;m&rdquo;, &ldquo;h&rdquo;
  2488. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  2489. </td>
  2490. </tr>
  2491. <tr>
  2492. <td>
  2493. <code>data</code></br>
  2494. <em>
  2495. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  2496. []ExternalSecretData
  2497. </a>
  2498. </em>
  2499. </td>
  2500. <td>
  2501. <em>(Optional)</em>
  2502. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  2503. </td>
  2504. </tr>
  2505. <tr>
  2506. <td>
  2507. <code>dataFrom</code></br>
  2508. <em>
  2509. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  2510. []ExternalSecretDataFromRemoteRef
  2511. </a>
  2512. </em>
  2513. </td>
  2514. <td>
  2515. <em>(Optional)</em>
  2516. <p>DataFrom is used to fetch all properties from a specific Provider data
  2517. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  2518. </td>
  2519. </tr>
  2520. </tbody>
  2521. </table>
  2522. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus
  2523. </h3>
  2524. <p>
  2525. (<em>Appears on:</em>
  2526. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  2527. </p>
  2528. <p>
  2529. </p>
  2530. <table>
  2531. <thead>
  2532. <tr>
  2533. <th>Field</th>
  2534. <th>Description</th>
  2535. </tr>
  2536. </thead>
  2537. <tbody>
  2538. <tr>
  2539. <td>
  2540. <code>refreshTime</code></br>
  2541. <em>
  2542. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  2543. Kubernetes meta/v1.Time
  2544. </a>
  2545. </em>
  2546. </td>
  2547. <td>
  2548. <p>refreshTime is the time and date the external secret was fetched and
  2549. the target secret updated</p>
  2550. </td>
  2551. </tr>
  2552. <tr>
  2553. <td>
  2554. <code>syncedResourceVersion</code></br>
  2555. <em>
  2556. string
  2557. </em>
  2558. </td>
  2559. <td>
  2560. <p>SyncedResourceVersion keeps track of the last synced version</p>
  2561. </td>
  2562. </tr>
  2563. <tr>
  2564. <td>
  2565. <code>conditions</code></br>
  2566. <em>
  2567. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">
  2568. []ExternalSecretStatusCondition
  2569. </a>
  2570. </em>
  2571. </td>
  2572. <td>
  2573. <em>(Optional)</em>
  2574. </td>
  2575. </tr>
  2576. </tbody>
  2577. </table>
  2578. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  2579. </h3>
  2580. <p>
  2581. (<em>Appears on:</em>
  2582. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus</a>)
  2583. </p>
  2584. <p>
  2585. </p>
  2586. <table>
  2587. <thead>
  2588. <tr>
  2589. <th>Field</th>
  2590. <th>Description</th>
  2591. </tr>
  2592. </thead>
  2593. <tbody>
  2594. <tr>
  2595. <td>
  2596. <code>type</code></br>
  2597. <em>
  2598. <a href="#external-secrets.io/v1beta1.ExternalSecretConditionType">
  2599. ExternalSecretConditionType
  2600. </a>
  2601. </em>
  2602. </td>
  2603. <td>
  2604. </td>
  2605. </tr>
  2606. <tr>
  2607. <td>
  2608. <code>status</code></br>
  2609. <em>
  2610. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  2611. Kubernetes core/v1.ConditionStatus
  2612. </a>
  2613. </em>
  2614. </td>
  2615. <td>
  2616. </td>
  2617. </tr>
  2618. <tr>
  2619. <td>
  2620. <code>reason</code></br>
  2621. <em>
  2622. string
  2623. </em>
  2624. </td>
  2625. <td>
  2626. <em>(Optional)</em>
  2627. </td>
  2628. </tr>
  2629. <tr>
  2630. <td>
  2631. <code>message</code></br>
  2632. <em>
  2633. string
  2634. </em>
  2635. </td>
  2636. <td>
  2637. <em>(Optional)</em>
  2638. </td>
  2639. </tr>
  2640. <tr>
  2641. <td>
  2642. <code>lastTransitionTime</code></br>
  2643. <em>
  2644. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  2645. Kubernetes meta/v1.Time
  2646. </a>
  2647. </em>
  2648. </td>
  2649. <td>
  2650. <em>(Optional)</em>
  2651. </td>
  2652. </tr>
  2653. </tbody>
  2654. </table>
  2655. <h3 id="external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget
  2656. </h3>
  2657. <p>
  2658. (<em>Appears on:</em>
  2659. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2660. </p>
  2661. <p>
  2662. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  2663. There can be only one target per ExternalSecret.</p>
  2664. </p>
  2665. <table>
  2666. <thead>
  2667. <tr>
  2668. <th>Field</th>
  2669. <th>Description</th>
  2670. </tr>
  2671. </thead>
  2672. <tbody>
  2673. <tr>
  2674. <td>
  2675. <code>name</code></br>
  2676. <em>
  2677. string
  2678. </em>
  2679. </td>
  2680. <td>
  2681. <em>(Optional)</em>
  2682. <p>Name defines the name of the Secret resource to be managed
  2683. This field is immutable
  2684. Defaults to the .metadata.name of the ExternalSecret resource</p>
  2685. </td>
  2686. </tr>
  2687. <tr>
  2688. <td>
  2689. <code>creationPolicy</code></br>
  2690. <em>
  2691. <a href="#external-secrets.io/v1beta1.ExternalSecretCreationPolicy">
  2692. ExternalSecretCreationPolicy
  2693. </a>
  2694. </em>
  2695. </td>
  2696. <td>
  2697. <em>(Optional)</em>
  2698. <p>CreationPolicy defines rules on how to create the resulting Secret
  2699. Defaults to &lsquo;Owner&rsquo;</p>
  2700. </td>
  2701. </tr>
  2702. <tr>
  2703. <td>
  2704. <code>deletionPolicy</code></br>
  2705. <em>
  2706. <a href="#external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">
  2707. ExternalSecretDeletionPolicy
  2708. </a>
  2709. </em>
  2710. </td>
  2711. <td>
  2712. <em>(Optional)</em>
  2713. <p>DeletionPolicy defines rules on how to delete the resulting Secret
  2714. Defaults to &lsquo;Retain&rsquo;</p>
  2715. </td>
  2716. </tr>
  2717. <tr>
  2718. <td>
  2719. <code>template</code></br>
  2720. <em>
  2721. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">
  2722. ExternalSecretTemplate
  2723. </a>
  2724. </em>
  2725. </td>
  2726. <td>
  2727. <em>(Optional)</em>
  2728. <p>Template defines a blueprint for the created Secret resource.</p>
  2729. </td>
  2730. </tr>
  2731. <tr>
  2732. <td>
  2733. <code>immutable</code></br>
  2734. <em>
  2735. bool
  2736. </em>
  2737. </td>
  2738. <td>
  2739. <em>(Optional)</em>
  2740. <p>Immutable defines if the final secret will be immutable</p>
  2741. </td>
  2742. </tr>
  2743. </tbody>
  2744. </table>
  2745. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate
  2746. </h3>
  2747. <p>
  2748. (<em>Appears on:</em>
  2749. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  2750. </p>
  2751. <p>
  2752. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  2753. 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>
  2754. </p>
  2755. <table>
  2756. <thead>
  2757. <tr>
  2758. <th>Field</th>
  2759. <th>Description</th>
  2760. </tr>
  2761. </thead>
  2762. <tbody>
  2763. <tr>
  2764. <td>
  2765. <code>type</code></br>
  2766. <em>
  2767. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secrettype-v1-core">
  2768. Kubernetes core/v1.SecretType
  2769. </a>
  2770. </em>
  2771. </td>
  2772. <td>
  2773. <em>(Optional)</em>
  2774. </td>
  2775. </tr>
  2776. <tr>
  2777. <td>
  2778. <code>engineVersion</code></br>
  2779. <em>
  2780. <a href="#external-secrets.io/v1beta1.TemplateEngineVersion">
  2781. TemplateEngineVersion
  2782. </a>
  2783. </em>
  2784. </td>
  2785. <td>
  2786. </td>
  2787. </tr>
  2788. <tr>
  2789. <td>
  2790. <code>metadata</code></br>
  2791. <em>
  2792. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">
  2793. ExternalSecretTemplateMetadata
  2794. </a>
  2795. </em>
  2796. </td>
  2797. <td>
  2798. <em>(Optional)</em>
  2799. </td>
  2800. </tr>
  2801. <tr>
  2802. <td>
  2803. <code>data</code></br>
  2804. <em>
  2805. map[string]string
  2806. </em>
  2807. </td>
  2808. <td>
  2809. <em>(Optional)</em>
  2810. </td>
  2811. </tr>
  2812. <tr>
  2813. <td>
  2814. <code>templateFrom</code></br>
  2815. <em>
  2816. <a href="#external-secrets.io/v1beta1.TemplateFrom">
  2817. []TemplateFrom
  2818. </a>
  2819. </em>
  2820. </td>
  2821. <td>
  2822. <em>(Optional)</em>
  2823. </td>
  2824. </tr>
  2825. </tbody>
  2826. </table>
  2827. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  2828. </h3>
  2829. <p>
  2830. (<em>Appears on:</em>
  2831. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  2832. </p>
  2833. <p>
  2834. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  2835. </p>
  2836. <table>
  2837. <thead>
  2838. <tr>
  2839. <th>Field</th>
  2840. <th>Description</th>
  2841. </tr>
  2842. </thead>
  2843. <tbody>
  2844. <tr>
  2845. <td>
  2846. <code>annotations</code></br>
  2847. <em>
  2848. map[string]string
  2849. </em>
  2850. </td>
  2851. <td>
  2852. <em>(Optional)</em>
  2853. </td>
  2854. </tr>
  2855. <tr>
  2856. <td>
  2857. <code>labels</code></br>
  2858. <em>
  2859. map[string]string
  2860. </em>
  2861. </td>
  2862. <td>
  2863. <em>(Optional)</em>
  2864. </td>
  2865. </tr>
  2866. </tbody>
  2867. </table>
  2868. <h3 id="external-secrets.io/v1beta1.ExternalSecretValidator">ExternalSecretValidator
  2869. </h3>
  2870. <p>
  2871. </p>
  2872. <h3 id="external-secrets.io/v1beta1.FakeProvider">FakeProvider
  2873. </h3>
  2874. <p>
  2875. (<em>Appears on:</em>
  2876. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2877. </p>
  2878. <p>
  2879. <p>FakeProvider configures a fake provider that returns static values.</p>
  2880. </p>
  2881. <table>
  2882. <thead>
  2883. <tr>
  2884. <th>Field</th>
  2885. <th>Description</th>
  2886. </tr>
  2887. </thead>
  2888. <tbody>
  2889. <tr>
  2890. <td>
  2891. <code>data</code></br>
  2892. <em>
  2893. <a href="#external-secrets.io/v1beta1.FakeProviderData">
  2894. []FakeProviderData
  2895. </a>
  2896. </em>
  2897. </td>
  2898. <td>
  2899. </td>
  2900. </tr>
  2901. </tbody>
  2902. </table>
  2903. <h3 id="external-secrets.io/v1beta1.FakeProviderData">FakeProviderData
  2904. </h3>
  2905. <p>
  2906. (<em>Appears on:</em>
  2907. <a href="#external-secrets.io/v1beta1.FakeProvider">FakeProvider</a>)
  2908. </p>
  2909. <p>
  2910. </p>
  2911. <table>
  2912. <thead>
  2913. <tr>
  2914. <th>Field</th>
  2915. <th>Description</th>
  2916. </tr>
  2917. </thead>
  2918. <tbody>
  2919. <tr>
  2920. <td>
  2921. <code>key</code></br>
  2922. <em>
  2923. string
  2924. </em>
  2925. </td>
  2926. <td>
  2927. </td>
  2928. </tr>
  2929. <tr>
  2930. <td>
  2931. <code>value</code></br>
  2932. <em>
  2933. string
  2934. </em>
  2935. </td>
  2936. <td>
  2937. </td>
  2938. </tr>
  2939. <tr>
  2940. <td>
  2941. <code>valueMap</code></br>
  2942. <em>
  2943. map[string]string
  2944. </em>
  2945. </td>
  2946. <td>
  2947. </td>
  2948. </tr>
  2949. <tr>
  2950. <td>
  2951. <code>version</code></br>
  2952. <em>
  2953. string
  2954. </em>
  2955. </td>
  2956. <td>
  2957. </td>
  2958. </tr>
  2959. </tbody>
  2960. </table>
  2961. <h3 id="external-secrets.io/v1beta1.FindName">FindName
  2962. </h3>
  2963. <p>
  2964. (<em>Appears on:</em>
  2965. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  2966. </p>
  2967. <p>
  2968. </p>
  2969. <table>
  2970. <thead>
  2971. <tr>
  2972. <th>Field</th>
  2973. <th>Description</th>
  2974. </tr>
  2975. </thead>
  2976. <tbody>
  2977. <tr>
  2978. <td>
  2979. <code>regexp</code></br>
  2980. <em>
  2981. string
  2982. </em>
  2983. </td>
  2984. <td>
  2985. <em>(Optional)</em>
  2986. <p>Finds secrets base</p>
  2987. </td>
  2988. </tr>
  2989. </tbody>
  2990. </table>
  2991. <h3 id="external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth
  2992. </h3>
  2993. <p>
  2994. (<em>Appears on:</em>
  2995. <a href="#external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider</a>)
  2996. </p>
  2997. <p>
  2998. </p>
  2999. <table>
  3000. <thead>
  3001. <tr>
  3002. <th>Field</th>
  3003. <th>Description</th>
  3004. </tr>
  3005. </thead>
  3006. <tbody>
  3007. <tr>
  3008. <td>
  3009. <code>secretRef</code></br>
  3010. <em>
  3011. <a href="#external-secrets.io/v1beta1.GCPSMAuthSecretRef">
  3012. GCPSMAuthSecretRef
  3013. </a>
  3014. </em>
  3015. </td>
  3016. <td>
  3017. <em>(Optional)</em>
  3018. </td>
  3019. </tr>
  3020. <tr>
  3021. <td>
  3022. <code>workloadIdentity</code></br>
  3023. <em>
  3024. <a href="#external-secrets.io/v1beta1.GCPWorkloadIdentity">
  3025. GCPWorkloadIdentity
  3026. </a>
  3027. </em>
  3028. </td>
  3029. <td>
  3030. <em>(Optional)</em>
  3031. </td>
  3032. </tr>
  3033. </tbody>
  3034. </table>
  3035. <h3 id="external-secrets.io/v1beta1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  3036. </h3>
  3037. <p>
  3038. (<em>Appears on:</em>
  3039. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  3040. </p>
  3041. <p>
  3042. </p>
  3043. <table>
  3044. <thead>
  3045. <tr>
  3046. <th>Field</th>
  3047. <th>Description</th>
  3048. </tr>
  3049. </thead>
  3050. <tbody>
  3051. <tr>
  3052. <td>
  3053. <code>secretAccessKeySecretRef</code></br>
  3054. <em>
  3055. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3056. </em>
  3057. </td>
  3058. <td>
  3059. <em>(Optional)</em>
  3060. <p>The SecretAccessKey is used for authentication</p>
  3061. </td>
  3062. </tr>
  3063. </tbody>
  3064. </table>
  3065. <h3 id="external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider
  3066. </h3>
  3067. <p>
  3068. (<em>Appears on:</em>
  3069. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3070. </p>
  3071. <p>
  3072. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  3073. </p>
  3074. <table>
  3075. <thead>
  3076. <tr>
  3077. <th>Field</th>
  3078. <th>Description</th>
  3079. </tr>
  3080. </thead>
  3081. <tbody>
  3082. <tr>
  3083. <td>
  3084. <code>auth</code></br>
  3085. <em>
  3086. <a href="#external-secrets.io/v1beta1.GCPSMAuth">
  3087. GCPSMAuth
  3088. </a>
  3089. </em>
  3090. </td>
  3091. <td>
  3092. <em>(Optional)</em>
  3093. <p>Auth defines the information necessary to authenticate against GCP</p>
  3094. </td>
  3095. </tr>
  3096. <tr>
  3097. <td>
  3098. <code>projectID</code></br>
  3099. <em>
  3100. string
  3101. </em>
  3102. </td>
  3103. <td>
  3104. <p>ProjectID project where secret is located</p>
  3105. </td>
  3106. </tr>
  3107. </tbody>
  3108. </table>
  3109. <h3 id="external-secrets.io/v1beta1.GCPWorkloadIdentity">GCPWorkloadIdentity
  3110. </h3>
  3111. <p>
  3112. (<em>Appears on:</em>
  3113. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  3114. </p>
  3115. <p>
  3116. </p>
  3117. <table>
  3118. <thead>
  3119. <tr>
  3120. <th>Field</th>
  3121. <th>Description</th>
  3122. </tr>
  3123. </thead>
  3124. <tbody>
  3125. <tr>
  3126. <td>
  3127. <code>serviceAccountRef</code></br>
  3128. <em>
  3129. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  3130. </em>
  3131. </td>
  3132. <td>
  3133. </td>
  3134. </tr>
  3135. <tr>
  3136. <td>
  3137. <code>clusterLocation</code></br>
  3138. <em>
  3139. string
  3140. </em>
  3141. </td>
  3142. <td>
  3143. </td>
  3144. </tr>
  3145. <tr>
  3146. <td>
  3147. <code>clusterName</code></br>
  3148. <em>
  3149. string
  3150. </em>
  3151. </td>
  3152. <td>
  3153. </td>
  3154. </tr>
  3155. <tr>
  3156. <td>
  3157. <code>clusterProjectID</code></br>
  3158. <em>
  3159. string
  3160. </em>
  3161. </td>
  3162. <td>
  3163. </td>
  3164. </tr>
  3165. </tbody>
  3166. </table>
  3167. <h3 id="external-secrets.io/v1beta1.GenericStore">GenericStore
  3168. </h3>
  3169. <p>
  3170. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  3171. or a namespaced SecretStore.</p>
  3172. </p>
  3173. <h3 id="external-secrets.io/v1beta1.GenericStoreValidator">GenericStoreValidator
  3174. </h3>
  3175. <p>
  3176. </p>
  3177. <h3 id="external-secrets.io/v1beta1.GitlabAuth">GitlabAuth
  3178. </h3>
  3179. <p>
  3180. (<em>Appears on:</em>
  3181. <a href="#external-secrets.io/v1beta1.GitlabProvider">GitlabProvider</a>)
  3182. </p>
  3183. <p>
  3184. </p>
  3185. <table>
  3186. <thead>
  3187. <tr>
  3188. <th>Field</th>
  3189. <th>Description</th>
  3190. </tr>
  3191. </thead>
  3192. <tbody>
  3193. <tr>
  3194. <td>
  3195. <code>SecretRef</code></br>
  3196. <em>
  3197. <a href="#external-secrets.io/v1beta1.GitlabSecretRef">
  3198. GitlabSecretRef
  3199. </a>
  3200. </em>
  3201. </td>
  3202. <td>
  3203. </td>
  3204. </tr>
  3205. </tbody>
  3206. </table>
  3207. <h3 id="external-secrets.io/v1beta1.GitlabProvider">GitlabProvider
  3208. </h3>
  3209. <p>
  3210. (<em>Appears on:</em>
  3211. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3212. </p>
  3213. <p>
  3214. <p>Configures a store to sync secrets with a GitLab instance.</p>
  3215. </p>
  3216. <table>
  3217. <thead>
  3218. <tr>
  3219. <th>Field</th>
  3220. <th>Description</th>
  3221. </tr>
  3222. </thead>
  3223. <tbody>
  3224. <tr>
  3225. <td>
  3226. <code>url</code></br>
  3227. <em>
  3228. string
  3229. </em>
  3230. </td>
  3231. <td>
  3232. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
  3233. </td>
  3234. </tr>
  3235. <tr>
  3236. <td>
  3237. <code>auth</code></br>
  3238. <em>
  3239. <a href="#external-secrets.io/v1beta1.GitlabAuth">
  3240. GitlabAuth
  3241. </a>
  3242. </em>
  3243. </td>
  3244. <td>
  3245. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
  3246. </td>
  3247. </tr>
  3248. <tr>
  3249. <td>
  3250. <code>projectID</code></br>
  3251. <em>
  3252. string
  3253. </em>
  3254. </td>
  3255. <td>
  3256. <p>ProjectID specifies a project where secrets are located.</p>
  3257. </td>
  3258. </tr>
  3259. </tbody>
  3260. </table>
  3261. <h3 id="external-secrets.io/v1beta1.GitlabSecretRef">GitlabSecretRef
  3262. </h3>
  3263. <p>
  3264. (<em>Appears on:</em>
  3265. <a href="#external-secrets.io/v1beta1.GitlabAuth">GitlabAuth</a>)
  3266. </p>
  3267. <p>
  3268. </p>
  3269. <table>
  3270. <thead>
  3271. <tr>
  3272. <th>Field</th>
  3273. <th>Description</th>
  3274. </tr>
  3275. </thead>
  3276. <tbody>
  3277. <tr>
  3278. <td>
  3279. <code>accessToken</code></br>
  3280. <em>
  3281. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3282. </em>
  3283. </td>
  3284. <td>
  3285. <p>AccessToken is used for authentication.</p>
  3286. </td>
  3287. </tr>
  3288. </tbody>
  3289. </table>
  3290. <h3 id="external-secrets.io/v1beta1.IBMAuth">IBMAuth
  3291. </h3>
  3292. <p>
  3293. (<em>Appears on:</em>
  3294. <a href="#external-secrets.io/v1beta1.IBMProvider">IBMProvider</a>)
  3295. </p>
  3296. <p>
  3297. </p>
  3298. <table>
  3299. <thead>
  3300. <tr>
  3301. <th>Field</th>
  3302. <th>Description</th>
  3303. </tr>
  3304. </thead>
  3305. <tbody>
  3306. <tr>
  3307. <td>
  3308. <code>secretRef</code></br>
  3309. <em>
  3310. <a href="#external-secrets.io/v1beta1.IBMAuthSecretRef">
  3311. IBMAuthSecretRef
  3312. </a>
  3313. </em>
  3314. </td>
  3315. <td>
  3316. </td>
  3317. </tr>
  3318. </tbody>
  3319. </table>
  3320. <h3 id="external-secrets.io/v1beta1.IBMAuthSecretRef">IBMAuthSecretRef
  3321. </h3>
  3322. <p>
  3323. (<em>Appears on:</em>
  3324. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  3325. </p>
  3326. <p>
  3327. </p>
  3328. <table>
  3329. <thead>
  3330. <tr>
  3331. <th>Field</th>
  3332. <th>Description</th>
  3333. </tr>
  3334. </thead>
  3335. <tbody>
  3336. <tr>
  3337. <td>
  3338. <code>secretApiKeySecretRef</code></br>
  3339. <em>
  3340. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3341. </em>
  3342. </td>
  3343. <td>
  3344. <em>(Optional)</em>
  3345. <p>The SecretAccessKey is used for authentication</p>
  3346. </td>
  3347. </tr>
  3348. </tbody>
  3349. </table>
  3350. <h3 id="external-secrets.io/v1beta1.IBMProvider">IBMProvider
  3351. </h3>
  3352. <p>
  3353. (<em>Appears on:</em>
  3354. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3355. </p>
  3356. <p>
  3357. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
  3358. backend.</p>
  3359. </p>
  3360. <table>
  3361. <thead>
  3362. <tr>
  3363. <th>Field</th>
  3364. <th>Description</th>
  3365. </tr>
  3366. </thead>
  3367. <tbody>
  3368. <tr>
  3369. <td>
  3370. <code>auth</code></br>
  3371. <em>
  3372. <a href="#external-secrets.io/v1beta1.IBMAuth">
  3373. IBMAuth
  3374. </a>
  3375. </em>
  3376. </td>
  3377. <td>
  3378. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
  3379. </td>
  3380. </tr>
  3381. <tr>
  3382. <td>
  3383. <code>serviceUrl</code></br>
  3384. <em>
  3385. string
  3386. </em>
  3387. </td>
  3388. <td>
  3389. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
  3390. </td>
  3391. </tr>
  3392. </tbody>
  3393. </table>
  3394. <h3 id="external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth
  3395. </h3>
  3396. <p>
  3397. (<em>Appears on:</em>
  3398. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  3399. </p>
  3400. <p>
  3401. </p>
  3402. <table>
  3403. <thead>
  3404. <tr>
  3405. <th>Field</th>
  3406. <th>Description</th>
  3407. </tr>
  3408. </thead>
  3409. <tbody>
  3410. <tr>
  3411. <td>
  3412. <code>cert</code></br>
  3413. <em>
  3414. <a href="#external-secrets.io/v1beta1.CertAuth">
  3415. CertAuth
  3416. </a>
  3417. </em>
  3418. </td>
  3419. <td>
  3420. <em>(Optional)</em>
  3421. <p>has both clientCert and clientKey as secretKeySelector</p>
  3422. </td>
  3423. </tr>
  3424. <tr>
  3425. <td>
  3426. <code>token</code></br>
  3427. <em>
  3428. <a href="#external-secrets.io/v1beta1.TokenAuth">
  3429. TokenAuth
  3430. </a>
  3431. </em>
  3432. </td>
  3433. <td>
  3434. <em>(Optional)</em>
  3435. <p>use static token to authenticate with</p>
  3436. </td>
  3437. </tr>
  3438. <tr>
  3439. <td>
  3440. <code>serviceAccount</code></br>
  3441. <em>
  3442. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  3443. </em>
  3444. </td>
  3445. <td>
  3446. <em>(Optional)</em>
  3447. <p>points to a service account that should be used for authentication</p>
  3448. </td>
  3449. </tr>
  3450. </tbody>
  3451. </table>
  3452. <h3 id="external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider
  3453. </h3>
  3454. <p>
  3455. (<em>Appears on:</em>
  3456. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3457. </p>
  3458. <p>
  3459. <p>Configures a store to sync secrets with a Kubernetes instance.</p>
  3460. </p>
  3461. <table>
  3462. <thead>
  3463. <tr>
  3464. <th>Field</th>
  3465. <th>Description</th>
  3466. </tr>
  3467. </thead>
  3468. <tbody>
  3469. <tr>
  3470. <td>
  3471. <code>server</code></br>
  3472. <em>
  3473. <a href="#external-secrets.io/v1beta1.KubernetesServer">
  3474. KubernetesServer
  3475. </a>
  3476. </em>
  3477. </td>
  3478. <td>
  3479. <p>configures the Kubernetes server Address.</p>
  3480. </td>
  3481. </tr>
  3482. <tr>
  3483. <td>
  3484. <code>auth</code></br>
  3485. <em>
  3486. <a href="#external-secrets.io/v1beta1.KubernetesAuth">
  3487. KubernetesAuth
  3488. </a>
  3489. </em>
  3490. </td>
  3491. <td>
  3492. <p>Auth configures how secret-manager authenticates with a Kubernetes instance.</p>
  3493. </td>
  3494. </tr>
  3495. <tr>
  3496. <td>
  3497. <code>remoteNamespace</code></br>
  3498. <em>
  3499. string
  3500. </em>
  3501. </td>
  3502. <td>
  3503. <em>(Optional)</em>
  3504. <p>Remote namespace to fetch the secrets from</p>
  3505. </td>
  3506. </tr>
  3507. </tbody>
  3508. </table>
  3509. <h3 id="external-secrets.io/v1beta1.KubernetesServer">KubernetesServer
  3510. </h3>
  3511. <p>
  3512. (<em>Appears on:</em>
  3513. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  3514. </p>
  3515. <p>
  3516. </p>
  3517. <table>
  3518. <thead>
  3519. <tr>
  3520. <th>Field</th>
  3521. <th>Description</th>
  3522. </tr>
  3523. </thead>
  3524. <tbody>
  3525. <tr>
  3526. <td>
  3527. <code>url</code></br>
  3528. <em>
  3529. string
  3530. </em>
  3531. </td>
  3532. <td>
  3533. <em>(Optional)</em>
  3534. <p>configures the Kubernetes server Address.</p>
  3535. </td>
  3536. </tr>
  3537. <tr>
  3538. <td>
  3539. <code>caBundle</code></br>
  3540. <em>
  3541. []byte
  3542. </em>
  3543. </td>
  3544. <td>
  3545. <em>(Optional)</em>
  3546. <p>CABundle is a base64-encoded CA certificate</p>
  3547. </td>
  3548. </tr>
  3549. <tr>
  3550. <td>
  3551. <code>caProvider</code></br>
  3552. <em>
  3553. <a href="#external-secrets.io/v1beta1.CAProvider">
  3554. CAProvider
  3555. </a>
  3556. </em>
  3557. </td>
  3558. <td>
  3559. <em>(Optional)</em>
  3560. <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>
  3561. </td>
  3562. </tr>
  3563. </tbody>
  3564. </table>
  3565. <h3 id="external-secrets.io/v1beta1.NoSecretError">NoSecretError
  3566. </h3>
  3567. <p>
  3568. <p>NoSecretError shall be returned when a GetSecret can not find the
  3569. desired secret. This is used for deletionPolicy.</p>
  3570. </p>
  3571. <h3 id="external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth
  3572. </h3>
  3573. <p>
  3574. (<em>Appears on:</em>
  3575. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider</a>)
  3576. </p>
  3577. <p>
  3578. <p>OnePasswordAuth contains a secretRef for credentials.</p>
  3579. </p>
  3580. <table>
  3581. <thead>
  3582. <tr>
  3583. <th>Field</th>
  3584. <th>Description</th>
  3585. </tr>
  3586. </thead>
  3587. <tbody>
  3588. <tr>
  3589. <td>
  3590. <code>secretRef</code></br>
  3591. <em>
  3592. <a href="#external-secrets.io/v1beta1.OnePasswordAuthSecretRef">
  3593. OnePasswordAuthSecretRef
  3594. </a>
  3595. </em>
  3596. </td>
  3597. <td>
  3598. </td>
  3599. </tr>
  3600. </tbody>
  3601. </table>
  3602. <h3 id="external-secrets.io/v1beta1.OnePasswordAuthSecretRef">OnePasswordAuthSecretRef
  3603. </h3>
  3604. <p>
  3605. (<em>Appears on:</em>
  3606. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth</a>)
  3607. </p>
  3608. <p>
  3609. <p>OnePasswordAuthSecretRef holds secret references for 1Password credentials.</p>
  3610. </p>
  3611. <table>
  3612. <thead>
  3613. <tr>
  3614. <th>Field</th>
  3615. <th>Description</th>
  3616. </tr>
  3617. </thead>
  3618. <tbody>
  3619. <tr>
  3620. <td>
  3621. <code>connectTokenSecretRef</code></br>
  3622. <em>
  3623. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3624. </em>
  3625. </td>
  3626. <td>
  3627. <p>The ConnectToken is used for authentication to a 1Password Connect Server.</p>
  3628. </td>
  3629. </tr>
  3630. </tbody>
  3631. </table>
  3632. <h3 id="external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider
  3633. </h3>
  3634. <p>
  3635. (<em>Appears on:</em>
  3636. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3637. </p>
  3638. <p>
  3639. <p>OnePasswordProvider configures a store to sync secrets using the 1Password Secret Manager provider.</p>
  3640. </p>
  3641. <table>
  3642. <thead>
  3643. <tr>
  3644. <th>Field</th>
  3645. <th>Description</th>
  3646. </tr>
  3647. </thead>
  3648. <tbody>
  3649. <tr>
  3650. <td>
  3651. <code>auth</code></br>
  3652. <em>
  3653. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">
  3654. OnePasswordAuth
  3655. </a>
  3656. </em>
  3657. </td>
  3658. <td>
  3659. <p>Auth defines the information necessary to authenticate against OnePassword Connect Server</p>
  3660. </td>
  3661. </tr>
  3662. <tr>
  3663. <td>
  3664. <code>connectHost</code></br>
  3665. <em>
  3666. string
  3667. </em>
  3668. </td>
  3669. <td>
  3670. <p>ConnectHost defines the OnePassword Connect Server to connect to</p>
  3671. </td>
  3672. </tr>
  3673. <tr>
  3674. <td>
  3675. <code>vaults</code></br>
  3676. <em>
  3677. map[string]int
  3678. </em>
  3679. </td>
  3680. <td>
  3681. <p>Vaults defines which OnePassword vaults to search in which order</p>
  3682. </td>
  3683. </tr>
  3684. </tbody>
  3685. </table>
  3686. <h3 id="external-secrets.io/v1beta1.OracleAuth">OracleAuth
  3687. </h3>
  3688. <p>
  3689. (<em>Appears on:</em>
  3690. <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
  3691. </p>
  3692. <p>
  3693. </p>
  3694. <table>
  3695. <thead>
  3696. <tr>
  3697. <th>Field</th>
  3698. <th>Description</th>
  3699. </tr>
  3700. </thead>
  3701. <tbody>
  3702. <tr>
  3703. <td>
  3704. <code>tenancy</code></br>
  3705. <em>
  3706. string
  3707. </em>
  3708. </td>
  3709. <td>
  3710. <p>Tenancy is the tenancy OCID where user is located.</p>
  3711. </td>
  3712. </tr>
  3713. <tr>
  3714. <td>
  3715. <code>user</code></br>
  3716. <em>
  3717. string
  3718. </em>
  3719. </td>
  3720. <td>
  3721. <p>User is an access OCID specific to the account.</p>
  3722. </td>
  3723. </tr>
  3724. <tr>
  3725. <td>
  3726. <code>secretRef</code></br>
  3727. <em>
  3728. <a href="#external-secrets.io/v1beta1.OracleSecretRef">
  3729. OracleSecretRef
  3730. </a>
  3731. </em>
  3732. </td>
  3733. <td>
  3734. <p>SecretRef to pass through sensitive information.</p>
  3735. </td>
  3736. </tr>
  3737. </tbody>
  3738. </table>
  3739. <h3 id="external-secrets.io/v1beta1.OracleProvider">OracleProvider
  3740. </h3>
  3741. <p>
  3742. (<em>Appears on:</em>
  3743. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3744. </p>
  3745. <p>
  3746. <p>Configures an store to sync secrets using a Oracle Vault
  3747. backend.</p>
  3748. </p>
  3749. <table>
  3750. <thead>
  3751. <tr>
  3752. <th>Field</th>
  3753. <th>Description</th>
  3754. </tr>
  3755. </thead>
  3756. <tbody>
  3757. <tr>
  3758. <td>
  3759. <code>region</code></br>
  3760. <em>
  3761. string
  3762. </em>
  3763. </td>
  3764. <td>
  3765. <p>Region is the region where vault is located.</p>
  3766. </td>
  3767. </tr>
  3768. <tr>
  3769. <td>
  3770. <code>vault</code></br>
  3771. <em>
  3772. string
  3773. </em>
  3774. </td>
  3775. <td>
  3776. <p>Vault is the vault&rsquo;s OCID of the specific vault where secret is located.</p>
  3777. </td>
  3778. </tr>
  3779. <tr>
  3780. <td>
  3781. <code>auth</code></br>
  3782. <em>
  3783. <a href="#external-secrets.io/v1beta1.OracleAuth">
  3784. OracleAuth
  3785. </a>
  3786. </em>
  3787. </td>
  3788. <td>
  3789. <em>(Optional)</em>
  3790. <p>Auth configures how secret-manager authenticates with the Oracle Vault.
  3791. If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
  3792. </td>
  3793. </tr>
  3794. </tbody>
  3795. </table>
  3796. <h3 id="external-secrets.io/v1beta1.OracleSecretRef">OracleSecretRef
  3797. </h3>
  3798. <p>
  3799. (<em>Appears on:</em>
  3800. <a href="#external-secrets.io/v1beta1.OracleAuth">OracleAuth</a>)
  3801. </p>
  3802. <p>
  3803. </p>
  3804. <table>
  3805. <thead>
  3806. <tr>
  3807. <th>Field</th>
  3808. <th>Description</th>
  3809. </tr>
  3810. </thead>
  3811. <tbody>
  3812. <tr>
  3813. <td>
  3814. <code>privatekey</code></br>
  3815. <em>
  3816. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3817. </em>
  3818. </td>
  3819. <td>
  3820. <p>PrivateKey is the user&rsquo;s API Signing Key in PEM format, used for authentication.</p>
  3821. </td>
  3822. </tr>
  3823. <tr>
  3824. <td>
  3825. <code>fingerprint</code></br>
  3826. <em>
  3827. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3828. </em>
  3829. </td>
  3830. <td>
  3831. <p>Fingerprint is the fingerprint of the API private key.</p>
  3832. </td>
  3833. </tr>
  3834. </tbody>
  3835. </table>
  3836. <h3 id="external-secrets.io/v1beta1.Provider">Provider
  3837. </h3>
  3838. <p>
  3839. <p>Provider is a common interface for interacting with secret backends.</p>
  3840. </p>
  3841. <h3 id="external-secrets.io/v1beta1.SecretStore">SecretStore
  3842. </h3>
  3843. <p>
  3844. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  3845. </p>
  3846. <table>
  3847. <thead>
  3848. <tr>
  3849. <th>Field</th>
  3850. <th>Description</th>
  3851. </tr>
  3852. </thead>
  3853. <tbody>
  3854. <tr>
  3855. <td>
  3856. <code>metadata</code></br>
  3857. <em>
  3858. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  3859. Kubernetes meta/v1.ObjectMeta
  3860. </a>
  3861. </em>
  3862. </td>
  3863. <td>
  3864. Refer to the Kubernetes API documentation for the fields of the
  3865. <code>metadata</code> field.
  3866. </td>
  3867. </tr>
  3868. <tr>
  3869. <td>
  3870. <code>spec</code></br>
  3871. <em>
  3872. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  3873. SecretStoreSpec
  3874. </a>
  3875. </em>
  3876. </td>
  3877. <td>
  3878. <br/>
  3879. <br/>
  3880. <table>
  3881. <tr>
  3882. <td>
  3883. <code>controller</code></br>
  3884. <em>
  3885. string
  3886. </em>
  3887. </td>
  3888. <td>
  3889. <em>(Optional)</em>
  3890. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  3891. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  3892. </td>
  3893. </tr>
  3894. <tr>
  3895. <td>
  3896. <code>provider</code></br>
  3897. <em>
  3898. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  3899. SecretStoreProvider
  3900. </a>
  3901. </em>
  3902. </td>
  3903. <td>
  3904. <p>Used to configure the provider. Only one provider may be set</p>
  3905. </td>
  3906. </tr>
  3907. <tr>
  3908. <td>
  3909. <code>retrySettings</code></br>
  3910. <em>
  3911. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  3912. SecretStoreRetrySettings
  3913. </a>
  3914. </em>
  3915. </td>
  3916. <td>
  3917. <em>(Optional)</em>
  3918. <p>Used to configure http retries if failed</p>
  3919. </td>
  3920. </tr>
  3921. <tr>
  3922. <td>
  3923. <code>refreshInterval</code></br>
  3924. <em>
  3925. int
  3926. </em>
  3927. </td>
  3928. <td>
  3929. <em>(Optional)</em>
  3930. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  3931. </td>
  3932. </tr>
  3933. </table>
  3934. </td>
  3935. </tr>
  3936. <tr>
  3937. <td>
  3938. <code>status</code></br>
  3939. <em>
  3940. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  3941. SecretStoreStatus
  3942. </a>
  3943. </em>
  3944. </td>
  3945. <td>
  3946. </td>
  3947. </tr>
  3948. </tbody>
  3949. </table>
  3950. <h3 id="external-secrets.io/v1beta1.SecretStoreConditionType">SecretStoreConditionType
  3951. (<code>string</code> alias)</p></h3>
  3952. <p>
  3953. (<em>Appears on:</em>
  3954. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  3955. </p>
  3956. <p>
  3957. </p>
  3958. <table>
  3959. <thead>
  3960. <tr>
  3961. <th>Value</th>
  3962. <th>Description</th>
  3963. </tr>
  3964. </thead>
  3965. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  3966. <td></td>
  3967. </tr></tbody>
  3968. </table>
  3969. <h3 id="external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider
  3970. </h3>
  3971. <p>
  3972. (<em>Appears on:</em>
  3973. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  3974. </p>
  3975. <p>
  3976. <p>SecretStoreProvider contains the provider-specific configration.</p>
  3977. </p>
  3978. <table>
  3979. <thead>
  3980. <tr>
  3981. <th>Field</th>
  3982. <th>Description</th>
  3983. </tr>
  3984. </thead>
  3985. <tbody>
  3986. <tr>
  3987. <td>
  3988. <code>aws</code></br>
  3989. <em>
  3990. <a href="#external-secrets.io/v1beta1.AWSProvider">
  3991. AWSProvider
  3992. </a>
  3993. </em>
  3994. </td>
  3995. <td>
  3996. <em>(Optional)</em>
  3997. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  3998. </td>
  3999. </tr>
  4000. <tr>
  4001. <td>
  4002. <code>azurekv</code></br>
  4003. <em>
  4004. <a href="#external-secrets.io/v1beta1.AzureKVProvider">
  4005. AzureKVProvider
  4006. </a>
  4007. </em>
  4008. </td>
  4009. <td>
  4010. <em>(Optional)</em>
  4011. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  4012. </td>
  4013. </tr>
  4014. <tr>
  4015. <td>
  4016. <code>akeyless</code></br>
  4017. <em>
  4018. <a href="#external-secrets.io/v1beta1.AkeylessProvider">
  4019. AkeylessProvider
  4020. </a>
  4021. </em>
  4022. </td>
  4023. <td>
  4024. <em>(Optional)</em>
  4025. <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
  4026. </td>
  4027. </tr>
  4028. <tr>
  4029. <td>
  4030. <code>vault</code></br>
  4031. <em>
  4032. <a href="#external-secrets.io/v1beta1.VaultProvider">
  4033. VaultProvider
  4034. </a>
  4035. </em>
  4036. </td>
  4037. <td>
  4038. <em>(Optional)</em>
  4039. <p>Vault configures this store to sync secrets using Hashi provider</p>
  4040. </td>
  4041. </tr>
  4042. <tr>
  4043. <td>
  4044. <code>gcpsm</code></br>
  4045. <em>
  4046. <a href="#external-secrets.io/v1beta1.GCPSMProvider">
  4047. GCPSMProvider
  4048. </a>
  4049. </em>
  4050. </td>
  4051. <td>
  4052. <em>(Optional)</em>
  4053. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  4054. </td>
  4055. </tr>
  4056. <tr>
  4057. <td>
  4058. <code>oracle</code></br>
  4059. <em>
  4060. <a href="#external-secrets.io/v1beta1.OracleProvider">
  4061. OracleProvider
  4062. </a>
  4063. </em>
  4064. </td>
  4065. <td>
  4066. <em>(Optional)</em>
  4067. <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
  4068. </td>
  4069. </tr>
  4070. <tr>
  4071. <td>
  4072. <code>ibm</code></br>
  4073. <em>
  4074. <a href="#external-secrets.io/v1beta1.IBMProvider">
  4075. IBMProvider
  4076. </a>
  4077. </em>
  4078. </td>
  4079. <td>
  4080. <em>(Optional)</em>
  4081. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
  4082. </td>
  4083. </tr>
  4084. <tr>
  4085. <td>
  4086. <code>yandexcertificatemanager</code></br>
  4087. <em>
  4088. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">
  4089. YandexCertificateManagerProvider
  4090. </a>
  4091. </em>
  4092. </td>
  4093. <td>
  4094. <em>(Optional)</em>
  4095. <p>YandexCertificateManager configures this store to sync secrets using Yandex Certificate Manager provider</p>
  4096. </td>
  4097. </tr>
  4098. <tr>
  4099. <td>
  4100. <code>yandexlockbox</code></br>
  4101. <em>
  4102. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">
  4103. YandexLockboxProvider
  4104. </a>
  4105. </em>
  4106. </td>
  4107. <td>
  4108. <em>(Optional)</em>
  4109. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
  4110. </td>
  4111. </tr>
  4112. <tr>
  4113. <td>
  4114. <code>gitlab</code></br>
  4115. <em>
  4116. <a href="#external-secrets.io/v1beta1.GitlabProvider">
  4117. GitlabProvider
  4118. </a>
  4119. </em>
  4120. </td>
  4121. <td>
  4122. <em>(Optional)</em>
  4123. <p>Gitlab configures this store to sync secrets using Gitlab Variables provider</p>
  4124. </td>
  4125. </tr>
  4126. <tr>
  4127. <td>
  4128. <code>alibaba</code></br>
  4129. <em>
  4130. <a href="#external-secrets.io/v1beta1.AlibabaProvider">
  4131. AlibabaProvider
  4132. </a>
  4133. </em>
  4134. </td>
  4135. <td>
  4136. <em>(Optional)</em>
  4137. <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
  4138. </td>
  4139. </tr>
  4140. <tr>
  4141. <td>
  4142. <code>onepassword</code></br>
  4143. <em>
  4144. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">
  4145. OnePasswordProvider
  4146. </a>
  4147. </em>
  4148. </td>
  4149. <td>
  4150. <em>(Optional)</em>
  4151. <p>OnePassword configures this store to sync secrets using the 1Password Cloud provider</p>
  4152. </td>
  4153. </tr>
  4154. <tr>
  4155. <td>
  4156. <code>webhook</code></br>
  4157. <em>
  4158. <a href="#external-secrets.io/v1beta1.WebhookProvider">
  4159. WebhookProvider
  4160. </a>
  4161. </em>
  4162. </td>
  4163. <td>
  4164. <em>(Optional)</em>
  4165. <p>Webhook configures this store to sync secrets using a generic templated webhook</p>
  4166. </td>
  4167. </tr>
  4168. <tr>
  4169. <td>
  4170. <code>kubernetes</code></br>
  4171. <em>
  4172. <a href="#external-secrets.io/v1beta1.KubernetesProvider">
  4173. KubernetesProvider
  4174. </a>
  4175. </em>
  4176. </td>
  4177. <td>
  4178. <em>(Optional)</em>
  4179. <p>Kubernetes configures this store to sync secrets using a Kubernetes cluster provider</p>
  4180. </td>
  4181. </tr>
  4182. <tr>
  4183. <td>
  4184. <code>fake</code></br>
  4185. <em>
  4186. <a href="#external-secrets.io/v1beta1.FakeProvider">
  4187. FakeProvider
  4188. </a>
  4189. </em>
  4190. </td>
  4191. <td>
  4192. <em>(Optional)</em>
  4193. <p>Fake configures a store with static key/value pairs</p>
  4194. </td>
  4195. </tr>
  4196. <tr>
  4197. <td>
  4198. <code>senhasegura</code></br>
  4199. <em>
  4200. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">
  4201. SenhaseguraProvider
  4202. </a>
  4203. </em>
  4204. </td>
  4205. <td>
  4206. <em>(Optional)</em>
  4207. <p>Senhasegura configures this store to sync secrets using senhasegura provider</p>
  4208. </td>
  4209. </tr>
  4210. </tbody>
  4211. </table>
  4212. <h3 id="external-secrets.io/v1beta1.SecretStoreRef">SecretStoreRef
  4213. </h3>
  4214. <p>
  4215. (<em>Appears on:</em>
  4216. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  4217. </p>
  4218. <p>
  4219. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  4220. </p>
  4221. <table>
  4222. <thead>
  4223. <tr>
  4224. <th>Field</th>
  4225. <th>Description</th>
  4226. </tr>
  4227. </thead>
  4228. <tbody>
  4229. <tr>
  4230. <td>
  4231. <code>name</code></br>
  4232. <em>
  4233. string
  4234. </em>
  4235. </td>
  4236. <td>
  4237. <p>Name of the SecretStore resource</p>
  4238. </td>
  4239. </tr>
  4240. <tr>
  4241. <td>
  4242. <code>kind</code></br>
  4243. <em>
  4244. string
  4245. </em>
  4246. </td>
  4247. <td>
  4248. <em>(Optional)</em>
  4249. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  4250. Defaults to <code>SecretStore</code></p>
  4251. </td>
  4252. </tr>
  4253. </tbody>
  4254. </table>
  4255. <h3 id="external-secrets.io/v1beta1.SecretStoreRetrySettings">SecretStoreRetrySettings
  4256. </h3>
  4257. <p>
  4258. (<em>Appears on:</em>
  4259. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  4260. </p>
  4261. <p>
  4262. </p>
  4263. <table>
  4264. <thead>
  4265. <tr>
  4266. <th>Field</th>
  4267. <th>Description</th>
  4268. </tr>
  4269. </thead>
  4270. <tbody>
  4271. <tr>
  4272. <td>
  4273. <code>maxRetries</code></br>
  4274. <em>
  4275. int32
  4276. </em>
  4277. </td>
  4278. <td>
  4279. </td>
  4280. </tr>
  4281. <tr>
  4282. <td>
  4283. <code>retryInterval</code></br>
  4284. <em>
  4285. string
  4286. </em>
  4287. </td>
  4288. <td>
  4289. </td>
  4290. </tr>
  4291. </tbody>
  4292. </table>
  4293. <h3 id="external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec
  4294. </h3>
  4295. <p>
  4296. (<em>Appears on:</em>
  4297. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  4298. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  4299. </p>
  4300. <p>
  4301. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  4302. </p>
  4303. <table>
  4304. <thead>
  4305. <tr>
  4306. <th>Field</th>
  4307. <th>Description</th>
  4308. </tr>
  4309. </thead>
  4310. <tbody>
  4311. <tr>
  4312. <td>
  4313. <code>controller</code></br>
  4314. <em>
  4315. string
  4316. </em>
  4317. </td>
  4318. <td>
  4319. <em>(Optional)</em>
  4320. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  4321. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  4322. </td>
  4323. </tr>
  4324. <tr>
  4325. <td>
  4326. <code>provider</code></br>
  4327. <em>
  4328. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  4329. SecretStoreProvider
  4330. </a>
  4331. </em>
  4332. </td>
  4333. <td>
  4334. <p>Used to configure the provider. Only one provider may be set</p>
  4335. </td>
  4336. </tr>
  4337. <tr>
  4338. <td>
  4339. <code>retrySettings</code></br>
  4340. <em>
  4341. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  4342. SecretStoreRetrySettings
  4343. </a>
  4344. </em>
  4345. </td>
  4346. <td>
  4347. <em>(Optional)</em>
  4348. <p>Used to configure http retries if failed</p>
  4349. </td>
  4350. </tr>
  4351. <tr>
  4352. <td>
  4353. <code>refreshInterval</code></br>
  4354. <em>
  4355. int
  4356. </em>
  4357. </td>
  4358. <td>
  4359. <em>(Optional)</em>
  4360. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  4361. </td>
  4362. </tr>
  4363. </tbody>
  4364. </table>
  4365. <h3 id="external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus
  4366. </h3>
  4367. <p>
  4368. (<em>Appears on:</em>
  4369. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  4370. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  4371. </p>
  4372. <p>
  4373. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  4374. </p>
  4375. <table>
  4376. <thead>
  4377. <tr>
  4378. <th>Field</th>
  4379. <th>Description</th>
  4380. </tr>
  4381. </thead>
  4382. <tbody>
  4383. <tr>
  4384. <td>
  4385. <code>conditions</code></br>
  4386. <em>
  4387. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">
  4388. []SecretStoreStatusCondition
  4389. </a>
  4390. </em>
  4391. </td>
  4392. <td>
  4393. <em>(Optional)</em>
  4394. </td>
  4395. </tr>
  4396. </tbody>
  4397. </table>
  4398. <h3 id="external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition
  4399. </h3>
  4400. <p>
  4401. (<em>Appears on:</em>
  4402. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  4403. </p>
  4404. <p>
  4405. </p>
  4406. <table>
  4407. <thead>
  4408. <tr>
  4409. <th>Field</th>
  4410. <th>Description</th>
  4411. </tr>
  4412. </thead>
  4413. <tbody>
  4414. <tr>
  4415. <td>
  4416. <code>type</code></br>
  4417. <em>
  4418. <a href="#external-secrets.io/v1beta1.SecretStoreConditionType">
  4419. SecretStoreConditionType
  4420. </a>
  4421. </em>
  4422. </td>
  4423. <td>
  4424. </td>
  4425. </tr>
  4426. <tr>
  4427. <td>
  4428. <code>status</code></br>
  4429. <em>
  4430. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  4431. Kubernetes core/v1.ConditionStatus
  4432. </a>
  4433. </em>
  4434. </td>
  4435. <td>
  4436. </td>
  4437. </tr>
  4438. <tr>
  4439. <td>
  4440. <code>reason</code></br>
  4441. <em>
  4442. string
  4443. </em>
  4444. </td>
  4445. <td>
  4446. <em>(Optional)</em>
  4447. </td>
  4448. </tr>
  4449. <tr>
  4450. <td>
  4451. <code>message</code></br>
  4452. <em>
  4453. string
  4454. </em>
  4455. </td>
  4456. <td>
  4457. <em>(Optional)</em>
  4458. </td>
  4459. </tr>
  4460. <tr>
  4461. <td>
  4462. <code>lastTransitionTime</code></br>
  4463. <em>
  4464. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  4465. Kubernetes meta/v1.Time
  4466. </a>
  4467. </em>
  4468. </td>
  4469. <td>
  4470. <em>(Optional)</em>
  4471. </td>
  4472. </tr>
  4473. </tbody>
  4474. </table>
  4475. <h3 id="external-secrets.io/v1beta1.SecretsClient">SecretsClient
  4476. </h3>
  4477. <p>
  4478. <p>SecretsClient provides access to secrets.</p>
  4479. </p>
  4480. <h3 id="external-secrets.io/v1beta1.SenhaseguraAuth">SenhaseguraAuth
  4481. </h3>
  4482. <p>
  4483. (<em>Appears on:</em>
  4484. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  4485. </p>
  4486. <p>
  4487. <pre><code>SenhaseguraAuth tells the controller how to do auth in senhasegura
  4488. </code></pre>
  4489. </p>
  4490. <table>
  4491. <thead>
  4492. <tr>
  4493. <th>Field</th>
  4494. <th>Description</th>
  4495. </tr>
  4496. </thead>
  4497. <tbody>
  4498. <tr>
  4499. <td>
  4500. <code>clientId</code></br>
  4501. <em>
  4502. string
  4503. </em>
  4504. </td>
  4505. <td>
  4506. </td>
  4507. </tr>
  4508. <tr>
  4509. <td>
  4510. <code>clientSecretSecretRef</code></br>
  4511. <em>
  4512. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4513. </em>
  4514. </td>
  4515. <td>
  4516. </td>
  4517. </tr>
  4518. </tbody>
  4519. </table>
  4520. <h3 id="external-secrets.io/v1beta1.SenhaseguraModuleType">SenhaseguraModuleType
  4521. (<code>string</code> alias)</p></h3>
  4522. <p>
  4523. (<em>Appears on:</em>
  4524. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  4525. </p>
  4526. <p>
  4527. <pre><code>SenhaseguraModuleType enum defines senhasegura target module to fetch secrets
  4528. </code></pre>
  4529. </p>
  4530. <table>
  4531. <thead>
  4532. <tr>
  4533. <th>Value</th>
  4534. <th>Description</th>
  4535. </tr>
  4536. </thead>
  4537. <tbody><tr><td><p>&#34;DSM&#34;</p></td>
  4538. <td><pre><code> SenhaseguraModuleDSM is the senhasegura DevOps Secrets Management module
  4539. see: https://senhasegura.com/devops
  4540. </code></pre>
  4541. </td>
  4542. </tr></tbody>
  4543. </table>
  4544. <h3 id="external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider
  4545. </h3>
  4546. <p>
  4547. (<em>Appears on:</em>
  4548. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4549. </p>
  4550. <p>
  4551. <pre><code>SenhaseguraProvider setup a store to sync secrets with senhasegura
  4552. </code></pre>
  4553. </p>
  4554. <table>
  4555. <thead>
  4556. <tr>
  4557. <th>Field</th>
  4558. <th>Description</th>
  4559. </tr>
  4560. </thead>
  4561. <tbody>
  4562. <tr>
  4563. <td>
  4564. <code>url</code></br>
  4565. <em>
  4566. string
  4567. </em>
  4568. </td>
  4569. <td>
  4570. <p>URL of senhasegura</p>
  4571. </td>
  4572. </tr>
  4573. <tr>
  4574. <td>
  4575. <code>module</code></br>
  4576. <em>
  4577. <a href="#external-secrets.io/v1beta1.SenhaseguraModuleType">
  4578. SenhaseguraModuleType
  4579. </a>
  4580. </em>
  4581. </td>
  4582. <td>
  4583. <p>Module defines which senhasegura module should be used to get secrets</p>
  4584. </td>
  4585. </tr>
  4586. <tr>
  4587. <td>
  4588. <code>auth</code></br>
  4589. <em>
  4590. <a href="#external-secrets.io/v1beta1.SenhaseguraAuth">
  4591. SenhaseguraAuth
  4592. </a>
  4593. </em>
  4594. </td>
  4595. <td>
  4596. <p>Auth defines parameters to authenticate in senhasegura</p>
  4597. </td>
  4598. </tr>
  4599. <tr>
  4600. <td>
  4601. <code>ignoreSslCertificate</code></br>
  4602. <em>
  4603. bool
  4604. </em>
  4605. </td>
  4606. <td>
  4607. <p>IgnoreSslCertificate defines if SSL certificate must be ignored</p>
  4608. </td>
  4609. </tr>
  4610. </tbody>
  4611. </table>
  4612. <h3 id="external-secrets.io/v1beta1.TemplateEngineVersion">TemplateEngineVersion
  4613. (<code>string</code> alias)</p></h3>
  4614. <p>
  4615. (<em>Appears on:</em>
  4616. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  4617. </p>
  4618. <p>
  4619. </p>
  4620. <table>
  4621. <thead>
  4622. <tr>
  4623. <th>Value</th>
  4624. <th>Description</th>
  4625. </tr>
  4626. </thead>
  4627. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  4628. <td></td>
  4629. </tr><tr><td><p>&#34;v2&#34;</p></td>
  4630. <td></td>
  4631. </tr></tbody>
  4632. </table>
  4633. <h3 id="external-secrets.io/v1beta1.TemplateFrom">TemplateFrom
  4634. </h3>
  4635. <p>
  4636. (<em>Appears on:</em>
  4637. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  4638. </p>
  4639. <p>
  4640. </p>
  4641. <table>
  4642. <thead>
  4643. <tr>
  4644. <th>Field</th>
  4645. <th>Description</th>
  4646. </tr>
  4647. </thead>
  4648. <tbody>
  4649. <tr>
  4650. <td>
  4651. <code>configMap</code></br>
  4652. <em>
  4653. <a href="#external-secrets.io/v1beta1.TemplateRef">
  4654. TemplateRef
  4655. </a>
  4656. </em>
  4657. </td>
  4658. <td>
  4659. </td>
  4660. </tr>
  4661. <tr>
  4662. <td>
  4663. <code>secret</code></br>
  4664. <em>
  4665. <a href="#external-secrets.io/v1beta1.TemplateRef">
  4666. TemplateRef
  4667. </a>
  4668. </em>
  4669. </td>
  4670. <td>
  4671. </td>
  4672. </tr>
  4673. </tbody>
  4674. </table>
  4675. <h3 id="external-secrets.io/v1beta1.TemplateRef">TemplateRef
  4676. </h3>
  4677. <p>
  4678. (<em>Appears on:</em>
  4679. <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
  4680. </p>
  4681. <p>
  4682. </p>
  4683. <table>
  4684. <thead>
  4685. <tr>
  4686. <th>Field</th>
  4687. <th>Description</th>
  4688. </tr>
  4689. </thead>
  4690. <tbody>
  4691. <tr>
  4692. <td>
  4693. <code>name</code></br>
  4694. <em>
  4695. string
  4696. </em>
  4697. </td>
  4698. <td>
  4699. </td>
  4700. </tr>
  4701. <tr>
  4702. <td>
  4703. <code>items</code></br>
  4704. <em>
  4705. <a href="#external-secrets.io/v1beta1.TemplateRefItem">
  4706. []TemplateRefItem
  4707. </a>
  4708. </em>
  4709. </td>
  4710. <td>
  4711. </td>
  4712. </tr>
  4713. </tbody>
  4714. </table>
  4715. <h3 id="external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem
  4716. </h3>
  4717. <p>
  4718. (<em>Appears on:</em>
  4719. <a href="#external-secrets.io/v1beta1.TemplateRef">TemplateRef</a>)
  4720. </p>
  4721. <p>
  4722. </p>
  4723. <table>
  4724. <thead>
  4725. <tr>
  4726. <th>Field</th>
  4727. <th>Description</th>
  4728. </tr>
  4729. </thead>
  4730. <tbody>
  4731. <tr>
  4732. <td>
  4733. <code>key</code></br>
  4734. <em>
  4735. string
  4736. </em>
  4737. </td>
  4738. <td>
  4739. </td>
  4740. </tr>
  4741. </tbody>
  4742. </table>
  4743. <h3 id="external-secrets.io/v1beta1.TokenAuth">TokenAuth
  4744. </h3>
  4745. <p>
  4746. (<em>Appears on:</em>
  4747. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  4748. </p>
  4749. <p>
  4750. </p>
  4751. <table>
  4752. <thead>
  4753. <tr>
  4754. <th>Field</th>
  4755. <th>Description</th>
  4756. </tr>
  4757. </thead>
  4758. <tbody>
  4759. <tr>
  4760. <td>
  4761. <code>bearerToken</code></br>
  4762. <em>
  4763. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4764. </em>
  4765. </td>
  4766. <td>
  4767. </td>
  4768. </tr>
  4769. </tbody>
  4770. </table>
  4771. <h3 id="external-secrets.io/v1beta1.ValidationResult">ValidationResult
  4772. (<code>byte</code> alias)</p></h3>
  4773. <p>
  4774. </p>
  4775. <table>
  4776. <thead>
  4777. <tr>
  4778. <th>Value</th>
  4779. <th>Description</th>
  4780. </tr>
  4781. </thead>
  4782. <tbody><tr><td><p>2</p></td>
  4783. <td><p>Error indicates that there is a misconfiguration.</p>
  4784. </td>
  4785. </tr><tr><td><p>0</p></td>
  4786. <td><p>Ready indicates that the client is confgured correctly
  4787. and can be used.</p>
  4788. </td>
  4789. </tr><tr><td><p>1</p></td>
  4790. <td><p>Unknown indicates that the client can be used
  4791. but information is missing and it can not be validated.</p>
  4792. </td>
  4793. </tr></tbody>
  4794. </table>
  4795. <h3 id="external-secrets.io/v1beta1.VaultAppRole">VaultAppRole
  4796. </h3>
  4797. <p>
  4798. (<em>Appears on:</em>
  4799. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  4800. </p>
  4801. <p>
  4802. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  4803. with the role and secret stored in a Kubernetes Secret resource.</p>
  4804. </p>
  4805. <table>
  4806. <thead>
  4807. <tr>
  4808. <th>Field</th>
  4809. <th>Description</th>
  4810. </tr>
  4811. </thead>
  4812. <tbody>
  4813. <tr>
  4814. <td>
  4815. <code>path</code></br>
  4816. <em>
  4817. string
  4818. </em>
  4819. </td>
  4820. <td>
  4821. <p>Path where the App Role authentication backend is mounted
  4822. in Vault, e.g: &ldquo;approle&rdquo;</p>
  4823. </td>
  4824. </tr>
  4825. <tr>
  4826. <td>
  4827. <code>roleId</code></br>
  4828. <em>
  4829. string
  4830. </em>
  4831. </td>
  4832. <td>
  4833. <p>RoleID configured in the App Role authentication backend when setting
  4834. up the authentication backend in Vault.</p>
  4835. </td>
  4836. </tr>
  4837. <tr>
  4838. <td>
  4839. <code>secretRef</code></br>
  4840. <em>
  4841. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4842. </em>
  4843. </td>
  4844. <td>
  4845. <p>Reference to a key in a Secret that contains the App Role secret used
  4846. to authenticate with Vault.
  4847. The <code>key</code> field must be specified and denotes which entry within the Secret
  4848. resource is used as the app role secret.</p>
  4849. </td>
  4850. </tr>
  4851. </tbody>
  4852. </table>
  4853. <h3 id="external-secrets.io/v1beta1.VaultAuth">VaultAuth
  4854. </h3>
  4855. <p>
  4856. (<em>Appears on:</em>
  4857. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  4858. </p>
  4859. <p>
  4860. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  4861. Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>jwt</code> or <code>cert</code>
  4862. can be specified.</p>
  4863. </p>
  4864. <table>
  4865. <thead>
  4866. <tr>
  4867. <th>Field</th>
  4868. <th>Description</th>
  4869. </tr>
  4870. </thead>
  4871. <tbody>
  4872. <tr>
  4873. <td>
  4874. <code>tokenSecretRef</code></br>
  4875. <em>
  4876. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4877. </em>
  4878. </td>
  4879. <td>
  4880. <em>(Optional)</em>
  4881. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  4882. </td>
  4883. </tr>
  4884. <tr>
  4885. <td>
  4886. <code>appRole</code></br>
  4887. <em>
  4888. <a href="#external-secrets.io/v1beta1.VaultAppRole">
  4889. VaultAppRole
  4890. </a>
  4891. </em>
  4892. </td>
  4893. <td>
  4894. <em>(Optional)</em>
  4895. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  4896. with the role and secret stored in a Kubernetes Secret resource.</p>
  4897. </td>
  4898. </tr>
  4899. <tr>
  4900. <td>
  4901. <code>kubernetes</code></br>
  4902. <em>
  4903. <a href="#external-secrets.io/v1beta1.VaultKubernetesAuth">
  4904. VaultKubernetesAuth
  4905. </a>
  4906. </em>
  4907. </td>
  4908. <td>
  4909. <em>(Optional)</em>
  4910. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  4911. token stored in the named Secret resource to the Vault server.</p>
  4912. </td>
  4913. </tr>
  4914. <tr>
  4915. <td>
  4916. <code>ldap</code></br>
  4917. <em>
  4918. <a href="#external-secrets.io/v1beta1.VaultLdapAuth">
  4919. VaultLdapAuth
  4920. </a>
  4921. </em>
  4922. </td>
  4923. <td>
  4924. <em>(Optional)</em>
  4925. <p>Ldap authenticates with Vault by passing username/password pair using
  4926. the LDAP authentication method</p>
  4927. </td>
  4928. </tr>
  4929. <tr>
  4930. <td>
  4931. <code>jwt</code></br>
  4932. <em>
  4933. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">
  4934. VaultJwtAuth
  4935. </a>
  4936. </em>
  4937. </td>
  4938. <td>
  4939. <em>(Optional)</em>
  4940. <p>Jwt authenticates with Vault by passing role and JWT token using the
  4941. JWT/OIDC authentication method</p>
  4942. </td>
  4943. </tr>
  4944. <tr>
  4945. <td>
  4946. <code>cert</code></br>
  4947. <em>
  4948. <a href="#external-secrets.io/v1beta1.VaultCertAuth">
  4949. VaultCertAuth
  4950. </a>
  4951. </em>
  4952. </td>
  4953. <td>
  4954. <em>(Optional)</em>
  4955. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  4956. Cert authentication method</p>
  4957. </td>
  4958. </tr>
  4959. </tbody>
  4960. </table>
  4961. <h3 id="external-secrets.io/v1beta1.VaultCertAuth">VaultCertAuth
  4962. </h3>
  4963. <p>
  4964. (<em>Appears on:</em>
  4965. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  4966. </p>
  4967. <p>
  4968. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  4969. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  4970. </p>
  4971. <table>
  4972. <thead>
  4973. <tr>
  4974. <th>Field</th>
  4975. <th>Description</th>
  4976. </tr>
  4977. </thead>
  4978. <tbody>
  4979. <tr>
  4980. <td>
  4981. <code>clientCert</code></br>
  4982. <em>
  4983. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4984. </em>
  4985. </td>
  4986. <td>
  4987. <em>(Optional)</em>
  4988. <p>ClientCert is a certificate to authenticate using the Cert Vault
  4989. authentication method</p>
  4990. </td>
  4991. </tr>
  4992. <tr>
  4993. <td>
  4994. <code>secretRef</code></br>
  4995. <em>
  4996. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4997. </em>
  4998. </td>
  4999. <td>
  5000. <p>SecretRef to a key in a Secret resource containing client private key to
  5001. authenticate with Vault using the Cert authentication method</p>
  5002. </td>
  5003. </tr>
  5004. </tbody>
  5005. </table>
  5006. <h3 id="external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth
  5007. </h3>
  5008. <p>
  5009. (<em>Appears on:</em>
  5010. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  5011. </p>
  5012. <p>
  5013. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  5014. method, with the role name and a token stored in a Kubernetes Secret resource or
  5015. a Kubernetes service account token retrieved via <code>TokenRequest</code>.</p>
  5016. </p>
  5017. <table>
  5018. <thead>
  5019. <tr>
  5020. <th>Field</th>
  5021. <th>Description</th>
  5022. </tr>
  5023. </thead>
  5024. <tbody>
  5025. <tr>
  5026. <td>
  5027. <code>path</code></br>
  5028. <em>
  5029. string
  5030. </em>
  5031. </td>
  5032. <td>
  5033. <p>Path where the JWT authentication backend is mounted
  5034. in Vault, e.g: &ldquo;jwt&rdquo;</p>
  5035. </td>
  5036. </tr>
  5037. <tr>
  5038. <td>
  5039. <code>role</code></br>
  5040. <em>
  5041. string
  5042. </em>
  5043. </td>
  5044. <td>
  5045. <em>(Optional)</em>
  5046. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  5047. authentication method</p>
  5048. </td>
  5049. </tr>
  5050. <tr>
  5051. <td>
  5052. <code>secretRef</code></br>
  5053. <em>
  5054. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  5055. </em>
  5056. </td>
  5057. <td>
  5058. <em>(Optional)</em>
  5059. <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  5060. authenticate with Vault using the JWT/OIDC authentication method.</p>
  5061. </td>
  5062. </tr>
  5063. <tr>
  5064. <td>
  5065. <code>kubernetesServiceAccountToken</code></br>
  5066. <em>
  5067. <a href="#external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">
  5068. VaultKubernetesServiceAccountTokenAuth
  5069. </a>
  5070. </em>
  5071. </td>
  5072. <td>
  5073. <em>(Optional)</em>
  5074. <p>Optional ServiceAccountToken specifies the Kubernetes service account for which to request
  5075. a token for with the <code>TokenRequest</code> API.</p>
  5076. </td>
  5077. </tr>
  5078. </tbody>
  5079. </table>
  5080. <h3 id="external-secrets.io/v1beta1.VaultKVStoreVersion">VaultKVStoreVersion
  5081. (<code>string</code> alias)</p></h3>
  5082. <p>
  5083. (<em>Appears on:</em>
  5084. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  5085. </p>
  5086. <p>
  5087. </p>
  5088. <table>
  5089. <thead>
  5090. <tr>
  5091. <th>Value</th>
  5092. <th>Description</th>
  5093. </tr>
  5094. </thead>
  5095. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  5096. <td></td>
  5097. </tr><tr><td><p>&#34;v2&#34;</p></td>
  5098. <td></td>
  5099. </tr></tbody>
  5100. </table>
  5101. <h3 id="external-secrets.io/v1beta1.VaultKubernetesAuth">VaultKubernetesAuth
  5102. </h3>
  5103. <p>
  5104. (<em>Appears on:</em>
  5105. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  5106. </p>
  5107. <p>
  5108. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  5109. a Secret.</p>
  5110. </p>
  5111. <table>
  5112. <thead>
  5113. <tr>
  5114. <th>Field</th>
  5115. <th>Description</th>
  5116. </tr>
  5117. </thead>
  5118. <tbody>
  5119. <tr>
  5120. <td>
  5121. <code>mountPath</code></br>
  5122. <em>
  5123. string
  5124. </em>
  5125. </td>
  5126. <td>
  5127. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  5128. &ldquo;kubernetes&rdquo;</p>
  5129. </td>
  5130. </tr>
  5131. <tr>
  5132. <td>
  5133. <code>serviceAccountRef</code></br>
  5134. <em>
  5135. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  5136. </em>
  5137. </td>
  5138. <td>
  5139. <em>(Optional)</em>
  5140. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  5141. If the service account is specified, the service account secret token JWT will be used
  5142. for authenticating with Vault. If the service account selector is not supplied,
  5143. the secretRef will be used instead.</p>
  5144. </td>
  5145. </tr>
  5146. <tr>
  5147. <td>
  5148. <code>secretRef</code></br>
  5149. <em>
  5150. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  5151. </em>
  5152. </td>
  5153. <td>
  5154. <em>(Optional)</em>
  5155. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  5156. for authenticating with Vault. If a name is specified without a key,
  5157. <code>token</code> is the default. If one is not specified, the one bound to
  5158. the controller will be used.</p>
  5159. </td>
  5160. </tr>
  5161. <tr>
  5162. <td>
  5163. <code>role</code></br>
  5164. <em>
  5165. string
  5166. </em>
  5167. </td>
  5168. <td>
  5169. <p>A required field containing the Vault Role to assume. A Role binds a
  5170. Kubernetes ServiceAccount with a set of Vault policies.</p>
  5171. </td>
  5172. </tr>
  5173. </tbody>
  5174. </table>
  5175. <h3 id="external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">VaultKubernetesServiceAccountTokenAuth
  5176. </h3>
  5177. <p>
  5178. (<em>Appears on:</em>
  5179. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth</a>)
  5180. </p>
  5181. <p>
  5182. <p>VaultKubernetesServiceAccountTokenAuth authenticates with Vault using a temporary
  5183. Kubernetes service account token retrieved by the <code>TokenRequest</code> API.</p>
  5184. </p>
  5185. <table>
  5186. <thead>
  5187. <tr>
  5188. <th>Field</th>
  5189. <th>Description</th>
  5190. </tr>
  5191. </thead>
  5192. <tbody>
  5193. <tr>
  5194. <td>
  5195. <code>serviceAccountRef</code></br>
  5196. <em>
  5197. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  5198. </em>
  5199. </td>
  5200. <td>
  5201. <p>Service account field containing the name of a kubernetes ServiceAccount.</p>
  5202. </td>
  5203. </tr>
  5204. <tr>
  5205. <td>
  5206. <code>audiences</code></br>
  5207. <em>
  5208. []string
  5209. </em>
  5210. </td>
  5211. <td>
  5212. <em>(Optional)</em>
  5213. <p>Optional audiences field that will be used to request a temporary Kubernetes service
  5214. account token for the service account referenced by <code>serviceAccountRef</code>.
  5215. Defaults to a single audience <code>vault</code> it not specified.</p>
  5216. </td>
  5217. </tr>
  5218. <tr>
  5219. <td>
  5220. <code>expirationSeconds</code></br>
  5221. <em>
  5222. int64
  5223. </em>
  5224. </td>
  5225. <td>
  5226. <em>(Optional)</em>
  5227. <p>Optional expiration time in seconds that will be used to request a temporary
  5228. Kubernetes service account token for the service account referenced by
  5229. <code>serviceAccountRef</code>.
  5230. Defaults to 10 minutes.</p>
  5231. </td>
  5232. </tr>
  5233. </tbody>
  5234. </table>
  5235. <h3 id="external-secrets.io/v1beta1.VaultLdapAuth">VaultLdapAuth
  5236. </h3>
  5237. <p>
  5238. (<em>Appears on:</em>
  5239. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  5240. </p>
  5241. <p>
  5242. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  5243. with the username and password stored in a Kubernetes Secret resource.</p>
  5244. </p>
  5245. <table>
  5246. <thead>
  5247. <tr>
  5248. <th>Field</th>
  5249. <th>Description</th>
  5250. </tr>
  5251. </thead>
  5252. <tbody>
  5253. <tr>
  5254. <td>
  5255. <code>path</code></br>
  5256. <em>
  5257. string
  5258. </em>
  5259. </td>
  5260. <td>
  5261. <p>Path where the LDAP authentication backend is mounted
  5262. in Vault, e.g: &ldquo;ldap&rdquo;</p>
  5263. </td>
  5264. </tr>
  5265. <tr>
  5266. <td>
  5267. <code>username</code></br>
  5268. <em>
  5269. string
  5270. </em>
  5271. </td>
  5272. <td>
  5273. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  5274. authentication method</p>
  5275. </td>
  5276. </tr>
  5277. <tr>
  5278. <td>
  5279. <code>secretRef</code></br>
  5280. <em>
  5281. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  5282. </em>
  5283. </td>
  5284. <td>
  5285. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  5286. user used to authenticate with Vault using the LDAP authentication
  5287. method</p>
  5288. </td>
  5289. </tr>
  5290. </tbody>
  5291. </table>
  5292. <h3 id="external-secrets.io/v1beta1.VaultProvider">VaultProvider
  5293. </h3>
  5294. <p>
  5295. (<em>Appears on:</em>
  5296. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5297. </p>
  5298. <p>
  5299. <p>Configures an store to sync secrets using a HashiCorp Vault
  5300. KV backend.</p>
  5301. </p>
  5302. <table>
  5303. <thead>
  5304. <tr>
  5305. <th>Field</th>
  5306. <th>Description</th>
  5307. </tr>
  5308. </thead>
  5309. <tbody>
  5310. <tr>
  5311. <td>
  5312. <code>auth</code></br>
  5313. <em>
  5314. <a href="#external-secrets.io/v1beta1.VaultAuth">
  5315. VaultAuth
  5316. </a>
  5317. </em>
  5318. </td>
  5319. <td>
  5320. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  5321. </td>
  5322. </tr>
  5323. <tr>
  5324. <td>
  5325. <code>server</code></br>
  5326. <em>
  5327. string
  5328. </em>
  5329. </td>
  5330. <td>
  5331. <p>Server is the connection address for the Vault server, e.g: &ldquo;<a href="https://vault.example.com:8200&quot;">https://vault.example.com:8200&rdquo;</a>.</p>
  5332. </td>
  5333. </tr>
  5334. <tr>
  5335. <td>
  5336. <code>path</code></br>
  5337. <em>
  5338. string
  5339. </em>
  5340. </td>
  5341. <td>
  5342. <em>(Optional)</em>
  5343. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  5344. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  5345. for fetching secrets from Vault is optional and will be appended
  5346. if not present in specified path.</p>
  5347. </td>
  5348. </tr>
  5349. <tr>
  5350. <td>
  5351. <code>version</code></br>
  5352. <em>
  5353. <a href="#external-secrets.io/v1beta1.VaultKVStoreVersion">
  5354. VaultKVStoreVersion
  5355. </a>
  5356. </em>
  5357. </td>
  5358. <td>
  5359. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  5360. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  5361. </td>
  5362. </tr>
  5363. <tr>
  5364. <td>
  5365. <code>namespace</code></br>
  5366. <em>
  5367. string
  5368. </em>
  5369. </td>
  5370. <td>
  5371. <em>(Optional)</em>
  5372. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  5373. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  5374. 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>
  5375. </td>
  5376. </tr>
  5377. <tr>
  5378. <td>
  5379. <code>caBundle</code></br>
  5380. <em>
  5381. []byte
  5382. </em>
  5383. </td>
  5384. <td>
  5385. <em>(Optional)</em>
  5386. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  5387. if the Server URL is using HTTPS protocol. This parameter is ignored for
  5388. plain HTTP protocol connection. If not set the system root certificates
  5389. are used to validate the TLS connection.</p>
  5390. </td>
  5391. </tr>
  5392. <tr>
  5393. <td>
  5394. <code>caProvider</code></br>
  5395. <em>
  5396. <a href="#external-secrets.io/v1beta1.CAProvider">
  5397. CAProvider
  5398. </a>
  5399. </em>
  5400. </td>
  5401. <td>
  5402. <em>(Optional)</em>
  5403. <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
  5404. </td>
  5405. </tr>
  5406. <tr>
  5407. <td>
  5408. <code>readYourWrites</code></br>
  5409. <em>
  5410. bool
  5411. </em>
  5412. </td>
  5413. <td>
  5414. <em>(Optional)</em>
  5415. <p>ReadYourWrites ensures isolated read-after-write semantics by
  5416. providing discovered cluster replication states in each request.
  5417. More information about eventual consistency in Vault can be found here
  5418. <a href="https://www.vaultproject.io/docs/enterprise/consistency">https://www.vaultproject.io/docs/enterprise/consistency</a></p>
  5419. </td>
  5420. </tr>
  5421. <tr>
  5422. <td>
  5423. <code>forwardInconsistent</code></br>
  5424. <em>
  5425. bool
  5426. </em>
  5427. </td>
  5428. <td>
  5429. <em>(Optional)</em>
  5430. <p>ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
  5431. leader instead of simply retrying within a loop. This can increase performance if
  5432. the option is enabled serverside.
  5433. <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>
  5434. </td>
  5435. </tr>
  5436. </tbody>
  5437. </table>
  5438. <h3 id="external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider
  5439. </h3>
  5440. <p>
  5441. (<em>Appears on:</em>
  5442. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  5443. </p>
  5444. <p>
  5445. <p>Defines a location to fetch the cert for the webhook provider from.</p>
  5446. </p>
  5447. <table>
  5448. <thead>
  5449. <tr>
  5450. <th>Field</th>
  5451. <th>Description</th>
  5452. </tr>
  5453. </thead>
  5454. <tbody>
  5455. <tr>
  5456. <td>
  5457. <code>type</code></br>
  5458. <em>
  5459. <a href="#external-secrets.io/v1beta1.WebhookCAProviderType">
  5460. WebhookCAProviderType
  5461. </a>
  5462. </em>
  5463. </td>
  5464. <td>
  5465. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  5466. </td>
  5467. </tr>
  5468. <tr>
  5469. <td>
  5470. <code>name</code></br>
  5471. <em>
  5472. string
  5473. </em>
  5474. </td>
  5475. <td>
  5476. <p>The name of the object located at the provider type.</p>
  5477. </td>
  5478. </tr>
  5479. <tr>
  5480. <td>
  5481. <code>key</code></br>
  5482. <em>
  5483. string
  5484. </em>
  5485. </td>
  5486. <td>
  5487. <p>The key the value inside of the provider type to use, only used with &ldquo;Secret&rdquo; type</p>
  5488. </td>
  5489. </tr>
  5490. <tr>
  5491. <td>
  5492. <code>namespace</code></br>
  5493. <em>
  5494. string
  5495. </em>
  5496. </td>
  5497. <td>
  5498. <em>(Optional)</em>
  5499. <p>The namespace the Provider type is in.</p>
  5500. </td>
  5501. </tr>
  5502. </tbody>
  5503. </table>
  5504. <h3 id="external-secrets.io/v1beta1.WebhookCAProviderType">WebhookCAProviderType
  5505. (<code>string</code> alias)</p></h3>
  5506. <p>
  5507. (<em>Appears on:</em>
  5508. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider</a>)
  5509. </p>
  5510. <p>
  5511. </p>
  5512. <table>
  5513. <thead>
  5514. <tr>
  5515. <th>Value</th>
  5516. <th>Description</th>
  5517. </tr>
  5518. </thead>
  5519. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  5520. <td></td>
  5521. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  5522. <td></td>
  5523. </tr></tbody>
  5524. </table>
  5525. <h3 id="external-secrets.io/v1beta1.WebhookProvider">WebhookProvider
  5526. </h3>
  5527. <p>
  5528. (<em>Appears on:</em>
  5529. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5530. </p>
  5531. <p>
  5532. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  5533. </p>
  5534. <table>
  5535. <thead>
  5536. <tr>
  5537. <th>Field</th>
  5538. <th>Description</th>
  5539. </tr>
  5540. </thead>
  5541. <tbody>
  5542. <tr>
  5543. <td>
  5544. <code>method</code></br>
  5545. <em>
  5546. string
  5547. </em>
  5548. </td>
  5549. <td>
  5550. <p>Webhook Method</p>
  5551. </td>
  5552. </tr>
  5553. <tr>
  5554. <td>
  5555. <code>url</code></br>
  5556. <em>
  5557. string
  5558. </em>
  5559. </td>
  5560. <td>
  5561. <p>Webhook url to call</p>
  5562. </td>
  5563. </tr>
  5564. <tr>
  5565. <td>
  5566. <code>headers</code></br>
  5567. <em>
  5568. map[string]string
  5569. </em>
  5570. </td>
  5571. <td>
  5572. <em>(Optional)</em>
  5573. <p>Headers</p>
  5574. </td>
  5575. </tr>
  5576. <tr>
  5577. <td>
  5578. <code>body</code></br>
  5579. <em>
  5580. string
  5581. </em>
  5582. </td>
  5583. <td>
  5584. <em>(Optional)</em>
  5585. <p>Body</p>
  5586. </td>
  5587. </tr>
  5588. <tr>
  5589. <td>
  5590. <code>timeout</code></br>
  5591. <em>
  5592. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  5593. Kubernetes meta/v1.Duration
  5594. </a>
  5595. </em>
  5596. </td>
  5597. <td>
  5598. <em>(Optional)</em>
  5599. <p>Timeout</p>
  5600. </td>
  5601. </tr>
  5602. <tr>
  5603. <td>
  5604. <code>result</code></br>
  5605. <em>
  5606. <a href="#external-secrets.io/v1beta1.WebhookResult">
  5607. WebhookResult
  5608. </a>
  5609. </em>
  5610. </td>
  5611. <td>
  5612. <p>Result formatting</p>
  5613. </td>
  5614. </tr>
  5615. <tr>
  5616. <td>
  5617. <code>secrets</code></br>
  5618. <em>
  5619. <a href="#external-secrets.io/v1beta1.WebhookSecret">
  5620. []WebhookSecret
  5621. </a>
  5622. </em>
  5623. </td>
  5624. <td>
  5625. <em>(Optional)</em>
  5626. <p>Secrets to fill in templates
  5627. These secrets will be passed to the templating function as key value pairs under the given name</p>
  5628. </td>
  5629. </tr>
  5630. <tr>
  5631. <td>
  5632. <code>caBundle</code></br>
  5633. <em>
  5634. []byte
  5635. </em>
  5636. </td>
  5637. <td>
  5638. <em>(Optional)</em>
  5639. <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
  5640. if the Server URL is using HTTPS protocol. This parameter is ignored for
  5641. plain HTTP protocol connection. If not set the system root certificates
  5642. are used to validate the TLS connection.</p>
  5643. </td>
  5644. </tr>
  5645. <tr>
  5646. <td>
  5647. <code>caProvider</code></br>
  5648. <em>
  5649. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">
  5650. WebhookCAProvider
  5651. </a>
  5652. </em>
  5653. </td>
  5654. <td>
  5655. <em>(Optional)</em>
  5656. <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
  5657. </td>
  5658. </tr>
  5659. </tbody>
  5660. </table>
  5661. <h3 id="external-secrets.io/v1beta1.WebhookResult">WebhookResult
  5662. </h3>
  5663. <p>
  5664. (<em>Appears on:</em>
  5665. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  5666. </p>
  5667. <p>
  5668. </p>
  5669. <table>
  5670. <thead>
  5671. <tr>
  5672. <th>Field</th>
  5673. <th>Description</th>
  5674. </tr>
  5675. </thead>
  5676. <tbody>
  5677. <tr>
  5678. <td>
  5679. <code>jsonPath</code></br>
  5680. <em>
  5681. string
  5682. </em>
  5683. </td>
  5684. <td>
  5685. <em>(Optional)</em>
  5686. <p>Json path of return value</p>
  5687. </td>
  5688. </tr>
  5689. </tbody>
  5690. </table>
  5691. <h3 id="external-secrets.io/v1beta1.WebhookSecret">WebhookSecret
  5692. </h3>
  5693. <p>
  5694. (<em>Appears on:</em>
  5695. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  5696. </p>
  5697. <p>
  5698. </p>
  5699. <table>
  5700. <thead>
  5701. <tr>
  5702. <th>Field</th>
  5703. <th>Description</th>
  5704. </tr>
  5705. </thead>
  5706. <tbody>
  5707. <tr>
  5708. <td>
  5709. <code>name</code></br>
  5710. <em>
  5711. string
  5712. </em>
  5713. </td>
  5714. <td>
  5715. <p>Name of this secret in templates</p>
  5716. </td>
  5717. </tr>
  5718. <tr>
  5719. <td>
  5720. <code>secretRef</code></br>
  5721. <em>
  5722. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  5723. </em>
  5724. </td>
  5725. <td>
  5726. <p>Secret ref to fill in credentials</p>
  5727. </td>
  5728. </tr>
  5729. </tbody>
  5730. </table>
  5731. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerAuth">YandexCertificateManagerAuth
  5732. </h3>
  5733. <p>
  5734. (<em>Appears on:</em>
  5735. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  5736. </p>
  5737. <p>
  5738. </p>
  5739. <table>
  5740. <thead>
  5741. <tr>
  5742. <th>Field</th>
  5743. <th>Description</th>
  5744. </tr>
  5745. </thead>
  5746. <tbody>
  5747. <tr>
  5748. <td>
  5749. <code>authorizedKeySecretRef</code></br>
  5750. <em>
  5751. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  5752. </em>
  5753. </td>
  5754. <td>
  5755. <em>(Optional)</em>
  5756. <p>The authorized key used for authentication</p>
  5757. </td>
  5758. </tr>
  5759. </tbody>
  5760. </table>
  5761. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">YandexCertificateManagerCAProvider
  5762. </h3>
  5763. <p>
  5764. (<em>Appears on:</em>
  5765. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  5766. </p>
  5767. <p>
  5768. </p>
  5769. <table>
  5770. <thead>
  5771. <tr>
  5772. <th>Field</th>
  5773. <th>Description</th>
  5774. </tr>
  5775. </thead>
  5776. <tbody>
  5777. <tr>
  5778. <td>
  5779. <code>certSecretRef</code></br>
  5780. <em>
  5781. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  5782. </em>
  5783. </td>
  5784. <td>
  5785. </td>
  5786. </tr>
  5787. </tbody>
  5788. </table>
  5789. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider
  5790. </h3>
  5791. <p>
  5792. (<em>Appears on:</em>
  5793. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5794. </p>
  5795. <p>
  5796. <p>YandexCertificateManagerProvider Configures a store to sync secrets using the Yandex Certificate Manager provider.</p>
  5797. </p>
  5798. <table>
  5799. <thead>
  5800. <tr>
  5801. <th>Field</th>
  5802. <th>Description</th>
  5803. </tr>
  5804. </thead>
  5805. <tbody>
  5806. <tr>
  5807. <td>
  5808. <code>apiEndpoint</code></br>
  5809. <em>
  5810. string
  5811. </em>
  5812. </td>
  5813. <td>
  5814. <em>(Optional)</em>
  5815. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  5816. </td>
  5817. </tr>
  5818. <tr>
  5819. <td>
  5820. <code>auth</code></br>
  5821. <em>
  5822. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerAuth">
  5823. YandexCertificateManagerAuth
  5824. </a>
  5825. </em>
  5826. </td>
  5827. <td>
  5828. <p>Auth defines the information necessary to authenticate against Yandex Certificate Manager</p>
  5829. </td>
  5830. </tr>
  5831. <tr>
  5832. <td>
  5833. <code>caProvider</code></br>
  5834. <em>
  5835. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">
  5836. YandexCertificateManagerCAProvider
  5837. </a>
  5838. </em>
  5839. </td>
  5840. <td>
  5841. <em>(Optional)</em>
  5842. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  5843. </td>
  5844. </tr>
  5845. </tbody>
  5846. </table>
  5847. <h3 id="external-secrets.io/v1beta1.YandexLockboxAuth">YandexLockboxAuth
  5848. </h3>
  5849. <p>
  5850. (<em>Appears on:</em>
  5851. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  5852. </p>
  5853. <p>
  5854. </p>
  5855. <table>
  5856. <thead>
  5857. <tr>
  5858. <th>Field</th>
  5859. <th>Description</th>
  5860. </tr>
  5861. </thead>
  5862. <tbody>
  5863. <tr>
  5864. <td>
  5865. <code>authorizedKeySecretRef</code></br>
  5866. <em>
  5867. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  5868. </em>
  5869. </td>
  5870. <td>
  5871. <em>(Optional)</em>
  5872. <p>The authorized key used for authentication</p>
  5873. </td>
  5874. </tr>
  5875. </tbody>
  5876. </table>
  5877. <h3 id="external-secrets.io/v1beta1.YandexLockboxCAProvider">YandexLockboxCAProvider
  5878. </h3>
  5879. <p>
  5880. (<em>Appears on:</em>
  5881. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  5882. </p>
  5883. <p>
  5884. </p>
  5885. <table>
  5886. <thead>
  5887. <tr>
  5888. <th>Field</th>
  5889. <th>Description</th>
  5890. </tr>
  5891. </thead>
  5892. <tbody>
  5893. <tr>
  5894. <td>
  5895. <code>certSecretRef</code></br>
  5896. <em>
  5897. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  5898. </em>
  5899. </td>
  5900. <td>
  5901. </td>
  5902. </tr>
  5903. </tbody>
  5904. </table>
  5905. <h3 id="external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider
  5906. </h3>
  5907. <p>
  5908. (<em>Appears on:</em>
  5909. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5910. </p>
  5911. <p>
  5912. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
  5913. </p>
  5914. <table>
  5915. <thead>
  5916. <tr>
  5917. <th>Field</th>
  5918. <th>Description</th>
  5919. </tr>
  5920. </thead>
  5921. <tbody>
  5922. <tr>
  5923. <td>
  5924. <code>apiEndpoint</code></br>
  5925. <em>
  5926. string
  5927. </em>
  5928. </td>
  5929. <td>
  5930. <em>(Optional)</em>
  5931. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  5932. </td>
  5933. </tr>
  5934. <tr>
  5935. <td>
  5936. <code>auth</code></br>
  5937. <em>
  5938. <a href="#external-secrets.io/v1beta1.YandexLockboxAuth">
  5939. YandexLockboxAuth
  5940. </a>
  5941. </em>
  5942. </td>
  5943. <td>
  5944. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
  5945. </td>
  5946. </tr>
  5947. <tr>
  5948. <td>
  5949. <code>caProvider</code></br>
  5950. <em>
  5951. <a href="#external-secrets.io/v1beta1.YandexLockboxCAProvider">
  5952. YandexLockboxCAProvider
  5953. </a>
  5954. </em>
  5955. </td>
  5956. <td>
  5957. <em>(Optional)</em>
  5958. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  5959. </td>
  5960. </tr>
  5961. </tbody>
  5962. </table>
  5963. <hr/>
  5964. <p><em>
  5965. Generated with <code>gen-crd-api-reference-docs</code>.
  5966. </em></p>
  5967. </article>
  5968. </div>
  5969. </div>
  5970. </main>
  5971. <footer class="md-footer">
  5972. <nav class="md-footer__inner md-grid" aria-label="Footer">
  5973. <a href="../eso-blogs/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Blogs" rel="prev">
  5974. <div class="md-footer__button md-icon">
  5975. <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>
  5976. </div>
  5977. <div class="md-footer__title">
  5978. <div class="md-ellipsis">
  5979. <span class="md-footer__direction">
  5980. Previous
  5981. </span>
  5982. Blogs
  5983. </div>
  5984. </div>
  5985. </a>
  5986. <a href="../contributing-devguide/" class="md-footer__link md-footer__link--next" aria-label="Next: Developer guide" rel="next">
  5987. <div class="md-footer__title">
  5988. <div class="md-ellipsis">
  5989. <span class="md-footer__direction">
  5990. Next
  5991. </span>
  5992. Developer guide
  5993. </div>
  5994. </div>
  5995. <div class="md-footer__button md-icon">
  5996. <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>
  5997. </div>
  5998. </a>
  5999. </nav>
  6000. <div class="md-footer-meta md-typeset">
  6001. <div class="md-footer-meta__inner md-grid">
  6002. <div class="md-copyright">
  6003. Made with
  6004. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  6005. Material for MkDocs
  6006. </a>
  6007. </div>
  6008. </div>
  6009. </div>
  6010. </footer>
  6011. </div>
  6012. <div class="md-dialog" data-md-component="dialog">
  6013. <div class="md-dialog__inner md-typeset"></div>
  6014. </div>
  6015. <script id="__config" type="application/json">{"base": "..", "features": [], "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>
  6016. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  6017. </body>
  6018. </html>