index.html 102 KB

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