index.html 92 KB

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