index.html 90 KB

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