index.html 88 KB

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