index.html 90 KB

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