index.html 118 KB

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