index.html 80 KB

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