index.html 125 KB

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