Kezdőlap Felfedezés Súgó
Bejelentkezés
logic855
/
helm-external-secrets
tükrözi: https://github.com/external-secrets/external-secrets
1
0
Másolás 0
Fájlok Problémák 0 Wiki
Fa: db52bb5109
Branch-ok Tag-ek
helm-external-s...
/
spec
/
index.html

index.html 71 KB
Előzmények Nyers

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566 
  1. 

  2. <!doctype html>
    3. 

  3. <html lang="en" class="no-js">
    4. 

  4.   <head>
    5. 

  5.     
    6. 

  6.       <meta charset="utf-8">
    7. 

  7.       <meta name="viewport" content="width=device-width,initial-scale=1">
    8. 

  8.       
    9. 

  9.       
    10. 

  10.       
    11. 

  11.       
    12. 

  12.       <link rel="icon" href="../assets/images/favicon.png">
    13. 

  13.       <meta name="generator" content="mkdocs-1.1, mkdocs-material-7.1.8">
    14. 

  14.     
    15. 

  15.     
    16. 

  16.       
    17. 

  17.         <title>API specification - External Secrets Operator</title>
    18. 

  18.       
    19. 

  19.     
    20. 

  20.     
    21. 

  21.       <link rel="stylesheet" href="../assets/stylesheets/main.ca7ac06f.min.css">
    22. 

  22.       
    23. 

  23.         
    24. 

  24.         <link rel="stylesheet" href="../assets/stylesheets/palette.f1a3b89f.min.css">
    25. 

  25.         
    26. 

  26.       
    27. 

  27.     
    28. 

  28.     
    29. 

  29.     
    30. 

  30.       
    31. 

  31.         
    32. 

  32.         <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
    33. 

  33.         <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
    34. 

  34.         <style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
    35. 

  35.       
    36. 

  36.     
    37. 

  37.     
    38. 

  38.     
    39. 

  39.     
    40. 

  40.       
    41. 

  41. 

  42.   
    43. 

  43. 

  44. 

  45.   
    46. 

  46. 

  47.   
    48. 

  48. 

  49. 

  50.   <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>
    51. 

  51.   <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
    52. 

  52. 

  53. 

  54.     
    55. 

  55.     
    56. 

  56.   </head>
    57. 

  57.   
    58. 

  58.   
    59. 

  59.     
    60. 

  60.     
    61. 

  61.     
    62. 

  62.     
    63. 

  63.     
    64. 

  64.     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
    65. 

  65.   
    66. 

  66.     
    67. 

  67.     <script>function __prefix(e){return new URL("..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
    68. 

  68.     
    69. 

  69.     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    70. 

  70.     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    71. 

  71.     <label class="md-overlay" for="__drawer"></label>
    72. 

  72.     <div data-md-component="skip">
    73. 

  73.       
    74. 

  74.     </div>
    75. 

  75.     <div data-md-component="announce">
    76. 

  76.       
    77. 

  77.     </div>
    78. 

  78.     
    79. 

  79.       <header class="md-header" data-md-component="header">
    80. 

  80.   <nav class="md-header__inner md-grid" aria-label="Header">
    81. 

  81.     <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
    82. 

  82.       
    83. 

  83.   
    84. 

  84.   <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>
    85. 

  85. 

  86.     </a>
    87. 

  87.     <label class="md-header__button md-icon" for="__drawer">
    88. 

  88.       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
    89. 

  89.     </label>
    90. 

  90.     <div class="md-header__title" data-md-component="header-title">
    91. 

  91.       <div class="md-header__ellipsis">
    92. 

  92.         <div class="md-header__topic">
    93. 

  93.           <span class="md-ellipsis">
    94. 

  94.             External Secrets Operator
    95. 

  95.           </span>
    96. 

  96.         </div>
    97. 

  97.         <div class="md-header__topic" data-md-component="header-topic">
    98. 

  98.           <span class="md-ellipsis">
    99. 

  99.             
    100. 

  100.               API specification
    101. 

  101.             
    102. 

  102.           </span>
    103. 

  103.         </div>
    104. 

  104.       </div>
    105. 

  105.     </div>
    106. 

  106.     
    107. 

  107.     
    108. 

  108.     
    109. 

  109.       <label class="md-header__button md-icon" for="__search">
    110. 

  110.         <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>
    111. 

  111.       </label>
    112. 

  112.       
    113. 

  113. <div class="md-search" data-md-component="search" role="dialog">
    114. 

  114.   <label class="md-search__overlay" for="__search"></label>
    115. 

  115.   <div class="md-search__inner" role="search">
    116. 

  116.     <form class="md-search__form" name="search">
    117. 

  117.       <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>
    118. 

  118.       <label class="md-search__icon md-icon" for="__search">
    119. 

  119.         <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>
    120. 

  120.         <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>
    121. 

  121.       </label>
    122. 

  122.       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
    123. 

  123.         <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>
    124. 

  124.       </button>
    125. 

  125.     </form>
    126. 

  126.     <div class="md-search__output">
    127. 

  127.       <div class="md-search__scrollwrap" data-md-scrollfix>
    128. 

  128.         <div class="md-search-result" data-md-component="search-result">
    129. 

  129.           <div class="md-search-result__meta">
    130. 

  130.             Initializing search
    131. 

  131.           </div>
    132. 

  132.           <ol class="md-search-result__list"></ol>
    133. 

  133.         </div>
    134. 

  134.       </div>
    135. 

  135.     </div>
    136. 

  136.   </div>
    137. 

  137. </div>
    138. 

  138.     
    139. 

  139.     
    140. 

  140.       <div class="md-header__source">
    141. 

  141.         
    142. 

  142. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
    143. 

  143.   <div class="md-source__icon md-icon">
    144. 

  144.     
    145. 

  145.     <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>
    146. 

  146.   </div>
    147. 

  147.   <div class="md-source__repository">
    148. 

  148.     External Secrets Operator
    149. 

  149.   </div>
    150. 

  150. </a>
    151. 

  151.       </div>
    152. 

  152.     
    153. 

  153.   </nav>
    154. 

  154. </header>
    155. 

  155.     
    156. 

  156.     <div class="md-container" data-md-component="container">
    157. 

  157.       
    158. 

  158.       
    159. 

  159.         
    160. 

  160.       
    161. 

  161.       <main class="md-main" data-md-component="main">
    162. 

  162.         <div class="md-main__inner md-grid">
    163. 

  163.           
    164. 

  164.             
    165. 

  165.               
    166. 

  166.               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
    167. 

  167.                 <div class="md-sidebar__scrollwrap">
    168. 

  168.                   <div class="md-sidebar__inner">
    169. 

  169.                     
    170. 

  170. 

  171. 

  172. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
    173. 

  173.   <label class="md-nav__title" for="__drawer">
    174. 

  174.     <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
    175. 

  175.       
    176. 

  176.   
    177. 

  177.   <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>
    178. 

  178. 

  179.     </a>
    180. 

  180.     External Secrets Operator
    181. 

  181.   </label>
    182. 

  182.   
    183. 

  183.     <div class="md-nav__source">
    184. 

  184.       
    185. 

  185. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
    186. 

  186.   <div class="md-source__icon md-icon">
    187. 

  187.     
    188. 

  188.     <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>
    189. 

  189.   </div>
    190. 

  190.   <div class="md-source__repository">
    191. 

  191.     External Secrets Operator
    192. 

  192.   </div>
    193. 

  193. </a>
    194. 

  194.     </div>
    195. 

  195.   
    196. 

  196.   <ul class="md-nav__list" data-md-scrollfix>
    197. 

  197.     
    198. 

  198.       
    199. 

  199.       
    200. 

  200.       
    201. 

  201. 

  202.   
    203. 

  203.   
    204. 

  204.   
    205. 

  205.     <li class="md-nav__item">
    206. 

  206.       <a href=".." class="md-nav__link">
    207. 

  207.         Introduction
    208. 

  208.       </a>
    209. 

  209.     </li>
    210. 

  210.   
    211. 

  211. 

  212.     
    213. 

  213.       
    214. 

  214.       
    215. 

  215.       
    216. 

  216. 

  217.   
    218. 

  218.   
    219. 

  219.   
    220. 

  220.     <li class="md-nav__item">
    221. 

  221.       <a href="../api-overview/" class="md-nav__link">
    222. 

  222.         Overview
    223. 

  223.       </a>
    224. 

  224.     </li>
    225. 

  225.   
    226. 

  226. 

  227.     
    228. 

  228.       
    229. 

  229.       
    230. 

  230.       
    231. 

  231. 

  232.   
    233. 

  233.   
    234. 

  234.   
    235. 

  235.     
    236. 

  236.     <li class="md-nav__item md-nav__item--nested">
    237. 

  237.       
    238. 

  238.       
    239. 

  239.         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
    240. 

  240.       
    241. 

  241.       <label class="md-nav__link" for="__nav_3">
    242. 

  242.         API Types
    243. 

  243.         <span class="md-nav__icon md-icon"></span>
    244. 

  244.       </label>
    245. 

  245.       <nav class="md-nav" aria-label="API Types" data-md-level="1">
    246. 

  246.         <label class="md-nav__title" for="__nav_3">
    247. 

  247.           <span class="md-nav__icon md-icon"></span>
    248. 

  248.           API Types
    249. 

  249.         </label>
    250. 

  250.         <ul class="md-nav__list" data-md-scrollfix>
    251. 

  251.           
    252. 

  252.             
    253. 

  253.   
    254. 

  254.   
    255. 

  255.   
    256. 

  256.     <li class="md-nav__item">
    257. 

  257.       <a href="../api-externalsecret/" class="md-nav__link">
    258. 

  258.         ExternalSecret
    259. 

  259.       </a>
    260. 

  260.     </li>
    261. 

  261.   
    262. 

  262. 

  263.           
    264. 

  264.             
    265. 

  265.   
    266. 

  266.   
    267. 

  267.   
    268. 

  268.     <li class="md-nav__item">
    269. 

  269.       <a href="../api-secretstore/" class="md-nav__link">
    270. 

  270.         SecretStore
    271. 

  271.       </a>
    272. 

  272.     </li>
    273. 

  273.   
    274. 

  274. 

  275.           
    276. 

  276.             
    277. 

  277.   
    278. 

  278.   
    279. 

  279.   
    280. 

  280.     <li class="md-nav__item">
    281. 

  281.       <a href="../api-clustersecretstore/" class="md-nav__link">
    282. 

  282.         ClusterSecretStore
    283. 

  283.       </a>
    284. 

  284.     </li>
    285. 

  285.   
    286. 

  286. 

  287.           
    288. 

  288.         </ul>
    289. 

  289.       </nav>
    290. 

  290.     </li>
    291. 

  291.   
    292. 

  292. 

  293.     
    294. 

  294.       
    295. 

  295.       
    296. 

  296.       
    297. 

  297. 

  298.   
    299. 

  299.   
    300. 

  300.   
    301. 

  301.     
    302. 

  302.     <li class="md-nav__item md-nav__item--nested">
    303. 

  303.       
    304. 

  304.       
    305. 

  305.         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
    306. 

  306.       
    307. 

  307.       <label class="md-nav__link" for="__nav_4">
    308. 

  308.         Guides
    309. 

  309.         <span class="md-nav__icon md-icon"></span>
    310. 

  310.       </label>
    311. 

  311.       <nav class="md-nav" aria-label="Guides" data-md-level="1">
    312. 

  312.         <label class="md-nav__title" for="__nav_4">
    313. 

  313.           <span class="md-nav__icon md-icon"></span>
    314. 

  314.           Guides
    315. 

  315.         </label>
    316. 

  316.         <ul class="md-nav__list" data-md-scrollfix>
    317. 

  317.           
    318. 

  318.             
    319. 

  319.   
    320. 

  320.   
    321. 

  321.   
    322. 

  322.     <li class="md-nav__item">
    323. 

  323.       <a href="../guides-introduction/" class="md-nav__link">
    324. 

  324.         Introduction
    325. 

  325.       </a>
    326. 

  326.     </li>
    327. 

  327.   
    328. 

  328. 

  329.           
    330. 

  330.             
    331. 

  331.   
    332. 

  332.   
    333. 

  333.   
    334. 

  334.     <li class="md-nav__item">
    335. 

  335.       <a href="../guides-getting-started/" class="md-nav__link">
    336. 

  336.         Getting started
    337. 

  337.       </a>
    338. 

  338.     </li>
    339. 

  339.   
    340. 

  340. 

  341.           
    342. 

  342.             
    343. 

  343.   
    344. 

  344.   
    345. 

  345.   
    346. 

  346.     <li class="md-nav__item">
    347. 

  347.       <a href="../guides-templating/" class="md-nav__link">
    348. 

  348.         Advanced Templating
    349. 

  349.       </a>
    350. 

  350.     </li>
    351. 

  351.   
    352. 

  352. 

  353.           
    354. 

  354.             
    355. 

  355.   
    356. 

  356.   
    357. 

  357.   
    358. 

  358.     <li class="md-nav__item">
    359. 

  359.       <a href="../guides-all-keys-one-secret/" class="md-nav__link">
    360. 

  360.         All keys, One secret
    361. 

  361.       </a>
    362. 

  362.     </li>
    363. 

  363.   
    364. 

  364. 

  365.           
    366. 

  366.             
    367. 

  367.   
    368. 

  368.   
    369. 

  369.   
    370. 

  370.     <li class="md-nav__item">
    371. 

  371.       <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
    372. 

  372.         Common K8S Secret Types
    373. 

  373.       </a>
    374. 

  374.     </li>
    375. 

  375.   
    376. 

  376. 

  377.           
    378. 

  378.             
    379. 

  379.   
    380. 

  380.   
    381. 

  381.   
    382. 

  382.     <li class="md-nav__item">
    383. 

  383.       <a href="../guides-multi-tenancy/" class="md-nav__link">
    384. 

  384.         Multi Tenancy
    385. 

  385.       </a>
    386. 

  386.     </li>
    387. 

  387.   
    388. 

  388. 

  389.           
    390. 

  390.             
    391. 

  391.   
    392. 

  392.   
    393. 

  393.   
    394. 

  394.     <li class="md-nav__item">
    395. 

  395.       <a href="../guides-metrics/" class="md-nav__link">
    396. 

  396.         Metrics
    397. 

  397.       </a>
    398. 

  398.     </li>
    399. 

  399.   
    400. 

  400. 

  401.           
    402. 

  402.         </ul>
    403. 

  403.       </nav>
    404. 

  404.     </li>
    405. 

  405.   
    406. 

  406. 

  407.     
    408. 

  408.       
    409. 

  409.       
    410. 

  410.       
    411. 

  411. 

  412.   
    413. 

  413.   
    414. 

  414.   
    415. 

  415.     
    416. 

  416.     <li class="md-nav__item md-nav__item--nested">
    417. 

  417.       
    418. 

  418.       
    419. 

  419.         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
    420. 

  420.       
    421. 

  421.       <label class="md-nav__link" for="__nav_5">
    422. 

  422.         Provider
    423. 

  423.         <span class="md-nav__icon md-icon"></span>
    424. 

  424.       </label>
    425. 

  425.       <nav class="md-nav" aria-label="Provider" data-md-level="1">
    426. 

  426.         <label class="md-nav__title" for="__nav_5">
    427. 

  427.           <span class="md-nav__icon md-icon"></span>
    428. 

  428.           Provider
    429. 

  429.         </label>
    430. 

  430.         <ul class="md-nav__list" data-md-scrollfix>
    431. 

  431.           
    432. 

  432.             
    433. 

  433.   
    434. 

  434.   
    435. 

  435.   
    436. 

  436.     
    437. 

  437.     <li class="md-nav__item md-nav__item--nested">
    438. 

  438.       
    439. 

  439.       
    440. 

  440.         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
    441. 

  441.       
    442. 

  442.       <label class="md-nav__link" for="__nav_5_1">
    443. 

  443.         AWS
    444. 

  444.         <span class="md-nav__icon md-icon"></span>
    445. 

  445.       </label>
    446. 

  446.       <nav class="md-nav" aria-label="AWS" data-md-level="2">
    447. 

  447.         <label class="md-nav__title" for="__nav_5_1">
    448. 

  448.           <span class="md-nav__icon md-icon"></span>
    449. 

  449.           AWS
    450. 

  450.         </label>
    451. 

  451.         <ul class="md-nav__list" data-md-scrollfix>
    452. 

  452.           
    453. 

  453.             
    454. 

  454.   
    455. 

  455.   
    456. 

  456.   
    457. 

  457.     <li class="md-nav__item">
    458. 

  458.       <a href="../provider-aws-secrets-manager/" class="md-nav__link">
    459. 

  459.         Secrets Manager
    460. 

  460.       </a>
    461. 

  461.     </li>
    462. 

  462.   
    463. 

  463. 

  464.           
    465. 

  465.             
    466. 

  466.   
    467. 

  467.   
    468. 

  468.   
    469. 

  469.     <li class="md-nav__item">
    470. 

  470.       <a href="../provider-aws-parameter-store/" class="md-nav__link">
    471. 

  471.         Parameter Store
    472. 

  472.       </a>
    473. 

  473.     </li>
    474. 

  474.   
    475. 

  475. 

  476.           
    477. 

  477.         </ul>
    478. 

  478.       </nav>
    479. 

  479.     </li>
    480. 

  480.   
    481. 

  481. 

  482.           
    483. 

  483.             
    484. 

  484.   
    485. 

  485.   
    486. 

  486.   
    487. 

  487.     
    488. 

  488.     <li class="md-nav__item md-nav__item--nested">
    489. 

  489.       
    490. 

  490.       
    491. 

  491.         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
    492. 

  492.       
    493. 

  493.       <label class="md-nav__link" for="__nav_5_2">
    494. 

  494.         Azure
    495. 

  495.         <span class="md-nav__icon md-icon"></span>
    496. 

  496.       </label>
    497. 

  497.       <nav class="md-nav" aria-label="Azure" data-md-level="2">
    498. 

  498.         <label class="md-nav__title" for="__nav_5_2">
    499. 

  499.           <span class="md-nav__icon md-icon"></span>
    500. 

  500.           Azure
    501. 

  501.         </label>
    502. 

  502.         <ul class="md-nav__list" data-md-scrollfix>
    503. 

  503.           
    504. 

  504.             
    505. 

  505.   
    506. 

  506.   
    507. 

  507.   
    508. 

  508.     <li class="md-nav__item">
    509. 

  509.       <a href="../provider-azure-key-vault/" class="md-nav__link">
    510. 

  510.         Key Vault
    511. 

  511.       </a>
    512. 

  512.     </li>
    513. 

  513.   
    514. 

  514. 

  515.           
    516. 

  516.         </ul>
    517. 

  517.       </nav>
    518. 

  518.     </li>
    519. 

  519.   
    520. 

  520. 

  521.           
    522. 

  522.             
    523. 

  523.   
    524. 

  524.   
    525. 

  525.   
    526. 

  526.     
    527. 

  527.     <li class="md-nav__item md-nav__item--nested">
    528. 

  528.       
    529. 

  529.       
    530. 

  530.         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
    531. 

  531.       
    532. 

  532.       <label class="md-nav__link" for="__nav_5_3">
    533. 

  533.         Google
    534. 

  534.         <span class="md-nav__icon md-icon"></span>
    535. 

  535.       </label>
    536. 

  536.       <nav class="md-nav" aria-label="Google" data-md-level="2">
    537. 

  537.         <label class="md-nav__title" for="__nav_5_3">
    538. 

  538.           <span class="md-nav__icon md-icon"></span>
    539. 

  539.           Google
    540. 

  540.         </label>
    541. 

  541.         <ul class="md-nav__list" data-md-scrollfix>
    542. 

  542.           
    543. 

  543.             
    544. 

  544.   
    545. 

  545.   
    546. 

  546.   
    547. 

  547.     <li class="md-nav__item">
    548. 

  548.       <a href="../provider-google-secrets-manager/" class="md-nav__link">
    549. 

  549.         Secrets Manager
    550. 

  550.       </a>
    551. 

  551.     </li>
    552. 

  552.   
    553. 

  553. 

  554.           
    555. 

  555.         </ul>
    556. 

  556.       </nav>
    557. 

  557.     </li>
    558. 

  558.   
    559. 

  559. 

  560.           
    561. 

  561.             
    562. 

  562.   
    563. 

  563.   
    564. 

  564.   
    565. 

  565.     
    566. 

  566.     <li class="md-nav__item md-nav__item--nested">
    567. 

  567.       
    568. 

  568.       
    569. 

  569.         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
    570. 

  570.       
    571. 

  571.       <label class="md-nav__link" for="__nav_5_4">
    572. 

  572.         IBM
    573. 

  573.         <span class="md-nav__icon md-icon"></span>
    574. 

  574.       </label>
    575. 

  575.       <nav class="md-nav" aria-label="IBM" data-md-level="2">
    576. 

  576.         <label class="md-nav__title" for="__nav_5_4">
    577. 

  577.           <span class="md-nav__icon md-icon"></span>
    578. 

  578.           IBM
    579. 

  579.         </label>
    580. 

  580.         <ul class="md-nav__list" data-md-scrollfix>
    581. 

  581.           
    582. 

  582.             
    583. 

  583.   
    584. 

  584.   
    585. 

  585.   
    586. 

  586.     <li class="md-nav__item">
    587. 

  587.       <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
    588. 

  588.         Secrets Manager
    589. 

  589.       </a>
    590. 

  590.     </li>
    591. 

  591.   
    592. 

  592. 

  593.           
    594. 

  594.         </ul>
    595. 

  595.       </nav>
    596. 

  596.     </li>
    597. 

  597.   
    598. 

  598. 

  599.           
    600. 

  600.             
    601. 

  601.   
    602. 

  602.   
    603. 

  603.   
    604. 

  604.     <li class="md-nav__item">
    605. 

  605.       <a href="../provider-hashicorp-vault/" class="md-nav__link">
    606. 

  606.         HashiCorp Vault
    607. 

  607.       </a>
    608. 

  608.     </li>
    609. 

  609.   
    610. 

  610. 

  611.           
    612. 

  612.             
    613. 

  613.   
    614. 

  614.   
    615. 

  615.   
    616. 

  616.     
    617. 

  617.     <li class="md-nav__item md-nav__item--nested">
    618. 

  618.       
    619. 

  619.       
    620. 

  620.         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_6" type="checkbox" id="__nav_5_6" >
    621. 

  621.       
    622. 

  622.       <label class="md-nav__link" for="__nav_5_6">
    623. 

  623.         Yandex
    624. 

  624.         <span class="md-nav__icon md-icon"></span>
    625. 

  625.       </label>
    626. 

  626.       <nav class="md-nav" aria-label="Yandex" data-md-level="2">
    627. 

  627.         <label class="md-nav__title" for="__nav_5_6">
    628. 

  628.           <span class="md-nav__icon md-icon"></span>
    629. 

  629.           Yandex
    630. 

  630.         </label>
    631. 

  631.         <ul class="md-nav__list" data-md-scrollfix>
    632. 

  632.           
    633. 

  633.             
    634. 

  634.   
    635. 

  635.   
    636. 

  636.   
    637. 

  637.     <li class="md-nav__item">
    638. 

  638.       <a href="../provider-yandex-lockbox/" class="md-nav__link">
    639. 

  639.         Lockbox
    640. 

  640.       </a>
    641. 

  641.     </li>
    642. 

  642.   
    643. 

  643. 

  644.           
    645. 

  645.         </ul>
    646. 

  646.       </nav>
    647. 

  647.     </li>
    648. 

  648.   
    649. 

  649. 

  650.           
    651. 

  651.             
    652. 

  652.   
    653. 

  653.   
    654. 

  654.   
    655. 

  655.     
    656. 

  656.     <li class="md-nav__item md-nav__item--nested">
    657. 

  657.       
    658. 

  658.       
    659. 

  659.         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
    660. 

  660.       
    661. 

  661.       <label class="md-nav__link" for="__nav_5_7">
    662. 

  662.         Gitlab
    663. 

  663.         <span class="md-nav__icon md-icon"></span>
    664. 

  664.       </label>
    665. 

  665.       <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
    666. 

  666.         <label class="md-nav__title" for="__nav_5_7">
    667. 

  667.           <span class="md-nav__icon md-icon"></span>
    668. 

  668.           Gitlab
    669. 

  669.         </label>
    670. 

  670.         <ul class="md-nav__list" data-md-scrollfix>
    671. 

  671.           
    672. 

  672.             
    673. 

  673.   
    674. 

  674.   
    675. 

  675.   
    676. 

  676.     <li class="md-nav__item">
    677. 

  677.       <a href="../provider-gitlab-project-variables/" class="md-nav__link">
    678. 

  678.         Gitlab Project Variables
    679. 

  679.       </a>
    680. 

  680.     </li>
    681. 

  681.   
    682. 

  682. 

  683.           
    684. 

  684.         </ul>
    685. 

  685.       </nav>
    686. 

  686.     </li>
    687. 

  687.   
    688. 

  688. 

  689.           
    690. 

  690.         </ul>
    691. 

  691.       </nav>
    692. 

  692.     </li>
    693. 

  693.   
    694. 

  694. 

  695.     
    696. 

  696.       
    697. 

  697.       
    698. 

  698.       
    699. 

  699. 

  700.   
    701. 

  701.   
    702. 

  702.     
    703. 

  703.   
    704. 

  704.   
    705. 

  705.     
    706. 

  706.     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
    707. 

  707.       
    708. 

  708.       
    709. 

  709.         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
    710. 

  710.       
    711. 

  711.       <label class="md-nav__link" for="__nav_6">
    712. 

  712.         References
    713. 

  713.         <span class="md-nav__icon md-icon"></span>
    714. 

  714.       </label>
    715. 

  715.       <nav class="md-nav" aria-label="References" data-md-level="1">
    716. 

  716.         <label class="md-nav__title" for="__nav_6">
    717. 

  717.           <span class="md-nav__icon md-icon"></span>
    718. 

  718.           References
    719. 

  719.         </label>
    720. 

  720.         <ul class="md-nav__list" data-md-scrollfix>
    721. 

  721.           
    722. 

  722.             
    723. 

  723.   
    724. 

  724.   
    725. 

  725.     
    726. 

  726.   
    727. 

  727.   
    728. 

  728.     <li class="md-nav__item md-nav__item--active">
    729. 

  729.       
    730. 

  730.       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
    731. 

  731.       
    732. 

  732.       
    733. 

  733.       
    734. 

  734.       <a href="./" class="md-nav__link md-nav__link--active">
    735. 

  735.         API specification
    736. 

  736.       </a>
    737. 

  737.       
    738. 

  738.     </li>
    739. 

  739.   
    740. 

  740. 

  741.           
    742. 

  742.         </ul>
    743. 

  743.       </nav>
    744. 

  744.     </li>
    745. 

  745.   
    746. 

  746. 

  747.     
    748. 

  748.       
    749. 

  749.       
    750. 

  750.       
    751. 

  751. 

  752.   
    753. 

  753.   
    754. 

  754.   
    755. 

  755.     
    756. 

  756.     <li class="md-nav__item md-nav__item--nested">
    757. 

  757.       
    758. 

  758.       
    759. 

  759.         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
    760. 

  760.       
    761. 

  761.       <label class="md-nav__link" for="__nav_7">
    762. 

  762.         Contributing
    763. 

  763.         <span class="md-nav__icon md-icon"></span>
    764. 

  764.       </label>
    765. 

  765.       <nav class="md-nav" aria-label="Contributing" data-md-level="1">
    766. 

  766.         <label class="md-nav__title" for="__nav_7">
    767. 

  767.           <span class="md-nav__icon md-icon"></span>
    768. 

  768.           Contributing
    769. 

  769.         </label>
    770. 

  770.         <ul class="md-nav__list" data-md-scrollfix>
    771. 

  771.           
    772. 

  772.             
    773. 

  773.   
    774. 

  774.   
    775. 

  775.   
    776. 

  776.     <li class="md-nav__item">
    777. 

  777.       <a href="../contributing-devguide/" class="md-nav__link">
    778. 

  778.         Developer guide
    779. 

  779.       </a>
    780. 

  780.     </li>
    781. 

  781.   
    782. 

  782. 

  783.           
    784. 

  784.             
    785. 

  785.   
    786. 

  786.   
    787. 

  787.   
    788. 

  788.     <li class="md-nav__item">
    789. 

  789.       <a href="../contributing-process/" class="md-nav__link">
    790. 

  790.         Contributing Process
    791. 

  791.       </a>
    792. 

  792.     </li>
    793. 

  793.   
    794. 

  794. 

  795.           
    796. 

  796.             
    797. 

  797.   
    798. 

  798.   
    799. 

  799.   
    800. 

  800.     <li class="md-nav__item">
    801. 

  801.       <a href="../contributing-coc/" class="md-nav__link">
    802. 

  802.         Code of Conduct
    803. 

  803.       </a>
    804. 

  804.     </li>
    805. 

  805.   
    806. 

  806. 

  807.           
    808. 

  808.         </ul>
    809. 

  809.       </nav>
    810. 

  810.     </li>
    811. 

  811.   
    812. 

  812. 

  813.     
    814. 

  814.       
    815. 

  815.       
    816. 

  816.       
    817. 

  817. 

  818.   
    819. 

  819.   
    820. 

  820.   
    821. 

  821.     <li class="md-nav__item">
    822. 

  822.       <a href="../deprecation-policy/" class="md-nav__link">
    823. 

  823.         Deprecation Policy
    824. 

  824.       </a>
    825. 

  825.     </li>
    826. 

  826.   
    827. 

  827. 

  828.     
    829. 

  829.   </ul>
    830. 

  830. </nav>
    831. 

  831.                   </div>
    832. 

  832.                 </div>
    833. 

  833.               </div>
    834. 

  834.             
    835. 

  835.             
    836. 

  836.           
    837. 

  837.           <div class="md-content" data-md-component="content">
    838. 

  838.             <article class="md-content__inner md-typeset">
    839. 

  839.               
    840. 

  840.                 
    841. 

  841.                   <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/spec.md" title="Edit this page" class="md-content__button md-icon">
    842. 

  842.                     <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>
    843. 

  843.                   </a>
    844. 

  844.                 
    845. 

  845.                 
    846. 

  846.                   <h1>API specification</h1>
    847. 

  847.                 
    848. 

  848.                 <p>Packages:</p>
    849. 

  849. 

  850. <ul>
    851. 

  851. <li>
    852. 

  852. <a href="#external-secrets.io%2fv1alpha1">external-secrets.io/v1alpha1</a>
    853. 

  853. </li>
    854. 

  854. </ul>
    855. 

  855. 

  856. <h2 id="external-secrets.io/v1alpha1">external-secrets.io/v1alpha1</h2>
    857. 

  857. 

  858. <p>
    859. 

  859. <p>Package v1alpha1 contains resources for external-secrets</p>
    860. 

  860. </p>
    861. 

  861. 

  862. <p>Resource Types:
    863. 

  863. <ul></ul>
    864. 

  864. <h3 id="external-secrets.io/v1alpha1.AWSAuth">AWSAuth
    865. 

  865. </h3>
    866. 

  866. <p>
    867. 

  867. (<em>Appears on:</em>
    868. 

  868. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
    869. 

  869. </p>
    870. 

  870. <p>
    871. 

  871. <p>AWSAuth tells the controller how to do authentication with aws.
    872. 

  872. Only one of secretRef or jwt can be specified.
    873. 

  873. if none is specified the controller will load credentials using the aws sdk defaults.</p>
    874. 

  874. </p>
    875. 

  875. <table>
    876. 

  876. <thead>
    877. 

  877. <tr>
    878. 

  878. <th>Field</th>
    879. 

  879. <th>Description</th>
    880. 

  880. </tr>
    881. 

  881. </thead>
    882. 

  882. <tbody>
    883. 

  883. <tr>
    884. 

  884. <td>
    885. 

  885. <code>secretRef</code></br>
    886. 

  886. <em>
    887. 

  887. <a href="#external-secrets.io/v1alpha1.AWSAuthSecretRef">
    888. 

  888. AWSAuthSecretRef
    889. 

  889. </a>
    890. 

  890. </em>
    891. 

  891. </td>
    892. 

  892. <td>
    893. 

  893. <em>(Optional)</em>
    894. 

  894. </td>
    895. 

  895. </tr>
    896. 

  896. <tr>
    897. 

  897. <td>
    898. 

  898. <code>jwt</code></br>
    899. 

  899. <em>
    900. 

  900. <a href="#external-secrets.io/v1alpha1.AWSJWTAuth">
    901. 

  901. AWSJWTAuth
    902. 

  902. </a>
    903. 

  903. </em>
    904. 

  904. </td>
    905. 

  905. <td>
    906. 

  906. <em>(Optional)</em>
    907. 

  907. </td>
    908. 

  908. </tr>
    909. 

  909. </tbody>
    910. 

  910. </table>
    911. 

  911. <h3 id="external-secrets.io/v1alpha1.AWSAuthSecretRef">AWSAuthSecretRef
    912. 

  912. </h3>
    913. 

  913. <p>
    914. 

  914. (<em>Appears on:</em>
    915. 

  915. <a href="#external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
    916. 

  916. </p>
    917. 

  917. <p>
    918. 

  918. <p>AWSAuthSecretRef holds secret references for AWS credentials
    919. 

  919. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
    920. 

  920. </p>
    921. 

  921. <table>
    922. 

  922. <thead>
    923. 

  923. <tr>
    924. 

  924. <th>Field</th>
    925. 

  925. <th>Description</th>
    926. 

  926. </tr>
    927. 

  927. </thead>
    928. 

  928. <tbody>
    929. 

  929. <tr>
    930. 

  930. <td>
    931. 

  931. <code>accessKeyIDSecretRef</code></br>
    932. 

  932. <em>
    933. 

  933. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    934. 

  934. </em>
    935. 

  935. </td>
    936. 

  936. <td>
    937. 

  937. <p>The AccessKeyID is used for authentication</p>
    938. 

  938. </td>
    939. 

  939. </tr>
    940. 

  940. <tr>
    941. 

  941. <td>
    942. 

  942. <code>secretAccessKeySecretRef</code></br>
    943. 

  943. <em>
    944. 

  944. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    945. 

  945. </em>
    946. 

  946. </td>
    947. 

  947. <td>
    948. 

  948. <p>The SecretAccessKey is used for authentication</p>
    949. 

  949. </td>
    950. 

  950. </tr>
    951. 

  951. </tbody>
    952. 

  952. </table>
    953. 

  953. <h3 id="external-secrets.io/v1alpha1.AWSJWTAuth">AWSJWTAuth
    954. 

  954. </h3>
    955. 

  955. <p>
    956. 

  956. (<em>Appears on:</em>
    957. 

  957. <a href="#external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
    958. 

  958. </p>
    959. 

  959. <p>
    960. 

  960. <p>Authenticate against AWS using service account tokens.</p>
    961. 

  961. </p>
    962. 

  962. <table>
    963. 

  963. <thead>
    964. 

  964. <tr>
    965. 

  965. <th>Field</th>
    966. 

  966. <th>Description</th>
    967. 

  967. </tr>
    968. 

  968. </thead>
    969. 

  969. <tbody>
    970. 

  970. <tr>
    971. 

  971. <td>
    972. 

  972. <code>serviceAccountRef</code></br>
    973. 

  973. <em>
    974. 

  974. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
    975. 

  975. </em>
    976. 

  976. </td>
    977. 

  977. <td>
    978. 

  978. </td>
    979. 

  979. </tr>
    980. 

  980. </tbody>
    981. 

  981. </table>
    982. 

  982. <h3 id="external-secrets.io/v1alpha1.AWSProvider">AWSProvider
    983. 

  983. </h3>
    984. 

  984. <p>
    985. 

  985. (<em>Appears on:</em>
    986. 

  986. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
    987. 

  987. </p>
    988. 

  988. <p>
    989. 

  989. <p>AWSProvider configures a store to sync secrets with AWS.</p>
    990. 

  990. </p>
    991. 

  991. <table>
    992. 

  992. <thead>
    993. 

  993. <tr>
    994. 

  994. <th>Field</th>
    995. 

  995. <th>Description</th>
    996. 

  996. </tr>
    997. 

  997. </thead>
    998. 

  998. <tbody>
    999. 

  999. <tr>
    1000. 

  1000. <td>
    1001. 

  1001. <code>service</code></br>
    1002. 

  1002. <em>
    1003. 

  1003. <a href="#external-secrets.io/v1alpha1.AWSServiceType">
    1004. 

  1004. AWSServiceType
    1005. 

  1005. </a>
    1006. 

  1006. </em>
    1007. 

  1007. </td>
    1008. 

  1008. <td>
    1009. 

  1009. <p>Service defines which service should be used to fetch the secrets</p>
    1010. 

  1010. </td>
    1011. 

  1011. </tr>
    1012. 

  1012. <tr>
    1013. 

  1013. <td>
    1014. 

  1014. <code>auth</code></br>
    1015. 

  1015. <em>
    1016. 

  1016. <a href="#external-secrets.io/v1alpha1.AWSAuth">
    1017. 

  1017. AWSAuth
    1018. 

  1018. </a>
    1019. 

  1019. </em>
    1020. 

  1020. </td>
    1021. 

  1021. <td>
    1022. 

  1022. <em>(Optional)</em>
    1023. 

  1023. <p>Auth defines the information necessary to authenticate against AWS
    1024. 

  1024. if not set aws sdk will infer credentials from your environment
    1025. 

  1025. 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>
    1026. 

  1026. </td>
    1027. 

  1027. </tr>
    1028. 

  1028. <tr>
    1029. 

  1029. <td>
    1030. 

  1030. <code>role</code></br>
    1031. 

  1031. <em>
    1032. 

  1032. string
    1033. 

  1033. </em>
    1034. 

  1034. </td>
    1035. 

  1035. <td>
    1036. 

  1036. <em>(Optional)</em>
    1037. 

  1037. <p>Role is a Role ARN which the SecretManager provider will assume</p>
    1038. 

  1038. </td>
    1039. 

  1039. </tr>
    1040. 

  1040. <tr>
    1041. 

  1041. <td>
    1042. 

  1042. <code>region</code></br>
    1043. 

  1043. <em>
    1044. 

  1044. string
    1045. 

  1045. </em>
    1046. 

  1046. </td>
    1047. 

  1047. <td>
    1048. 

  1048. <p>AWS Region to be used for the provider</p>
    1049. 

  1049. </td>
    1050. 

  1050. </tr>
    1051. 

  1051. </tbody>
    1052. 

  1052. </table>
    1053. 

  1053. <h3 id="external-secrets.io/v1alpha1.AWSServiceType">AWSServiceType
    1054. 

  1054. (<code>string</code> alias)</p></h3>
    1055. 

  1055. <p>
    1056. 

  1056. (<em>Appears on:</em>
    1057. 

  1057. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
    1058. 

  1058. </p>
    1059. 

  1059. <p>
    1060. 

  1060. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
    1061. 

  1061. </p>
    1062. 

  1062. <table>
    1063. 

  1063. <thead>
    1064. 

  1064. <tr>
    1065. 

  1065. <th>Value</th>
    1066. 

  1066. <th>Description</th>
    1067. 

  1067. </tr>
    1068. 

  1068. </thead>
    1069. 

  1069. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
    1070. 

  1070. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore.
    1071. 

  1071. 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>
    1072. 

  1072. </td>
    1073. 

  1073. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
    1074. 

  1074. <td><p>AWSServiceSecretsManager is the AWS SecretsManager.
    1075. 

  1075. 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>
    1076. 

  1076. </td>
    1077. 

  1077. </tr></tbody>
    1078. 

  1078. </table>
    1079. 

  1079. <h3 id="external-secrets.io/v1alpha1.AlibabaAuth">AlibabaAuth
    1080. 

  1080. </h3>
    1081. 

  1081. <p>
    1082. 

  1082. (<em>Appears on:</em>
    1083. 

  1083. <a href="#external-secrets.io/v1alpha1.AlibabaProvider">AlibabaProvider</a>)
    1084. 

  1084. </p>
    1085. 

  1085. <p>
    1086. 

  1086. <p>AlibabaAuth contains a secretRef for credentials.</p>
    1087. 

  1087. </p>
    1088. 

  1088. <table>
    1089. 

  1089. <thead>
    1090. 

  1090. <tr>
    1091. 

  1091. <th>Field</th>
    1092. 

  1092. <th>Description</th>
    1093. 

  1093. </tr>
    1094. 

  1094. </thead>
    1095. 

  1095. <tbody>
    1096. 

  1096. <tr>
    1097. 

  1097. <td>
    1098. 

  1098. <code>secretRef</code></br>
    1099. 

  1099. <em>
    1100. 

  1100. <a href="#external-secrets.io/v1alpha1.AlibabaAuthSecretRef">
    1101. 

  1101. AlibabaAuthSecretRef
    1102. 

  1102. </a>
    1103. 

  1103. </em>
    1104. 

  1104. </td>
    1105. 

  1105. <td>
    1106. 

  1106. </td>
    1107. 

  1107. </tr>
    1108. 

  1108. </tbody>
    1109. 

  1109. </table>
    1110. 

  1110. <h3 id="external-secrets.io/v1alpha1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
    1111. 

  1111. </h3>
    1112. 

  1112. <p>
    1113. 

  1113. (<em>Appears on:</em>
    1114. 

  1114. <a href="#external-secrets.io/v1alpha1.AlibabaAuth">AlibabaAuth</a>)
    1115. 

  1115. </p>
    1116. 

  1116. <p>
    1117. 

  1117. <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
    1118. 

  1118. </p>
    1119. 

  1119. <table>
    1120. 

  1120. <thead>
    1121. 

  1121. <tr>
    1122. 

  1122. <th>Field</th>
    1123. 

  1123. <th>Description</th>
    1124. 

  1124. </tr>
    1125. 

  1125. </thead>
    1126. 

  1126. <tbody>
    1127. 

  1127. <tr>
    1128. 

  1128. <td>
    1129. 

  1129. <code>accessKeyIDSecretRef</code></br>
    1130. 

  1130. <em>
    1131. 

  1131. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    1132. 

  1132. </em>
    1133. 

  1133. </td>
    1134. 

  1134. <td>
    1135. 

  1135. <p>The AccessKeyID is used for authentication</p>
    1136. 

  1136. </td>
    1137. 

  1137. </tr>
    1138. 

  1138. <tr>
    1139. 

  1139. <td>
    1140. 

  1140. <code>accessKeySecretSecretRef</code></br>
    1141. 

  1141. <em>
    1142. 

  1142. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    1143. 

  1143. </em>
    1144. 

  1144. </td>
    1145. 

  1145. <td>
    1146. 

  1146. <p>The AccessKeySecret is used for authentication</p>
    1147. 

  1147. </td>
    1148. 

  1148. </tr>
    1149. 

  1149. </tbody>
    1150. 

  1150. </table>
    1151. 

  1151. <h3 id="external-secrets.io/v1alpha1.AlibabaProvider">AlibabaProvider
    1152. 

  1152. </h3>
    1153. 

  1153. <p>
    1154. 

  1154. (<em>Appears on:</em>
    1155. 

  1155. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
    1156. 

  1156. </p>
    1157. 

  1157. <p>
    1158. 

  1158. <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
    1159. 

  1159. </p>
    1160. 

  1160. <table>
    1161. 

  1161. <thead>
    1162. 

  1162. <tr>
    1163. 

  1163. <th>Field</th>
    1164. 

  1164. <th>Description</th>
    1165. 

  1165. </tr>
    1166. 

  1166. </thead>
    1167. 

  1167. <tbody>
    1168. 

  1168. <tr>
    1169. 

  1169. <td>
    1170. 

  1170. <code>auth</code></br>
    1171. 

  1171. <em>
    1172. 

  1172. <a href="#external-secrets.io/v1alpha1.AlibabaAuth">
    1173. 

  1173. AlibabaAuth
    1174. 

  1174. </a>
    1175. 

  1175. </em>
    1176. 

  1176. </td>
    1177. 

  1177. <td>
    1178. 

  1178. </td>
    1179. 

  1179. </tr>
    1180. 

  1180. <tr>
    1181. 

  1181. <td>
    1182. 

  1182. <code>endpoint</code></br>
    1183. 

  1183. <em>
    1184. 

  1184. string
    1185. 

  1185. </em>
    1186. 

  1186. </td>
    1187. 

  1187. <td>
    1188. 

  1188. <em>(Optional)</em>
    1189. 

  1189. </td>
    1190. 

  1190. </tr>
    1191. 

  1191. <tr>
    1192. 

  1192. <td>
    1193. 

  1193. <code>regionID</code></br>
    1194. 

  1194. <em>
    1195. 

  1195. string
    1196. 

  1196. </em>
    1197. 

  1197. </td>
    1198. 

  1198. <td>
    1199. 

  1199. <p>Alibaba Region to be used for the provider</p>
    1200. 

  1200. </td>
    1201. 

  1201. </tr>
    1202. 

  1202. </tbody>
    1203. 

  1203. </table>
    1204. 

  1204. <h3 id="external-secrets.io/v1alpha1.AzureKVAuth">AzureKVAuth
    1205. 

  1205. </h3>
    1206. 

  1206. <p>
    1207. 

  1207. (<em>Appears on:</em>
    1208. 

  1208. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider</a>)
    1209. 

  1209. </p>
    1210. 

  1210. <p>
    1211. 

  1211. <p>Configuration used to authenticate with Azure.</p>
    1212. 

  1212. </p>
    1213. 

  1213. <table>
    1214. 

  1214. <thead>
    1215. 

  1215. <tr>
    1216. 

  1216. <th>Field</th>
    1217. 

  1217. <th>Description</th>
    1218. 

  1218. </tr>
    1219. 

  1219. </thead>
    1220. 

  1220. <tbody>
    1221. 

  1221. <tr>
    1222. 

  1222. <td>
    1223. 

  1223. <code>clientId</code></br>
    1224. 

  1224. <em>
    1225. 

  1225. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    1226. 

  1226. </em>
    1227. 

  1227. </td>
    1228. 

  1228. <td>
    1229. 

  1229. <p>The Azure clientId of the service principle used for authentication.</p>
    1230. 

  1230. </td>
    1231. 

  1231. </tr>
    1232. 

  1232. <tr>
    1233. 

  1233. <td>
    1234. 

  1234. <code>clientSecret</code></br>
    1235. 

  1235. <em>
    1236. 

  1236. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    1237. 

  1237. </em>
    1238. 

  1238. </td>
    1239. 

  1239. <td>
    1240. 

  1240. <p>The Azure ClientSecret of the service principle used for authentication.</p>
    1241. 

  1241. </td>
    1242. 

  1242. </tr>
    1243. 

  1243. </tbody>
    1244. 

  1244. </table>
    1245. 

  1245. <h3 id="external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider
    1246. 

  1246. </h3>
    1247. 

  1247. <p>
    1248. 

  1248. (<em>Appears on:</em>
    1249. 

  1249. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
    1250. 

  1250. </p>
    1251. 

  1251. <p>
    1252. 

  1252. <p>Configures an store to sync secrets using Azure KV.</p>
    1253. 

  1253. </p>
    1254. 

  1254. <table>
    1255. 

  1255. <thead>
    1256. 

  1256. <tr>
    1257. 

  1257. <th>Field</th>
    1258. 

  1258. <th>Description</th>
    1259. 

  1259. </tr>
    1260. 

  1260. </thead>
    1261. 

  1261. <tbody>
    1262. 

  1262. <tr>
    1263. 

  1263. <td>
    1264. 

  1264. <code>vaultUrl</code></br>
    1265. 

  1265. <em>
    1266. 

  1266. string
    1267. 

  1267. </em>
    1268. 

  1268. </td>
    1269. 

  1269. <td>
    1270. 

  1270. <p>Vault Url from which the secrets to be fetched from.</p>
    1271. 

  1271. </td>
    1272. 

  1272. </tr>
    1273. 

  1273. <tr>
    1274. 

  1274. <td>
    1275. 

  1275. <code>tenantId</code></br>
    1276. 

  1276. <em>
    1277. 

  1277. string
    1278. 

  1278. </em>
    1279. 

  1279. </td>
    1280. 

  1280. <td>
    1281. 

  1281. <p>TenantID configures the Azure Tenant to send requests to.</p>
    1282. 

  1282. </td>
    1283. 

  1283. </tr>
    1284. 

  1284. <tr>
    1285. 

  1285. <td>
    1286. 

  1286. <code>authSecretRef</code></br>
    1287. 

  1287. <em>
    1288. 

  1288. <a href="#external-secrets.io/v1alpha1.AzureKVAuth">
    1289. 

  1289. AzureKVAuth
    1290. 

  1290. </a>
    1291. 

  1291. </em>
    1292. 

  1292. </td>
    1293. 

  1293. <td>
    1294. 

  1294. <p>Auth configures how the operator authenticates with Azure.</p>
    1295. 

  1295. </td>
    1296. 

  1296. </tr>
    1297. 

  1297. </tbody>
    1298. 

  1298. </table>
    1299. 

  1299. <h3 id="external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore
    1300. 

  1300. </h3>
    1301. 

  1301. <p>
    1302. 

  1302. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
    1303. 

  1303. </p>
    1304. 

  1304. <table>
    1305. 

  1305. <thead>
    1306. 

  1306. <tr>
    1307. 

  1307. <th>Field</th>
    1308. 

  1308. <th>Description</th>
    1309. 

  1309. </tr>
    1310. 

  1310. </thead>
    1311. 

  1311. <tbody>
    1312. 

  1312. <tr>
    1313. 

  1313. <td>
    1314. 

  1314. <code>metadata</code></br>
    1315. 

  1315. <em>
    1316. 

  1316. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
    1317. 

  1317. Kubernetes meta/v1.ObjectMeta
    1318. 

  1318. </a>
    1319. 

  1319. </em>
    1320. 

  1320. </td>
    1321. 

  1321. <td>
    1322. 

  1322. Refer to the Kubernetes API documentation for the fields of the
    1323. 

  1323. <code>metadata</code> field.
    1324. 

  1324. </td>
    1325. 

  1325. </tr>
    1326. 

  1326. <tr>
    1327. 

  1327. <td>
    1328. 

  1328. <code>spec</code></br>
    1329. 

  1329. <em>
    1330. 

  1330. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
    1331. 

  1331. SecretStoreSpec
    1332. 

  1332. </a>
    1333. 

  1333. </em>
    1334. 

  1334. </td>
    1335. 

  1335. <td>
    1336. 

  1336. <br/>
    1337. 

  1337. <br/>
    1338. 

  1338. <table>
    1339. 

  1339. <tr>
    1340. 

  1340. <td>
    1341. 

  1341. <code>controller</code></br>
    1342. 

  1342. <em>
    1343. 

  1343. string
    1344. 

  1344. </em>
    1345. 

  1345. </td>
    1346. 

  1346. <td>
    1347. 

  1347. <em>(Optional)</em>
    1348. 

  1348. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
    1349. 

  1349. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
    1350. 

  1350. </td>
    1351. 

  1351. </tr>
    1352. 

  1352. <tr>
    1353. 

  1353. <td>
    1354. 

  1354. <code>provider</code></br>
    1355. 

  1355. <em>
    1356. 

  1356. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
    1357. 

  1357. SecretStoreProvider
    1358. 

  1358. </a>
    1359. 

  1359. </em>
    1360. 

  1360. </td>
    1361. 

  1361. <td>
    1362. 

  1362. <p>Used to configure the provider. Only one provider may be set</p>
    1363. 

  1363. </td>
    1364. 

  1364. </tr>
    1365. 

  1365. </table>
    1366. 

  1366. </td>
    1367. 

  1367. </tr>
    1368. 

  1368. <tr>
    1369. 

  1369. <td>
    1370. 

  1370. <code>status</code></br>
    1371. 

  1371. <em>
    1372. 

  1372. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
    1373. 

  1373. SecretStoreStatus
    1374. 

  1374. </a>
    1375. 

  1375. </em>
    1376. 

  1376. </td>
    1377. 

  1377. <td>
    1378. 

  1378. </td>
    1379. 

  1379. </tr>
    1380. 

  1380. </tbody>
    1381. 

  1381. </table>
    1382. 

  1382. <h3 id="external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret
    1383. 

  1383. </h3>
    1384. 

  1384. <p>
    1385. 

  1385. <p>ExternalSecret is the Schema for the external-secrets API.</p>
    1386. 

  1386. </p>
    1387. 

  1387. <table>
    1388. 

  1388. <thead>
    1389. 

  1389. <tr>
    1390. 

  1390. <th>Field</th>
    1391. 

  1391. <th>Description</th>
    1392. 

  1392. </tr>
    1393. 

  1393. </thead>
    1394. 

  1394. <tbody>
    1395. 

  1395. <tr>
    1396. 

  1396. <td>
    1397. 

  1397. <code>metadata</code></br>
    1398. 

  1398. <em>
    1399. 

  1399. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
    1400. 

  1400. Kubernetes meta/v1.ObjectMeta
    1401. 

  1401. </a>
    1402. 

  1402. </em>
    1403. 

  1403. </td>
    1404. 

  1404. <td>
    1405. 

  1405. Refer to the Kubernetes API documentation for the fields of the
    1406. 

  1406. <code>metadata</code> field.
    1407. 

  1407. </td>
    1408. 

  1408. </tr>
    1409. 

  1409. <tr>
    1410. 

  1410. <td>
    1411. 

  1411. <code>spec</code></br>
    1412. 

  1412. <em>
    1413. 

  1413. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">
    1414. 

  1414. ExternalSecretSpec
    1415. 

  1415. </a>
    1416. 

  1416. </em>
    1417. 

  1417. </td>
    1418. 

  1418. <td>
    1419. 

  1419. <br/>
    1420. 

  1420. <br/>
    1421. 

  1421. <table>
    1422. 

  1422. <tr>
    1423. 

  1423. <td>
    1424. 

  1424. <code>secretStoreRef</code></br>
    1425. 

  1425. <em>
    1426. 

  1426. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
    1427. 

  1427. SecretStoreRef
    1428. 

  1428. </a>
    1429. 

  1429. </em>
    1430. 

  1430. </td>
    1431. 

  1431. <td>
    1432. 

  1432. </td>
    1433. 

  1433. </tr>
    1434. 

  1434. <tr>
    1435. 

  1435. <td>
    1436. 

  1436. <code>target</code></br>
    1437. 

  1437. <em>
    1438. 

  1438. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
    1439. 

  1439. ExternalSecretTarget
    1440. 

  1440. </a>
    1441. 

  1441. </em>
    1442. 

  1442. </td>
    1443. 

  1443. <td>
    1444. 

  1444. </td>
    1445. 

  1445. </tr>
    1446. 

  1446. <tr>
    1447. 

  1447. <td>
    1448. 

  1448. <code>refreshInterval</code></br>
    1449. 

  1449. <em>
    1450. 

  1450. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
    1451. 

  1451. Kubernetes meta/v1.Duration
    1452. 

  1452. </a>
    1453. 

  1453. </em>
    1454. 

  1454. </td>
    1455. 

  1455. <td>
    1456. 

  1456. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
    1457. 

  1457. 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;
    1458. 

  1458. May be set to zero to fetch and create it once. Defaults to 1h.</p>
    1459. 

  1459. </td>
    1460. 

  1460. </tr>
    1461. 

  1461. <tr>
    1462. 

  1462. <td>
    1463. 

  1463. <code>data</code></br>
    1464. 

  1464. <em>
    1465. 

  1465. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
    1466. 

  1466. []ExternalSecretData
    1467. 

  1467. </a>
    1468. 

  1468. </em>
    1469. 

  1469. </td>
    1470. 

  1470. <td>
    1471. 

  1471. <em>(Optional)</em>
    1472. 

  1472. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
    1473. 

  1473. </td>
    1474. 

  1474. </tr>
    1475. 

  1475. <tr>
    1476. 

  1476. <td>
    1477. 

  1477. <code>dataFrom</code></br>
    1478. 

  1478. <em>
    1479. 

  1479. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
    1480. 

  1480. []ExternalSecretDataRemoteRef
    1481. 

  1481. </a>
    1482. 

  1482. </em>
    1483. 

  1483. </td>
    1484. 

  1484. <td>
    1485. 

  1485. <em>(Optional)</em>
    1486. 

  1486. <p>DataFrom is used to fetch all properties from a specific Provider data
    1487. 

  1487. If multiple entries are specified, the Secret keys are merged in the specified order</p>
    1488. 

  1488. </td>
    1489. 

  1489. </tr>
    1490. 

  1490. </table>
    1491. 

  1491. </td>
    1492. 

  1492. </tr>
    1493. 

  1493. <tr>
    1494. 

  1494. <td>
    1495. 

  1495. <code>status</code></br>
    1496. 

  1496. <em>
    1497. 

  1497. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">
    1498. 

  1498. ExternalSecretStatus
    1499. 

  1499. </a>
    1500. 

  1500. </em>
    1501. 

  1501. </td>
    1502. 

  1502. <td>
    1503. 

  1503. </td>
    1504. 

  1504. </tr>
    1505. 

  1505. </tbody>
    1506. 

  1506. </table>
    1507. 

  1507. <h3 id="external-secrets.io/v1alpha1.ExternalSecretConditionType">ExternalSecretConditionType
    1508. 

  1508. (<code>string</code> alias)</p></h3>
    1509. 

  1509. <p>
    1510. 

  1510. (<em>Appears on:</em>
    1511. 

  1511. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
    1512. 

  1512. </p>
    1513. 

  1513. <p>
    1514. 

  1514. </p>
    1515. 

  1515. <table>
    1516. 

  1516. <thead>
    1517. 

  1517. <tr>
    1518. 

  1518. <th>Value</th>
    1519. 

  1519. <th>Description</th>
    1520. 

  1520. </tr>
    1521. 

  1521. </thead>
    1522. 

  1522. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
    1523. 

  1523. <td></td>
    1524. 

  1524. </tr><tr><td><p>&#34;Ready&#34;</p></td>
    1525. 

  1525. <td></td>
    1526. 

  1526. </tr></tbody>
    1527. 

  1527. </table>
    1528. 

  1528. <h3 id="external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
    1529. 

  1529. (<code>string</code> alias)</p></h3>
    1530. 

  1530. <p>
    1531. 

  1531. (<em>Appears on:</em>
    1532. 

  1532. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
    1533. 

  1533. </p>
    1534. 

  1534. <p>
    1535. 

  1535. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
    1536. 

  1536. </p>
    1537. 

  1537. <table>
    1538. 

  1538. <thead>
    1539. 

  1539. <tr>
    1540. 

  1540. <th>Value</th>
    1541. 

  1541. <th>Description</th>
    1542. 

  1542. </tr>
    1543. 

  1543. </thead>
    1544. 

  1544. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
    1545. 

  1545. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
    1546. 

  1546. </td>
    1547. 

  1547. </tr><tr><td><p>&#34;None&#34;</p></td>
    1548. 

  1548. <td><p>None does not create a Secret (future use with injector).</p>
    1549. 

  1549. </td>
    1550. 

  1550. </tr><tr><td><p>&#34;Owner&#34;</p></td>
    1551. 

  1551. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
    1552. 

  1552. </td>
    1553. 

  1553. </tr></tbody>
    1554. 

  1554. </table>
    1555. 

  1555. <h3 id="external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData
    1556. 

  1556. </h3>
    1557. 

  1557. <p>
    1558. 

  1558. (<em>Appears on:</em>
    1559. 

  1559. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
    1560. 

  1560. </p>
    1561. 

  1561. <p>
    1562. 

  1562. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
    1563. 

  1563. </p>
    1564. 

  1564. <table>
    1565. 

  1565. <thead>
    1566. 

  1566. <tr>
    1567. 

  1567. <th>Field</th>
    1568. 

  1568. <th>Description</th>
    1569. 

  1569. </tr>
    1570. 

  1570. </thead>
    1571. 

  1571. <tbody>
    1572. 

  1572. <tr>
    1573. 

  1573. <td>
    1574. 

  1574. <code>secretKey</code></br>
    1575. 

  1575. <em>
    1576. 

  1576. string
    1577. 

  1577. </em>
    1578. 

  1578. </td>
    1579. 

  1579. <td>
    1580. 

  1580. </td>
    1581. 

  1581. </tr>
    1582. 

  1582. <tr>
    1583. 

  1583. <td>
    1584. 

  1584. <code>remoteRef</code></br>
    1585. 

  1585. <em>
    1586. 

  1586. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
    1587. 

  1587. ExternalSecretDataRemoteRef
    1588. 

  1588. </a>
    1589. 

  1589. </em>
    1590. 

  1590. </td>
    1591. 

  1591. <td>
    1592. 

  1592. </td>
    1593. 

  1593. </tr>
    1594. 

  1594. </tbody>
    1595. 

  1595. </table>
    1596. 

  1596. <h3 id="external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
    1597. 

  1597. </h3>
    1598. 

  1598. <p>
    1599. 

  1599. (<em>Appears on:</em>
    1600. 

  1600. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData</a>, 
    1601. 

  1601. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
    1602. 

  1602. </p>
    1603. 

  1603. <p>
    1604. 

  1604. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
    1605. 

  1605. </p>
    1606. 

  1606. <table>
    1607. 

  1607. <thead>
    1608. 

  1608. <tr>
    1609. 

  1609. <th>Field</th>
    1610. 

  1610. <th>Description</th>
    1611. 

  1611. </tr>
    1612. 

  1612. </thead>
    1613. 

  1613. <tbody>
    1614. 

  1614. <tr>
    1615. 

  1615. <td>
    1616. 

  1616. <code>key</code></br>
    1617. 

  1617. <em>
    1618. 

  1618. string
    1619. 

  1619. </em>
    1620. 

  1620. </td>
    1621. 

  1621. <td>
    1622. 

  1622. <p>Key is the key used in the Provider, mandatory</p>
    1623. 

  1623. </td>
    1624. 

  1624. </tr>
    1625. 

  1625. <tr>
    1626. 

  1626. <td>
    1627. 

  1627. <code>version</code></br>
    1628. 

  1628. <em>
    1629. 

  1629. string
    1630. 

  1630. </em>
    1631. 

  1631. </td>
    1632. 

  1632. <td>
    1633. 

  1633. <em>(Optional)</em>
    1634. 

  1634. <p>Used to select a specific version of the Provider value, if supported</p>
    1635. 

  1635. </td>
    1636. 

  1636. </tr>
    1637. 

  1637. <tr>
    1638. 

  1638. <td>
    1639. 

  1639. <code>property</code></br>
    1640. 

  1640. <em>
    1641. 

  1641. string
    1642. 

  1642. </em>
    1643. 

  1643. </td>
    1644. 

  1644. <td>
    1645. 

  1645. <em>(Optional)</em>
    1646. 

  1646. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
    1647. 

  1647. </td>
    1648. 

  1648. </tr>
    1649. 

  1649. </tbody>
    1650. 

  1650. </table>
    1651. 

  1651. <h3 id="external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec
    1652. 

  1652. </h3>
    1653. 

  1653. <p>
    1654. 

  1654. (<em>Appears on:</em>
    1655. 

  1655. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
    1656. 

  1656. </p>
    1657. 

  1657. <p>
    1658. 

  1658. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
    1659. 

  1659. </p>
    1660. 

  1660. <table>
    1661. 

  1661. <thead>
    1662. 

  1662. <tr>
    1663. 

  1663. <th>Field</th>
    1664. 

  1664. <th>Description</th>
    1665. 

  1665. </tr>
    1666. 

  1666. </thead>
    1667. 

  1667. <tbody>
    1668. 

  1668. <tr>
    1669. 

  1669. <td>
    1670. 

  1670. <code>secretStoreRef</code></br>
    1671. 

  1671. <em>
    1672. 

  1672. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
    1673. 

  1673. SecretStoreRef
    1674. 

  1674. </a>
    1675. 

  1675. </em>
    1676. 

  1676. </td>
    1677. 

  1677. <td>
    1678. 

  1678. </td>
    1679. 

  1679. </tr>
    1680. 

  1680. <tr>
    1681. 

  1681. <td>
    1682. 

  1682. <code>target</code></br>
    1683. 

  1683. <em>
    1684. 

  1684. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
    1685. 

  1685. ExternalSecretTarget
    1686. 

  1686. </a>
    1687. 

  1687. </em>
    1688. 

  1688. </td>
    1689. 

  1689. <td>
    1690. 

  1690. </td>
    1691. 

  1691. </tr>
    1692. 

  1692. <tr>
    1693. 

  1693. <td>
    1694. 

  1694. <code>refreshInterval</code></br>
    1695. 

  1695. <em>
    1696. 

  1696. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
    1697. 

  1697. Kubernetes meta/v1.Duration
    1698. 

  1698. </a>
    1699. 

  1699. </em>
    1700. 

  1700. </td>
    1701. 

  1701. <td>
    1702. 

  1702. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
    1703. 

  1703. 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;
    1704. 

  1704. May be set to zero to fetch and create it once. Defaults to 1h.</p>
    1705. 

  1705. </td>
    1706. 

  1706. </tr>
    1707. 

  1707. <tr>
    1708. 

  1708. <td>
    1709. 

  1709. <code>data</code></br>
    1710. 

  1710. <em>
    1711. 

  1711. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
    1712. 

  1712. []ExternalSecretData
    1713. 

  1713. </a>
    1714. 

  1714. </em>
    1715. 

  1715. </td>
    1716. 

  1716. <td>
    1717. 

  1717. <em>(Optional)</em>
    1718. 

  1718. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
    1719. 

  1719. </td>
    1720. 

  1720. </tr>
    1721. 

  1721. <tr>
    1722. 

  1722. <td>
    1723. 

  1723. <code>dataFrom</code></br>
    1724. 

  1724. <em>
    1725. 

  1725. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
    1726. 

  1726. []ExternalSecretDataRemoteRef
    1727. 

  1727. </a>
    1728. 

  1728. </em>
    1729. 

  1729. </td>
    1730. 

  1730. <td>
    1731. 

  1731. <em>(Optional)</em>
    1732. 

  1732. <p>DataFrom is used to fetch all properties from a specific Provider data
    1733. 

  1733. If multiple entries are specified, the Secret keys are merged in the specified order</p>
    1734. 

  1734. </td>
    1735. 

  1735. </tr>
    1736. 

  1736. </tbody>
    1737. 

  1737. </table>
    1738. 

  1738. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus
    1739. 

  1739. </h3>
    1740. 

  1740. <p>
    1741. 

  1741. (<em>Appears on:</em>
    1742. 

  1742. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
    1743. 

  1743. </p>
    1744. 

  1744. <p>
    1745. 

  1745. </p>
    1746. 

  1746. <table>
    1747. 

  1747. <thead>
    1748. 

  1748. <tr>
    1749. 

  1749. <th>Field</th>
    1750. 

  1750. <th>Description</th>
    1751. 

  1751. </tr>
    1752. 

  1752. </thead>
    1753. 

  1753. <tbody>
    1754. 

  1754. <tr>
    1755. 

  1755. <td>
    1756. 

  1756. <code>refreshTime</code></br>
    1757. 

  1757. <em>
    1758. 

  1758. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
    1759. 

  1759. Kubernetes meta/v1.Time
    1760. 

  1760. </a>
    1761. 

  1761. </em>
    1762. 

  1762. </td>
    1763. 

  1763. <td>
    1764. 

  1764. <p>refreshTime is the time and date the external secret was fetched and
    1765. 

  1765. the target secret updated</p>
    1766. 

  1766. </td>
    1767. 

  1767. </tr>
    1768. 

  1768. <tr>
    1769. 

  1769. <td>
    1770. 

  1770. <code>syncedResourceVersion</code></br>
    1771. 

  1771. <em>
    1772. 

  1772. string
    1773. 

  1773. </em>
    1774. 

  1774. </td>
    1775. 

  1775. <td>
    1776. 

  1776. <p>SyncedResourceVersion keeps track of the last synced version</p>
    1777. 

  1777. </td>
    1778. 

  1778. </tr>
    1779. 

  1779. <tr>
    1780. 

  1780. <td>
    1781. 

  1781. <code>conditions</code></br>
    1782. 

  1782. <em>
    1783. 

  1783. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">
    1784. 

  1784. []ExternalSecretStatusCondition
    1785. 

  1785. </a>
    1786. 

  1786. </em>
    1787. 

  1787. </td>
    1788. 

  1788. <td>
    1789. 

  1789. <em>(Optional)</em>
    1790. 

  1790. </td>
    1791. 

  1791. </tr>
    1792. 

  1792. </tbody>
    1793. 

  1793. </table>
    1794. 

  1794. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
    1795. 

  1795. </h3>
    1796. 

  1796. <p>
    1797. 

  1797. (<em>Appears on:</em>
    1798. 

  1798. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus</a>)
    1799. 

  1799. </p>
    1800. 

  1800. <p>
    1801. 

  1801. </p>
    1802. 

  1802. <table>
    1803. 

  1803. <thead>
    1804. 

  1804. <tr>
    1805. 

  1805. <th>Field</th>
    1806. 

  1806. <th>Description</th>
    1807. 

  1807. </tr>
    1808. 

  1808. </thead>
    1809. 

  1809. <tbody>
    1810. 

  1810. <tr>
    1811. 

  1811. <td>
    1812. 

  1812. <code>type</code></br>
    1813. 

  1813. <em>
    1814. 

  1814. <a href="#external-secrets.io/v1alpha1.ExternalSecretConditionType">
    1815. 

  1815. ExternalSecretConditionType
    1816. 

  1816. </a>
    1817. 

  1817. </em>
    1818. 

  1818. </td>
    1819. 

  1819. <td>
    1820. 

  1820. </td>
    1821. 

  1821. </tr>
    1822. 

  1822. <tr>
    1823. 

  1823. <td>
    1824. 

  1824. <code>status</code></br>
    1825. 

  1825. <em>
    1826. 

  1826. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
    1827. 

  1827. Kubernetes core/v1.ConditionStatus
    1828. 

  1828. </a>
    1829. 

  1829. </em>
    1830. 

  1830. </td>
    1831. 

  1831. <td>
    1832. 

  1832. </td>
    1833. 

  1833. </tr>
    1834. 

  1834. <tr>
    1835. 

  1835. <td>
    1836. 

  1836. <code>reason</code></br>
    1837. 

  1837. <em>
    1838. 

  1838. string
    1839. 

  1839. </em>
    1840. 

  1840. </td>
    1841. 

  1841. <td>
    1842. 

  1842. <em>(Optional)</em>
    1843. 

  1843. </td>
    1844. 

  1844. </tr>
    1845. 

  1845. <tr>
    1846. 

  1846. <td>
    1847. 

  1847. <code>message</code></br>
    1848. 

  1848. <em>
    1849. 

  1849. string
    1850. 

  1850. </em>
    1851. 

  1851. </td>
    1852. 

  1852. <td>
    1853. 

  1853. <em>(Optional)</em>
    1854. 

  1854. </td>
    1855. 

  1855. </tr>
    1856. 

  1856. <tr>
    1857. 

  1857. <td>
    1858. 

  1858. <code>lastTransitionTime</code></br>
    1859. 

  1859. <em>
    1860. 

  1860. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
    1861. 

  1861. Kubernetes meta/v1.Time
    1862. 

  1862. </a>
    1863. 

  1863. </em>
    1864. 

  1864. </td>
    1865. 

  1865. <td>
    1866. 

  1866. <em>(Optional)</em>
    1867. 

  1867. </td>
    1868. 

  1868. </tr>
    1869. 

  1869. </tbody>
    1870. 

  1870. </table>
    1871. 

  1871. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget
    1872. 

  1872. </h3>
    1873. 

  1873. <p>
    1874. 

  1874. (<em>Appears on:</em>
    1875. 

  1875. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
    1876. 

  1876. </p>
    1877. 

  1877. <p>
    1878. 

  1878. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
    1879. 

  1879. There can be only one target per ExternalSecret.</p>
    1880. 

  1880. </p>
    1881. 

  1881. <table>
    1882. 

  1882. <thead>
    1883. 

  1883. <tr>
    1884. 

  1884. <th>Field</th>
    1885. 

  1885. <th>Description</th>
    1886. 

  1886. </tr>
    1887. 

  1887. </thead>
    1888. 

  1888. <tbody>
    1889. 

  1889. <tr>
    1890. 

  1890. <td>
    1891. 

  1891. <code>name</code></br>
    1892. 

  1892. <em>
    1893. 

  1893. string
    1894. 

  1894. </em>
    1895. 

  1895. </td>
    1896. 

  1896. <td>
    1897. 

  1897. <em>(Optional)</em>
    1898. 

  1898. <p>Name defines the name of the Secret resource to be managed
    1899. 

  1899. This field is immutable
    1900. 

  1900. Defaults to the .metadata.name of the ExternalSecret resource</p>
    1901. 

  1901. </td>
    1902. 

  1902. </tr>
    1903. 

  1903. <tr>
    1904. 

  1904. <td>
    1905. 

  1905. <code>creationPolicy</code></br>
    1906. 

  1906. <em>
    1907. 

  1907. <a href="#external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">
    1908. 

  1908. ExternalSecretCreationPolicy
    1909. 

  1909. </a>
    1910. 

  1910. </em>
    1911. 

  1911. </td>
    1912. 

  1912. <td>
    1913. 

  1913. <em>(Optional)</em>
    1914. 

  1914. <p>CreationPolicy defines rules on how to create the resulting Secret
    1915. 

  1915. Defaults to &lsquo;Owner&rsquo;</p>
    1916. 

  1916. </td>
    1917. 

  1917. </tr>
    1918. 

  1918. <tr>
    1919. 

  1919. <td>
    1920. 

  1920. <code>template</code></br>
    1921. 

  1921. <em>
    1922. 

  1922. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">
    1923. 

  1923. ExternalSecretTemplate
    1924. 

  1924. </a>
    1925. 

  1925. </em>
    1926. 

  1926. </td>
    1927. 

  1927. <td>
    1928. 

  1928. <em>(Optional)</em>
    1929. 

  1929. <p>Template defines a blueprint for the created Secret resource.</p>
    1930. 

  1930. </td>
    1931. 

  1931. </tr>
    1932. 

  1932. </tbody>
    1933. 

  1933. </table>
    1934. 

  1934. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate
    1935. 

  1935. </h3>
    1936. 

  1936. <p>
    1937. 

  1937. (<em>Appears on:</em>
    1938. 

  1938. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
    1939. 

  1939. </p>
    1940. 

  1940. <p>
    1941. 

  1941. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
    1942. 

  1942. 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>
    1943. 

  1943. </p>
    1944. 

  1944. <table>
    1945. 

  1945. <thead>
    1946. 

  1946. <tr>
    1947. 

  1947. <th>Field</th>
    1948. 

  1948. <th>Description</th>
    1949. 

  1949. </tr>
    1950. 

  1950. </thead>
    1951. 

  1951. <tbody>
    1952. 

  1952. <tr>
    1953. 

  1953. <td>
    1954. 

  1954. <code>type</code></br>
    1955. 

  1955. <em>
    1956. 

  1956. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secrettype-v1-core">
    1957. 

  1957. Kubernetes core/v1.SecretType
    1958. 

  1958. </a>
    1959. 

  1959. </em>
    1960. 

  1960. </td>
    1961. 

  1961. <td>
    1962. 

  1962. <em>(Optional)</em>
    1963. 

  1963. </td>
    1964. 

  1964. </tr>
    1965. 

  1965. <tr>
    1966. 

  1966. <td>
    1967. 

  1967. <code>metadata</code></br>
    1968. 

  1968. <em>
    1969. 

  1969. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">
    1970. 

  1970. ExternalSecretTemplateMetadata
    1971. 

  1971. </a>
    1972. 

  1972. </em>
    1973. 

  1973. </td>
    1974. 

  1974. <td>
    1975. 

  1975. <em>(Optional)</em>
    1976. 

  1976. </td>
    1977. 

  1977. </tr>
    1978. 

  1978. <tr>
    1979. 

  1979. <td>
    1980. 

  1980. <code>data</code></br>
    1981. 

  1981. <em>
    1982. 

  1982. map[string]string
    1983. 

  1983. </em>
    1984. 

  1984. </td>
    1985. 

  1985. <td>
    1986. 

  1986. <em>(Optional)</em>
    1987. 

  1987. </td>
    1988. 

  1988. </tr>
    1989. 

  1989. <tr>
    1990. 

  1990. <td>
    1991. 

  1991. <code>templateFrom</code></br>
    1992. 

  1992. <em>
    1993. 

  1993. <a href="#external-secrets.io/v1alpha1.TemplateFrom">
    1994. 

  1994. []TemplateFrom
    1995. 

  1995. </a>
    1996. 

  1996. </em>
    1997. 

  1997. </td>
    1998. 

  1998. <td>
    1999. 

  1999. <em>(Optional)</em>
    2000. 

  2000. </td>
    2001. 

  2001. </tr>
    2002. 

  2002. </tbody>
    2003. 

  2003. </table>
    2004. 

  2004. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
    2005. 

  2005. </h3>
    2006. 

  2006. <p>
    2007. 

  2007. (<em>Appears on:</em>
    2008. 

  2008. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
    2009. 

  2009. </p>
    2010. 

  2010. <p>
    2011. 

  2011. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
    2012. 

  2012. </p>
    2013. 

  2013. <table>
    2014. 

  2014. <thead>
    2015. 

  2015. <tr>
    2016. 

  2016. <th>Field</th>
    2017. 

  2017. <th>Description</th>
    2018. 

  2018. </tr>
    2019. 

  2019. </thead>
    2020. 

  2020. <tbody>
    2021. 

  2021. <tr>
    2022. 

  2022. <td>
    2023. 

  2023. <code>annotations</code></br>
    2024. 

  2024. <em>
    2025. 

  2025. map[string]string
    2026. 

  2026. </em>
    2027. 

  2027. </td>
    2028. 

  2028. <td>
    2029. 

  2029. <em>(Optional)</em>
    2030. 

  2030. </td>
    2031. 

  2031. </tr>
    2032. 

  2032. <tr>
    2033. 

  2033. <td>
    2034. 

  2034. <code>labels</code></br>
    2035. 

  2035. <em>
    2036. 

  2036. map[string]string
    2037. 

  2037. </em>
    2038. 

  2038. </td>
    2039. 

  2039. <td>
    2040. 

  2040. <em>(Optional)</em>
    2041. 

  2041. </td>
    2042. 

  2042. </tr>
    2043. 

  2043. </tbody>
    2044. 

  2044. </table>
    2045. 

  2045. <h3 id="external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth
    2046. 

  2046. </h3>
    2047. 

  2047. <p>
    2048. 

  2048. (<em>Appears on:</em>
    2049. 

  2049. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider</a>)
    2050. 

  2050. </p>
    2051. 

  2051. <p>
    2052. 

  2052. </p>
    2053. 

  2053. <table>
    2054. 

  2054. <thead>
    2055. 

  2055. <tr>
    2056. 

  2056. <th>Field</th>
    2057. 

  2057. <th>Description</th>
    2058. 

  2058. </tr>
    2059. 

  2059. </thead>
    2060. 

  2060. <tbody>
    2061. 

  2061. <tr>
    2062. 

  2062. <td>
    2063. 

  2063. <code>secretRef</code></br>
    2064. 

  2064. <em>
    2065. 

  2065. <a href="#external-secrets.io/v1alpha1.GCPSMAuthSecretRef">
    2066. 

  2066. GCPSMAuthSecretRef
    2067. 

  2067. </a>
    2068. 

  2068. </em>
    2069. 

  2069. </td>
    2070. 

  2070. <td>
    2071. 

  2071. </td>
    2072. 

  2072. </tr>
    2073. 

  2073. </tbody>
    2074. 

  2074. </table>
    2075. 

  2075. <h3 id="external-secrets.io/v1alpha1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
    2076. 

  2076. </h3>
    2077. 

  2077. <p>
    2078. 

  2078. (<em>Appears on:</em>
    2079. 

  2079. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth</a>)
    2080. 

  2080. </p>
    2081. 

  2081. <p>
    2082. 

  2082. </p>
    2083. 

  2083. <table>
    2084. 

  2084. <thead>
    2085. 

  2085. <tr>
    2086. 

  2086. <th>Field</th>
    2087. 

  2087. <th>Description</th>
    2088. 

  2088. </tr>
    2089. 

  2089. </thead>
    2090. 

  2090. <tbody>
    2091. 

  2091. <tr>
    2092. 

  2092. <td>
    2093. 

  2093. <code>secretAccessKeySecretRef</code></br>
    2094. 

  2094. <em>
    2095. 

  2095. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    2096. 

  2096. </em>
    2097. 

  2097. </td>
    2098. 

  2098. <td>
    2099. 

  2099. <em>(Optional)</em>
    2100. 

  2100. <p>The SecretAccessKey is used for authentication</p>
    2101. 

  2101. </td>
    2102. 

  2102. </tr>
    2103. 

  2103. </tbody>
    2104. 

  2104. </table>
    2105. 

  2105. <h3 id="external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider
    2106. 

  2106. </h3>
    2107. 

  2107. <p>
    2108. 

  2108. (<em>Appears on:</em>
    2109. 

  2109. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
    2110. 

  2110. </p>
    2111. 

  2111. <p>
    2112. 

  2112. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
    2113. 

  2113. </p>
    2114. 

  2114. <table>
    2115. 

  2115. <thead>
    2116. 

  2116. <tr>
    2117. 

  2117. <th>Field</th>
    2118. 

  2118. <th>Description</th>
    2119. 

  2119. </tr>
    2120. 

  2120. </thead>
    2121. 

  2121. <tbody>
    2122. 

  2122. <tr>
    2123. 

  2123. <td>
    2124. 

  2124. <code>auth</code></br>
    2125. 

  2125. <em>
    2126. 

  2126. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">
    2127. 

  2127. GCPSMAuth
    2128. 

  2128. </a>
    2129. 

  2129. </em>
    2130. 

  2130. </td>
    2131. 

  2131. <td>
    2132. 

  2132. <em>(Optional)</em>
    2133. 

  2133. <p>Auth defines the information necessary to authenticate against GCP</p>
    2134. 

  2134. </td>
    2135. 

  2135. </tr>
    2136. 

  2136. <tr>
    2137. 

  2137. <td>
    2138. 

  2138. <code>projectID</code></br>
    2139. 

  2139. <em>
    2140. 

  2140. string
    2141. 

  2141. </em>
    2142. 

  2142. </td>
    2143. 

  2143. <td>
    2144. 

  2144. <p>ProjectID project where secret is located</p>
    2145. 

  2145. </td>
    2146. 

  2146. </tr>
    2147. 

  2147. </tbody>
    2148. 

  2148. </table>
    2149. 

  2149. <h3 id="external-secrets.io/v1alpha1.GenericStore">GenericStore
    2150. 

  2150. </h3>
    2151. 

  2151. <p>
    2152. 

  2152. <p>GenericStore is a common interface for interacting with ClusterSecretStore
    2153. 

  2153. or a namespaced SecretStore.</p>
    2154. 

  2154. </p>
    2155. 

  2155. <h3 id="external-secrets.io/v1alpha1.GitlabAuth">GitlabAuth
    2156. 

  2156. </h3>
    2157. 

  2157. <p>
    2158. 

  2158. (<em>Appears on:</em>
    2159. 

  2159. <a href="#external-secrets.io/v1alpha1.GitlabProvider">GitlabProvider</a>)
    2160. 

  2160. </p>
    2161. 

  2161. <p>
    2162. 

  2162. </p>
    2163. 

  2163. <table>
    2164. 

  2164. <thead>
    2165. 

  2165. <tr>
    2166. 

  2166. <th>Field</th>
    2167. 

  2167. <th>Description</th>
    2168. 

  2168. </tr>
    2169. 

  2169. </thead>
    2170. 

  2170. <tbody>
    2171. 

  2171. <tr>
    2172. 

  2172. <td>
    2173. 

  2173. <code>SecretRef</code></br>
    2174. 

  2174. <em>
    2175. 

  2175. <a href="#external-secrets.io/v1alpha1.GitlabSecretRef">
    2176. 

  2176. GitlabSecretRef
    2177. 

  2177. </a>
    2178. 

  2178. </em>
    2179. 

  2179. </td>
    2180. 

  2180. <td>
    2181. 

  2181. </td>
    2182. 

  2182. </tr>
    2183. 

  2183. </tbody>
    2184. 

  2184. </table>
    2185. 

  2185. <h3 id="external-secrets.io/v1alpha1.GitlabProvider">GitlabProvider
    2186. 

  2186. </h3>
    2187. 

  2187. <p>
    2188. 

  2188. (<em>Appears on:</em>
    2189. 

  2189. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
    2190. 

  2190. </p>
    2191. 

  2191. <p>
    2192. 

  2192. <p>Configures a store to sync secrets with a GitLab instance.</p>
    2193. 

  2193. </p>
    2194. 

  2194. <table>
    2195. 

  2195. <thead>
    2196. 

  2196. <tr>
    2197. 

  2197. <th>Field</th>
    2198. 

  2198. <th>Description</th>
    2199. 

  2199. </tr>
    2200. 

  2200. </thead>
    2201. 

  2201. <tbody>
    2202. 

  2202. <tr>
    2203. 

  2203. <td>
    2204. 

  2204. <code>url</code></br>
    2205. 

  2205. <em>
    2206. 

  2206. string
    2207. 

  2207. </em>
    2208. 

  2208. </td>
    2209. 

  2209. <td>
    2210. 

  2210. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
    2211. 

  2211. </td>
    2212. 

  2212. </tr>
    2213. 

  2213. <tr>
    2214. 

  2214. <td>
    2215. 

  2215. <code>auth</code></br>
    2216. 

  2216. <em>
    2217. 

  2217. <a href="#external-secrets.io/v1alpha1.GitlabAuth">
    2218. 

  2218. GitlabAuth
    2219. 

  2219. </a>
    2220. 

  2220. </em>
    2221. 

  2221. </td>
    2222. 

  2222. <td>
    2223. 

  2223. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
    2224. 

  2224. </td>
    2225. 

  2225. </tr>
    2226. 

  2226. <tr>
    2227. 

  2227. <td>
    2228. 

  2228. <code>projectID</code></br>
    2229. 

  2229. <em>
    2230. 

  2230. string
    2231. 

  2231. </em>
    2232. 

  2232. </td>
    2233. 

  2233. <td>
    2234. 

  2234. <p>ProjectID specifies a project where secrets are located.</p>
    2235. 

  2235. </td>
    2236. 

  2236. </tr>
    2237. 

  2237. </tbody>
    2238. 

  2238. </table>
    2239. 

  2239. <h3 id="external-secrets.io/v1alpha1.GitlabSecretRef">GitlabSecretRef
    2240. 

  2240. </h3>
    2241. 

  2241. <p>
    2242. 

  2242. (<em>Appears on:</em>
    2243. 

  2243. <a href="#external-secrets.io/v1alpha1.GitlabAuth">GitlabAuth</a>)
    2244. 

  2244. </p>
    2245. 

  2245. <p>
    2246. 

  2246. </p>
    2247. 

  2247. <table>
    2248. 

  2248. <thead>
    2249. 

  2249. <tr>
    2250. 

  2250. <th>Field</th>
    2251. 

  2251. <th>Description</th>
    2252. 

  2252. </tr>
    2253. 

  2253. </thead>
    2254. 

  2254. <tbody>
    2255. 

  2255. <tr>
    2256. 

  2256. <td>
    2257. 

  2257. <code>accessToken</code></br>
    2258. 

  2258. <em>
    2259. 

  2259. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    2260. 

  2260. </em>
    2261. 

  2261. </td>
    2262. 

  2262. <td>
    2263. 

  2263. <p>AccessToken is used for authentication.</p>
    2264. 

  2264. </td>
    2265. 

  2265. </tr>
    2266. 

  2266. </tbody>
    2267. 

  2267. </table>
    2268. 

  2268. <h3 id="external-secrets.io/v1alpha1.IBMAuth">IBMAuth
    2269. 

  2269. </h3>
    2270. 

  2270. <p>
    2271. 

  2271. (<em>Appears on:</em>
    2272. 

  2272. <a href="#external-secrets.io/v1alpha1.IBMProvider">IBMProvider</a>)
    2273. 

  2273. </p>
    2274. 

  2274. <p>
    2275. 

  2275. </p>
    2276. 

  2276. <table>
    2277. 

  2277. <thead>
    2278. 

  2278. <tr>
    2279. 

  2279. <th>Field</th>
    2280. 

  2280. <th>Description</th>
    2281. 

  2281. </tr>
    2282. 

  2282. </thead>
    2283. 

  2283. <tbody>
    2284. 

  2284. <tr>
    2285. 

  2285. <td>
    2286. 

  2286. <code>secretRef</code></br>
    2287. 

  2287. <em>
    2288. 

  2288. <a href="#external-secrets.io/v1alpha1.IBMAuthSecretRef">
    2289. 

  2289. IBMAuthSecretRef
    2290. 

  2290. </a>
    2291. 

  2291. </em>
    2292. 

  2292. </td>
    2293. 

  2293. <td>
    2294. 

  2294. </td>
    2295. 

  2295. </tr>
    2296. 

  2296. </tbody>
    2297. 

  2297. </table>
    2298. 

  2298. <h3 id="external-secrets.io/v1alpha1.IBMAuthSecretRef">IBMAuthSecretRef
    2299. 

  2299. </h3>
    2300. 

  2300. <p>
    2301. 

  2301. (<em>Appears on:</em>
    2302. 

  2302. <a href="#external-secrets.io/v1alpha1.IBMAuth">IBMAuth</a>)
    2303. 

  2303. </p>
    2304. 

  2304. <p>
    2305. 

  2305. </p>
    2306. 

  2306. <table>
    2307. 

  2307. <thead>
    2308. 

  2308. <tr>
    2309. 

  2309. <th>Field</th>
    2310. 

  2310. <th>Description</th>
    2311. 

  2311. </tr>
    2312. 

  2312. </thead>
    2313. 

  2313. <tbody>
    2314. 

  2314. <tr>
    2315. 

  2315. <td>
    2316. 

  2316. <code>secretApiKeySecretRef</code></br>
    2317. 

  2317. <em>
    2318. 

  2318. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    2319. 

  2319. </em>
    2320. 

  2320. </td>
    2321. 

  2321. <td>
    2322. 

  2322. <em>(Optional)</em>
    2323. 

  2323. <p>The SecretAccessKey is used for authentication</p>
    2324. 

  2324. </td>
    2325. 

  2325. </tr>
    2326. 

  2326. </tbody>
    2327. 

  2327. </table>
    2328. 

  2328. <h3 id="external-secrets.io/v1alpha1.IBMProvider">IBMProvider
    2329. 

  2329. </h3>
    2330. 

  2330. <p>
    2331. 

  2331. (<em>Appears on:</em>
    2332. 

  2332. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
    2333. 

  2333. </p>
    2334. 

  2334. <p>
    2335. 

  2335. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
    2336. 

  2336. backend.</p>
    2337. 

  2337. </p>
    2338. 

  2338. <table>
    2339. 

  2339. <thead>
    2340. 

  2340. <tr>
    2341. 

  2341. <th>Field</th>
    2342. 

  2342. <th>Description</th>
    2343. 

  2343. </tr>
    2344. 

  2344. </thead>
    2345. 

  2345. <tbody>
    2346. 

  2346. <tr>
    2347. 

  2347. <td>
    2348. 

  2348. <code>auth</code></br>
    2349. 

  2349. <em>
    2350. 

  2350. <a href="#external-secrets.io/v1alpha1.IBMAuth">
    2351. 

  2351. IBMAuth
    2352. 

  2352. </a>
    2353. 

  2353. </em>
    2354. 

  2354. </td>
    2355. 

  2355. <td>
    2356. 

  2356. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
    2357. 

  2357. </td>
    2358. 

  2358. </tr>
    2359. 

  2359. <tr>
    2360. 

  2360. <td>
    2361. 

  2361. <code>serviceUrl</code></br>
    2362. 

  2362. <em>
    2363. 

  2363. string
    2364. 

  2364. </em>
    2365. 

  2365. </td>
    2366. 

  2366. <td>
    2367. 

  2367. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
    2368. 

  2368. </td>
    2369. 

  2369. </tr>
    2370. 

  2370. </tbody>
    2371. 

  2371. </table>
    2372. 

  2372. <h3 id="external-secrets.io/v1alpha1.SecretStore">SecretStore
    2373. 

  2373. </h3>
    2374. 

  2374. <p>
    2375. 

  2375. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
    2376. 

  2376. </p>
    2377. 

  2377. <table>
    2378. 

  2378. <thead>
    2379. 

  2379. <tr>
    2380. 

  2380. <th>Field</th>
    2381. 

  2381. <th>Description</th>
    2382. 

  2382. </tr>
    2383. 

  2383. </thead>
    2384. 

  2384. <tbody>
    2385. 

  2385. <tr>
    2386. 

  2386. <td>
    2387. 

  2387. <code>metadata</code></br>
    2388. 

  2388. <em>
    2389. 

  2389. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
    2390. 

  2390. Kubernetes meta/v1.ObjectMeta
    2391. 

  2391. </a>
    2392. 

  2392. </em>
    2393. 

  2393. </td>
    2394. 

  2394. <td>
    2395. 

  2395. Refer to the Kubernetes API documentation for the fields of the
    2396. 

  2396. <code>metadata</code> field.
    2397. 

  2397. </td>
    2398. 

  2398. </tr>
    2399. 

  2399. <tr>
    2400. 

  2400. <td>
    2401. 

  2401. <code>spec</code></br>
    2402. 

  2402. <em>
    2403. 

  2403. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
    2404. 

  2404. SecretStoreSpec
    2405. 

  2405. </a>
    2406. 

  2406. </em>
    2407. 

  2407. </td>
    2408. 

  2408. <td>
    2409. 

  2409. <br/>
    2410. 

  2410. <br/>
    2411. 

  2411. <table>
    2412. 

  2412. <tr>
    2413. 

  2413. <td>
    2414. 

  2414. <code>controller</code></br>
    2415. 

  2415. <em>
    2416. 

  2416. string
    2417. 

  2417. </em>
    2418. 

  2418. </td>
    2419. 

  2419. <td>
    2420. 

  2420. <em>(Optional)</em>
    2421. 

  2421. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
    2422. 

  2422. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
    2423. 

  2423. </td>
    2424. 

  2424. </tr>
    2425. 

  2425. <tr>
    2426. 

  2426. <td>
    2427. 

  2427. <code>provider</code></br>
    2428. 

  2428. <em>
    2429. 

  2429. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
    2430. 

  2430. SecretStoreProvider
    2431. 

  2431. </a>
    2432. 

  2432. </em>
    2433. 

  2433. </td>
    2434. 

  2434. <td>
    2435. 

  2435. <p>Used to configure the provider. Only one provider may be set</p>
    2436. 

  2436. </td>
    2437. 

  2437. </tr>
    2438. 

  2438. </table>
    2439. 

  2439. </td>
    2440. 

  2440. </tr>
    2441. 

  2441. <tr>
    2442. 

  2442. <td>
    2443. 

  2443. <code>status</code></br>
    2444. 

  2444. <em>
    2445. 

  2445. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
    2446. 

  2446. SecretStoreStatus
    2447. 

  2447. </a>
    2448. 

  2448. </em>
    2449. 

  2449. </td>
    2450. 

  2450. <td>
    2451. 

  2451. </td>
    2452. 

  2452. </tr>
    2453. 

  2453. </tbody>
    2454. 

  2454. </table>
    2455. 

  2455. <h3 id="external-secrets.io/v1alpha1.SecretStoreConditionType">SecretStoreConditionType
    2456. 

  2456. (<code>string</code> alias)</p></h3>
    2457. 

  2457. <p>
    2458. 

  2458. (<em>Appears on:</em>
    2459. 

  2459. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
    2460. 

  2460. </p>
    2461. 

  2461. <p>
    2462. 

  2462. </p>
    2463. 

  2463. <table>
    2464. 

  2464. <thead>
    2465. 

  2465. <tr>
    2466. 

  2466. <th>Value</th>
    2467. 

  2467. <th>Description</th>
    2468. 

  2468. </tr>
    2469. 

  2469. </thead>
    2470. 

  2470. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
    2471. 

  2471. <td></td>
    2472. 

  2472. </tr></tbody>
    2473. 

  2473. </table>
    2474. 

  2474. <h3 id="external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider
    2475. 

  2475. </h3>
    2476. 

  2476. <p>
    2477. 

  2477. (<em>Appears on:</em>
    2478. 

  2478. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec</a>)
    2479. 

  2479. </p>
    2480. 

  2480. <p>
    2481. 

  2481. <p>SecretStoreProvider contains the provider-specific configration.</p>
    2482. 

  2482. </p>
    2483. 

  2483. <table>
    2484. 

  2484. <thead>
    2485. 

  2485. <tr>
    2486. 

  2486. <th>Field</th>
    2487. 

  2487. <th>Description</th>
    2488. 

  2488. </tr>
    2489. 

  2489. </thead>
    2490. 

  2490. <tbody>
    2491. 

  2491. <tr>
    2492. 

  2492. <td>
    2493. 

  2493. <code>aws</code></br>
    2494. 

  2494. <em>
    2495. 

  2495. <a href="#external-secrets.io/v1alpha1.AWSProvider">
    2496. 

  2496. AWSProvider
    2497. 

  2497. </a>
    2498. 

  2498. </em>
    2499. 

  2499. </td>
    2500. 

  2500. <td>
    2501. 

  2501. <em>(Optional)</em>
    2502. 

  2502. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
    2503. 

  2503. </td>
    2504. 

  2504. </tr>
    2505. 

  2505. <tr>
    2506. 

  2506. <td>
    2507. 

  2507. <code>azurekv</code></br>
    2508. 

  2508. <em>
    2509. 

  2509. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">
    2510. 

  2510. AzureKVProvider
    2511. 

  2511. </a>
    2512. 

  2512. </em>
    2513. 

  2513. </td>
    2514. 

  2514. <td>
    2515. 

  2515. <em>(Optional)</em>
    2516. 

  2516. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
    2517. 

  2517. </td>
    2518. 

  2518. </tr>
    2519. 

  2519. <tr>
    2520. 

  2520. <td>
    2521. 

  2521. <code>vault</code></br>
    2522. 

  2522. <em>
    2523. 

  2523. <a href="#external-secrets.io/v1alpha1.VaultProvider">
    2524. 

  2524. VaultProvider
    2525. 

  2525. </a>
    2526. 

  2526. </em>
    2527. 

  2527. </td>
    2528. 

  2528. <td>
    2529. 

  2529. <em>(Optional)</em>
    2530. 

  2530. <p>Vault configures this store to sync secrets using Hashi provider</p>
    2531. 

  2531. </td>
    2532. 

  2532. </tr>
    2533. 

  2533. <tr>
    2534. 

  2534. <td>
    2535. 

  2535. <code>gcpsm</code></br>
    2536. 

  2536. <em>
    2537. 

  2537. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">
    2538. 

  2538. GCPSMProvider
    2539. 

  2539. </a>
    2540. 

  2540. </em>
    2541. 

  2541. </td>
    2542. 

  2542. <td>
    2543. 

  2543. <em>(Optional)</em>
    2544. 

  2544. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
    2545. 

  2545. </td>
    2546. 

  2546. </tr>
    2547. 

  2547. <tr>
    2548. 

  2548. <td>
    2549. 

  2549. <code>ibm</code></br>
    2550. 

  2550. <em>
    2551. 

  2551. <a href="#external-secrets.io/v1alpha1.IBMProvider">
    2552. 

  2552. IBMProvider
    2553. 

  2553. </a>
    2554. 

  2554. </em>
    2555. 

  2555. </td>
    2556. 

  2556. <td>
    2557. 

  2557. <em>(Optional)</em>
    2558. 

  2558. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
    2559. 

  2559. </td>
    2560. 

  2560. </tr>
    2561. 

  2561. <tr>
    2562. 

  2562. <td>
    2563. 

  2563. <code>yandexlockbox</code></br>
    2564. 

  2564. <em>
    2565. 

  2565. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">
    2566. 

  2566. YandexLockboxProvider
    2567. 

  2567. </a>
    2568. 

  2568. </em>
    2569. 

  2569. </td>
    2570. 

  2570. <td>
    2571. 

  2571. <em>(Optional)</em>
    2572. 

  2572. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
    2573. 

  2573. </td>
    2574. 

  2574. </tr>
    2575. 

  2575. <tr>
    2576. 

  2576. <td>
    2577. 

  2577. <code>gitlab</code></br>
    2578. 

  2578. <em>
    2579. 

  2579. <a href="#external-secrets.io/v1alpha1.GitlabProvider">
    2580. 

  2580. GitlabProvider
    2581. 

  2581. </a>
    2582. 

  2582. </em>
    2583. 

  2583. </td>
    2584. 

  2584. <td>
    2585. 

  2585. <em>(Optional)</em>
    2586. 

  2586. <p>GItlab configures this store to sync secrets using Gitlab Variables provider</p>
    2587. 

  2587. </td>
    2588. 

  2588. </tr>
    2589. 

  2589. <tr>
    2590. 

  2590. <td>
    2591. 

  2591. <code>alibaba</code></br>
    2592. 

  2592. <em>
    2593. 

  2593. <a href="#external-secrets.io/v1alpha1.AlibabaProvider">
    2594. 

  2594. AlibabaProvider
    2595. 

  2595. </a>
    2596. 

  2596. </em>
    2597. 

  2597. </td>
    2598. 

  2598. <td>
    2599. 

  2599. <em>(Optional)</em>
    2600. 

  2600. <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
    2601. 

  2601. </td>
    2602. 

  2602. </tr>
    2603. 

  2603. </tbody>
    2604. 

  2604. </table>
    2605. 

  2605. <h3 id="external-secrets.io/v1alpha1.SecretStoreRef">SecretStoreRef
    2606. 

  2606. </h3>
    2607. 

  2607. <p>
    2608. 

  2608. (<em>Appears on:</em>
    2609. 

  2609. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
    2610. 

  2610. </p>
    2611. 

  2611. <p>
    2612. 

  2612. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
    2613. 

  2613. </p>
    2614. 

  2614. <table>
    2615. 

  2615. <thead>
    2616. 

  2616. <tr>
    2617. 

  2617. <th>Field</th>
    2618. 

  2618. <th>Description</th>
    2619. 

  2619. </tr>
    2620. 

  2620. </thead>
    2621. 

  2621. <tbody>
    2622. 

  2622. <tr>
    2623. 

  2623. <td>
    2624. 

  2624. <code>name</code></br>
    2625. 

  2625. <em>
    2626. 

  2626. string
    2627. 

  2627. </em>
    2628. 

  2628. </td>
    2629. 

  2629. <td>
    2630. 

  2630. <p>Name of the SecretStore resource</p>
    2631. 

  2631. </td>
    2632. 

  2632. </tr>
    2633. 

  2633. <tr>
    2634. 

  2634. <td>
    2635. 

  2635. <code>kind</code></br>
    2636. 

  2636. <em>
    2637. 

  2637. string
    2638. 

  2638. </em>
    2639. 

  2639. </td>
    2640. 

  2640. <td>
    2641. 

  2641. <em>(Optional)</em>
    2642. 

  2642. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
    2643. 

  2643. Defaults to <code>SecretStore</code></p>
    2644. 

  2644. </td>
    2645. 

  2645. </tr>
    2646. 

  2646. </tbody>
    2647. 

  2647. </table>
    2648. 

  2648. <h3 id="external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec
    2649. 

  2649. </h3>
    2650. 

  2650. <p>
    2651. 

  2651. (<em>Appears on:</em>
    2652. 

  2652. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>, 
    2653. 

  2653. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
    2654. 

  2654. </p>
    2655. 

  2655. <p>
    2656. 

  2656. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
    2657. 

  2657. </p>
    2658. 

  2658. <table>
    2659. 

  2659. <thead>
    2660. 

  2660. <tr>
    2661. 

  2661. <th>Field</th>
    2662. 

  2662. <th>Description</th>
    2663. 

  2663. </tr>
    2664. 

  2664. </thead>
    2665. 

  2665. <tbody>
    2666. 

  2666. <tr>
    2667. 

  2667. <td>
    2668. 

  2668. <code>controller</code></br>
    2669. 

  2669. <em>
    2670. 

  2670. string
    2671. 

  2671. </em>
    2672. 

  2672. </td>
    2673. 

  2673. <td>
    2674. 

  2674. <em>(Optional)</em>
    2675. 

  2675. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
    2676. 

  2676. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
    2677. 

  2677. </td>
    2678. 

  2678. </tr>
    2679. 

  2679. <tr>
    2680. 

  2680. <td>
    2681. 

  2681. <code>provider</code></br>
    2682. 

  2682. <em>
    2683. 

  2683. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
    2684. 

  2684. SecretStoreProvider
    2685. 

  2685. </a>
    2686. 

  2686. </em>
    2687. 

  2687. </td>
    2688. 

  2688. <td>
    2689. 

  2689. <p>Used to configure the provider. Only one provider may be set</p>
    2690. 

  2690. </td>
    2691. 

  2691. </tr>
    2692. 

  2692. </tbody>
    2693. 

  2693. </table>
    2694. 

  2694. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus
    2695. 

  2695. </h3>
    2696. 

  2696. <p>
    2697. 

  2697. (<em>Appears on:</em>
    2698. 

  2698. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>, 
    2699. 

  2699. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
    2700. 

  2700. </p>
    2701. 

  2701. <p>
    2702. 

  2702. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
    2703. 

  2703. </p>
    2704. 

  2704. <table>
    2705. 

  2705. <thead>
    2706. 

  2706. <tr>
    2707. 

  2707. <th>Field</th>
    2708. 

  2708. <th>Description</th>
    2709. 

  2709. </tr>
    2710. 

  2710. </thead>
    2711. 

  2711. <tbody>
    2712. 

  2712. <tr>
    2713. 

  2713. <td>
    2714. 

  2714. <code>conditions</code></br>
    2715. 

  2715. <em>
    2716. 

  2716. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">
    2717. 

  2717. []SecretStoreStatusCondition
    2718. 

  2718. </a>
    2719. 

  2719. </em>
    2720. 

  2720. </td>
    2721. 

  2721. <td>
    2722. 

  2722. <em>(Optional)</em>
    2723. 

  2723. </td>
    2724. 

  2724. </tr>
    2725. 

  2725. </tbody>
    2726. 

  2726. </table>
    2727. 

  2727. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition
    2728. 

  2728. </h3>
    2729. 

  2729. <p>
    2730. 

  2730. (<em>Appears on:</em>
    2731. 

  2731. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus</a>)
    2732. 

  2732. </p>
    2733. 

  2733. <p>
    2734. 

  2734. </p>
    2735. 

  2735. <table>
    2736. 

  2736. <thead>
    2737. 

  2737. <tr>
    2738. 

  2738. <th>Field</th>
    2739. 

  2739. <th>Description</th>
    2740. 

  2740. </tr>
    2741. 

  2741. </thead>
    2742. 

  2742. <tbody>
    2743. 

  2743. <tr>
    2744. 

  2744. <td>
    2745. 

  2745. <code>type</code></br>
    2746. 

  2746. <em>
    2747. 

  2747. <a href="#external-secrets.io/v1alpha1.SecretStoreConditionType">
    2748. 

  2748. SecretStoreConditionType
    2749. 

  2749. </a>
    2750. 

  2750. </em>
    2751. 

  2751. </td>
    2752. 

  2752. <td>
    2753. 

  2753. </td>
    2754. 

  2754. </tr>
    2755. 

  2755. <tr>
    2756. 

  2756. <td>
    2757. 

  2757. <code>status</code></br>
    2758. 

  2758. <em>
    2759. 

  2759. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
    2760. 

  2760. Kubernetes core/v1.ConditionStatus
    2761. 

  2761. </a>
    2762. 

  2762. </em>
    2763. 

  2763. </td>
    2764. 

  2764. <td>
    2765. 

  2765. </td>
    2766. 

  2766. </tr>
    2767. 

  2767. <tr>
    2768. 

  2768. <td>
    2769. 

  2769. <code>reason</code></br>
    2770. 

  2770. <em>
    2771. 

  2771. string
    2772. 

  2772. </em>
    2773. 

  2773. </td>
    2774. 

  2774. <td>
    2775. 

  2775. <em>(Optional)</em>
    2776. 

  2776. </td>
    2777. 

  2777. </tr>
    2778. 

  2778. <tr>
    2779. 

  2779. <td>
    2780. 

  2780. <code>message</code></br>
    2781. 

  2781. <em>
    2782. 

  2782. string
    2783. 

  2783. </em>
    2784. 

  2784. </td>
    2785. 

  2785. <td>
    2786. 

  2786. <em>(Optional)</em>
    2787. 

  2787. </td>
    2788. 

  2788. </tr>
    2789. 

  2789. <tr>
    2790. 

  2790. <td>
    2791. 

  2791. <code>lastTransitionTime</code></br>
    2792. 

  2792. <em>
    2793. 

  2793. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
    2794. 

  2794. Kubernetes meta/v1.Time
    2795. 

  2795. </a>
    2796. 

  2796. </em>
    2797. 

  2797. </td>
    2798. 

  2798. <td>
    2799. 

  2799. <em>(Optional)</em>
    2800. 

  2800. </td>
    2801. 

  2801. </tr>
    2802. 

  2802. </tbody>
    2803. 

  2803. </table>
    2804. 

  2804. <h3 id="external-secrets.io/v1alpha1.TemplateFrom">TemplateFrom
    2805. 

  2805. </h3>
    2806. 

  2806. <p>
    2807. 

  2807. (<em>Appears on:</em>
    2808. 

  2808. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
    2809. 

  2809. </p>
    2810. 

  2810. <p>
    2811. 

  2811. </p>
    2812. 

  2812. <table>
    2813. 

  2813. <thead>
    2814. 

  2814. <tr>
    2815. 

  2815. <th>Field</th>
    2816. 

  2816. <th>Description</th>
    2817. 

  2817. </tr>
    2818. 

  2818. </thead>
    2819. 

  2819. <tbody>
    2820. 

  2820. <tr>
    2821. 

  2821. <td>
    2822. 

  2822. <code>configMap</code></br>
    2823. 

  2823. <em>
    2824. 

  2824. <a href="#external-secrets.io/v1alpha1.TemplateRef">
    2825. 

  2825. TemplateRef
    2826. 

  2826. </a>
    2827. 

  2827. </em>
    2828. 

  2828. </td>
    2829. 

  2829. <td>
    2830. 

  2830. </td>
    2831. 

  2831. </tr>
    2832. 

  2832. <tr>
    2833. 

  2833. <td>
    2834. 

  2834. <code>secret</code></br>
    2835. 

  2835. <em>
    2836. 

  2836. <a href="#external-secrets.io/v1alpha1.TemplateRef">
    2837. 

  2837. TemplateRef
    2838. 

  2838. </a>
    2839. 

  2839. </em>
    2840. 

  2840. </td>
    2841. 

  2841. <td>
    2842. 

  2842. </td>
    2843. 

  2843. </tr>
    2844. 

  2844. </tbody>
    2845. 

  2845. </table>
    2846. 

  2846. <h3 id="external-secrets.io/v1alpha1.TemplateRef">TemplateRef
    2847. 

  2847. </h3>
    2848. 

  2848. <p>
    2849. 

  2849. (<em>Appears on:</em>
    2850. 

  2850. <a href="#external-secrets.io/v1alpha1.TemplateFrom">TemplateFrom</a>)
    2851. 

  2851. </p>
    2852. 

  2852. <p>
    2853. 

  2853. </p>
    2854. 

  2854. <table>
    2855. 

  2855. <thead>
    2856. 

  2856. <tr>
    2857. 

  2857. <th>Field</th>
    2858. 

  2858. <th>Description</th>
    2859. 

  2859. </tr>
    2860. 

  2860. </thead>
    2861. 

  2861. <tbody>
    2862. 

  2862. <tr>
    2863. 

  2863. <td>
    2864. 

  2864. <code>name</code></br>
    2865. 

  2865. <em>
    2866. 

  2866. string
    2867. 

  2867. </em>
    2868. 

  2868. </td>
    2869. 

  2869. <td>
    2870. 

  2870. </td>
    2871. 

  2871. </tr>
    2872. 

  2872. <tr>
    2873. 

  2873. <td>
    2874. 

  2874. <code>items</code></br>
    2875. 

  2875. <em>
    2876. 

  2876. <a href="#external-secrets.io/v1alpha1.TemplateRefItem">
    2877. 

  2877. []TemplateRefItem
    2878. 

  2878. </a>
    2879. 

  2879. </em>
    2880. 

  2880. </td>
    2881. 

  2881. <td>
    2882. 

  2882. </td>
    2883. 

  2883. </tr>
    2884. 

  2884. </tbody>
    2885. 

  2885. </table>
    2886. 

  2886. <h3 id="external-secrets.io/v1alpha1.TemplateRefItem">TemplateRefItem
    2887. 

  2887. </h3>
    2888. 

  2888. <p>
    2889. 

  2889. (<em>Appears on:</em>
    2890. 

  2890. <a href="#external-secrets.io/v1alpha1.TemplateRef">TemplateRef</a>)
    2891. 

  2891. </p>
    2892. 

  2892. <p>
    2893. 

  2893. </p>
    2894. 

  2894. <table>
    2895. 

  2895. <thead>
    2896. 

  2896. <tr>
    2897. 

  2897. <th>Field</th>
    2898. 

  2898. <th>Description</th>
    2899. 

  2899. </tr>
    2900. 

  2900. </thead>
    2901. 

  2901. <tbody>
    2902. 

  2902. <tr>
    2903. 

  2903. <td>
    2904. 

  2904. <code>key</code></br>
    2905. 

  2905. <em>
    2906. 

  2906. string
    2907. 

  2907. </em>
    2908. 

  2908. </td>
    2909. 

  2909. <td>
    2910. 

  2910. </td>
    2911. 

  2911. </tr>
    2912. 

  2912. </tbody>
    2913. 

  2913. </table>
    2914. 

  2914. <h3 id="external-secrets.io/v1alpha1.VaultAppRole">VaultAppRole
    2915. 

  2915. </h3>
    2916. 

  2916. <p>
    2917. 

  2917. (<em>Appears on:</em>
    2918. 

  2918. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
    2919. 

  2919. </p>
    2920. 

  2920. <p>
    2921. 

  2921. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
    2922. 

  2922. with the role and secret stored in a Kubernetes Secret resource.</p>
    2923. 

  2923. </p>
    2924. 

  2924. <table>
    2925. 

  2925. <thead>
    2926. 

  2926. <tr>
    2927. 

  2927. <th>Field</th>
    2928. 

  2928. <th>Description</th>
    2929. 

  2929. </tr>
    2930. 

  2930. </thead>
    2931. 

  2931. <tbody>
    2932. 

  2932. <tr>
    2933. 

  2933. <td>
    2934. 

  2934. <code>path</code></br>
    2935. 

  2935. <em>
    2936. 

  2936. string
    2937. 

  2937. </em>
    2938. 

  2938. </td>
    2939. 

  2939. <td>
    2940. 

  2940. <p>Path where the App Role authentication backend is mounted
    2941. 

  2941. in Vault, e.g: &ldquo;approle&rdquo;</p>
    2942. 

  2942. </td>
    2943. 

  2943. </tr>
    2944. 

  2944. <tr>
    2945. 

  2945. <td>
    2946. 

  2946. <code>roleId</code></br>
    2947. 

  2947. <em>
    2948. 

  2948. string
    2949. 

  2949. </em>
    2950. 

  2950. </td>
    2951. 

  2951. <td>
    2952. 

  2952. <p>RoleID configured in the App Role authentication backend when setting
    2953. 

  2953. up the authentication backend in Vault.</p>
    2954. 

  2954. </td>
    2955. 

  2955. </tr>
    2956. 

  2956. <tr>
    2957. 

  2957. <td>
    2958. 

  2958. <code>secretRef</code></br>
    2959. 

  2959. <em>
    2960. 

  2960. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    2961. 

  2961. </em>
    2962. 

  2962. </td>
    2963. 

  2963. <td>
    2964. 

  2964. <p>Reference to a key in a Secret that contains the App Role secret used
    2965. 

  2965. to authenticate with Vault.
    2966. 

  2966. The <code>key</code> field must be specified and denotes which entry within the Secret
    2967. 

  2967. resource is used as the app role secret.</p>
    2968. 

  2968. </td>
    2969. 

  2969. </tr>
    2970. 

  2970. </tbody>
    2971. 

  2971. </table>
    2972. 

  2972. <h3 id="external-secrets.io/v1alpha1.VaultAuth">VaultAuth
    2973. 

  2973. </h3>
    2974. 

  2974. <p>
    2975. 

  2975. (<em>Appears on:</em>
    2976. 

  2976. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
    2977. 

  2977. </p>
    2978. 

  2978. <p>
    2979. 

  2979. <p>VaultAuth is the configuration used to authenticate with a Vault server.
    2980. 

  2980. Only one of <code>tokenSecretRef</code>, <code>appRole</code>,  <code>kubernetes</code>, <code>ldap</code>, <code>jwt</code> or <code>cert</code>
    2981. 

  2981. can be specified.</p>
    2982. 

  2982. </p>
    2983. 

  2983. <table>
    2984. 

  2984. <thead>
    2985. 

  2985. <tr>
    2986. 

  2986. <th>Field</th>
    2987. 

  2987. <th>Description</th>
    2988. 

  2988. </tr>
    2989. 

  2989. </thead>
    2990. 

  2990. <tbody>
    2991. 

  2991. <tr>
    2992. 

  2992. <td>
    2993. 

  2993. <code>tokenSecretRef</code></br>
    2994. 

  2994. <em>
    2995. 

  2995. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    2996. 

  2996. </em>
    2997. 

  2997. </td>
    2998. 

  2998. <td>
    2999. 

  2999. <em>(Optional)</em>
    3000. 

  3000. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
    3001. 

  3001. </td>
    3002. 

  3002. </tr>
    3003. 

  3003. <tr>
    3004. 

  3004. <td>
    3005. 

  3005. <code>appRole</code></br>
    3006. 

  3006. <em>
    3007. 

  3007. <a href="#external-secrets.io/v1alpha1.VaultAppRole">
    3008. 

  3008. VaultAppRole
    3009. 

  3009. </a>
    3010. 

  3010. </em>
    3011. 

  3011. </td>
    3012. 

  3012. <td>
    3013. 

  3013. <em>(Optional)</em>
    3014. 

  3014. <p>AppRole authenticates with Vault using the App Role auth mechanism,
    3015. 

  3015. with the role and secret stored in a Kubernetes Secret resource.</p>
    3016. 

  3016. </td>
    3017. 

  3017. </tr>
    3018. 

  3018. <tr>
    3019. 

  3019. <td>
    3020. 

  3020. <code>kubernetes</code></br>
    3021. 

  3021. <em>
    3022. 

  3022. <a href="#external-secrets.io/v1alpha1.VaultKubernetesAuth">
    3023. 

  3023. VaultKubernetesAuth
    3024. 

  3024. </a>
    3025. 

  3025. </em>
    3026. 

  3026. </td>
    3027. 

  3027. <td>
    3028. 

  3028. <em>(Optional)</em>
    3029. 

  3029. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
    3030. 

  3030. token stored in the named Secret resource to the Vault server.</p>
    3031. 

  3031. </td>
    3032. 

  3032. </tr>
    3033. 

  3033. <tr>
    3034. 

  3034. <td>
    3035. 

  3035. <code>ldap</code></br>
    3036. 

  3036. <em>
    3037. 

  3037. <a href="#external-secrets.io/v1alpha1.VaultLdapAuth">
    3038. 

  3038. VaultLdapAuth
    3039. 

  3039. </a>
    3040. 

  3040. </em>
    3041. 

  3041. </td>
    3042. 

  3042. <td>
    3043. 

  3043. <em>(Optional)</em>
    3044. 

  3044. <p>Ldap authenticates with Vault by passing username/password pair using
    3045. 

  3045. the LDAP authentication method</p>
    3046. 

  3046. </td>
    3047. 

  3047. </tr>
    3048. 

  3048. <tr>
    3049. 

  3049. <td>
    3050. 

  3050. <code>jwt</code></br>
    3051. 

  3051. <em>
    3052. 

  3052. <a href="#external-secrets.io/v1alpha1.VaultJwtAuth">
    3053. 

  3053. VaultJwtAuth
    3054. 

  3054. </a>
    3055. 

  3055. </em>
    3056. 

  3056. </td>
    3057. 

  3057. <td>
    3058. 

  3058. <em>(Optional)</em>
    3059. 

  3059. <p>Jwt authenticates with Vault by passing role and JWT token using the
    3060. 

  3060. JWT/OIDC authentication method</p>
    3061. 

  3061. </td>
    3062. 

  3062. </tr>
    3063. 

  3063. <tr>
    3064. 

  3064. <td>
    3065. 

  3065. <code>cert</code></br>
    3066. 

  3066. <em>
    3067. 

  3067. <a href="#external-secrets.io/v1alpha1.VaultCertAuth">
    3068. 

  3068. VaultCertAuth
    3069. 

  3069. </a>
    3070. 

  3070. </em>
    3071. 

  3071. </td>
    3072. 

  3072. <td>
    3073. 

  3073. <em>(Optional)</em>
    3074. 

  3074. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
    3075. 

  3075. Cert authentication method</p>
    3076. 

  3076. </td>
    3077. 

  3077. </tr>
    3078. 

  3078. </tbody>
    3079. 

  3079. </table>
    3080. 

  3080. <h3 id="external-secrets.io/v1alpha1.VaultCertAuth">VaultCertAuth
    3081. 

  3081. </h3>
    3082. 

  3082. <p>
    3083. 

  3083. (<em>Appears on:</em>
    3084. 

  3084. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
    3085. 

  3085. </p>
    3086. 

  3086. <p>
    3087. 

  3087. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
    3088. 

  3088. method, with the role name and token stored in a Kubernetes Secret resource.</p>
    3089. 

  3089. </p>
    3090. 

  3090. <table>
    3091. 

  3091. <thead>
    3092. 

  3092. <tr>
    3093. 

  3093. <th>Field</th>
    3094. 

  3094. <th>Description</th>
    3095. 

  3095. </tr>
    3096. 

  3096. </thead>
    3097. 

  3097. <tbody>
    3098. 

  3098. <tr>
    3099. 

  3099. <td>
    3100. 

  3100. <code>clientCert</code></br>
    3101. 

  3101. <em>
    3102. 

  3102. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    3103. 

  3103. </em>
    3104. 

  3104. </td>
    3105. 

  3105. <td>
    3106. 

  3106. <em>(Optional)</em>
    3107. 

  3107. <p>ClientCert is a certificate to authenticate using the Cert Vault
    3108. 

  3108. authentication method</p>
    3109. 

  3109. </td>
    3110. 

  3110. </tr>
    3111. 

  3111. <tr>
    3112. 

  3112. <td>
    3113. 

  3113. <code>secretRef</code></br>
    3114. 

  3114. <em>
    3115. 

  3115. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    3116. 

  3116. </em>
    3117. 

  3117. </td>
    3118. 

  3118. <td>
    3119. 

  3119. <p>SecretRef to a key in a Secret resource containing client private key to
    3120. 

  3120. authenticate with Vault using the Cert authentication method</p>
    3121. 

  3121. </td>
    3122. 

  3122. </tr>
    3123. 

  3123. </tbody>
    3124. 

  3124. </table>
    3125. 

  3125. <h3 id="external-secrets.io/v1alpha1.VaultJwtAuth">VaultJwtAuth
    3126. 

  3126. </h3>
    3127. 

  3127. <p>
    3128. 

  3128. (<em>Appears on:</em>
    3129. 

  3129. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
    3130. 

  3130. </p>
    3131. 

  3131. <p>
    3132. 

  3132. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
    3133. 

  3133. method, with the role name and token stored in a Kubernetes Secret resource.</p>
    3134. 

  3134. </p>
    3135. 

  3135. <table>
    3136. 

  3136. <thead>
    3137. 

  3137. <tr>
    3138. 

  3138. <th>Field</th>
    3139. 

  3139. <th>Description</th>
    3140. 

  3140. </tr>
    3141. 

  3141. </thead>
    3142. 

  3142. <tbody>
    3143. 

  3143. <tr>
    3144. 

  3144. <td>
    3145. 

  3145. <code>role</code></br>
    3146. 

  3146. <em>
    3147. 

  3147. string
    3148. 

  3148. </em>
    3149. 

  3149. </td>
    3150. 

  3150. <td>
    3151. 

  3151. <em>(Optional)</em>
    3152. 

  3152. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
    3153. 

  3153. authentication method</p>
    3154. 

  3154. </td>
    3155. 

  3155. </tr>
    3156. 

  3156. <tr>
    3157. 

  3157. <td>
    3158. 

  3158. <code>secretRef</code></br>
    3159. 

  3159. <em>
    3160. 

  3160. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    3161. 

  3161. </em>
    3162. 

  3162. </td>
    3163. 

  3163. <td>
    3164. 

  3164. <p>SecretRef to a key in a Secret resource containing JWT token to
    3165. 

  3165. authenticate with Vault using the JWT/OIDC authentication method</p>
    3166. 

  3166. </td>
    3167. 

  3167. </tr>
    3168. 

  3168. </tbody>
    3169. 

  3169. </table>
    3170. 

  3170. <h3 id="external-secrets.io/v1alpha1.VaultKVStoreVersion">VaultKVStoreVersion
    3171. 

  3171. (<code>string</code> alias)</p></h3>
    3172. 

  3172. <p>
    3173. 

  3173. (<em>Appears on:</em>
    3174. 

  3174. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
    3175. 

  3175. </p>
    3176. 

  3176. <p>
    3177. 

  3177. </p>
    3178. 

  3178. <table>
    3179. 

  3179. <thead>
    3180. 

  3180. <tr>
    3181. 

  3181. <th>Value</th>
    3182. 

  3182. <th>Description</th>
    3183. 

  3183. </tr>
    3184. 

  3184. </thead>
    3185. 

  3185. <tbody><tr><td><p>&#34;v1&#34;</p></td>
    3186. 

  3186. <td></td>
    3187. 

  3187. </tr><tr><td><p>&#34;v2&#34;</p></td>
    3188. 

  3188. <td></td>
    3189. 

  3189. </tr></tbody>
    3190. 

  3190. </table>
    3191. 

  3191. <h3 id="external-secrets.io/v1alpha1.VaultKubernetesAuth">VaultKubernetesAuth
    3192. 

  3192. </h3>
    3193. 

  3193. <p>
    3194. 

  3194. (<em>Appears on:</em>
    3195. 

  3195. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
    3196. 

  3196. </p>
    3197. 

  3197. <p>
    3198. 

  3198. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
    3199. 

  3199. a Secret.</p>
    3200. 

  3200. </p>
    3201. 

  3201. <table>
    3202. 

  3202. <thead>
    3203. 

  3203. <tr>
    3204. 

  3204. <th>Field</th>
    3205. 

  3205. <th>Description</th>
    3206. 

  3206. </tr>
    3207. 

  3207. </thead>
    3208. 

  3208. <tbody>
    3209. 

  3209. <tr>
    3210. 

  3210. <td>
    3211. 

  3211. <code>mountPath</code></br>
    3212. 

  3212. <em>
    3213. 

  3213. string
    3214. 

  3214. </em>
    3215. 

  3215. </td>
    3216. 

  3216. <td>
    3217. 

  3217. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
    3218. 

  3218. &ldquo;kubernetes&rdquo;</p>
    3219. 

  3219. </td>
    3220. 

  3220. </tr>
    3221. 

  3221. <tr>
    3222. 

  3222. <td>
    3223. 

  3223. <code>serviceAccountRef</code></br>
    3224. 

  3224. <em>
    3225. 

  3225. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
    3226. 

  3226. </em>
    3227. 

  3227. </td>
    3228. 

  3228. <td>
    3229. 

  3229. <em>(Optional)</em>
    3230. 

  3230. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
    3231. 

  3231. If the service account is specified, the service account secret token JWT will be used
    3232. 

  3232. for authenticating with Vault. If the service account selector is not supplied,
    3233. 

  3233. the secretRef will be used instead.</p>
    3234. 

  3234. </td>
    3235. 

  3235. </tr>
    3236. 

  3236. <tr>
    3237. 

  3237. <td>
    3238. 

  3238. <code>secretRef</code></br>
    3239. 

  3239. <em>
    3240. 

  3240. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    3241. 

  3241. </em>
    3242. 

  3242. </td>
    3243. 

  3243. <td>
    3244. 

  3244. <em>(Optional)</em>
    3245. 

  3245. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
    3246. 

  3246. for authenticating with Vault. If a name is specified without a key,
    3247. 

  3247. <code>token</code> is the default. If one is not specified, the one bound to
    3248. 

  3248. the controller will be used.</p>
    3249. 

  3249. </td>
    3250. 

  3250. </tr>
    3251. 

  3251. <tr>
    3252. 

  3252. <td>
    3253. 

  3253. <code>role</code></br>
    3254. 

  3254. <em>
    3255. 

  3255. string
    3256. 

  3256. </em>
    3257. 

  3257. </td>
    3258. 

  3258. <td>
    3259. 

  3259. <p>A required field containing the Vault Role to assume. A Role binds a
    3260. 

  3260. Kubernetes ServiceAccount with a set of Vault policies.</p>
    3261. 

  3261. </td>
    3262. 

  3262. </tr>
    3263. 

  3263. </tbody>
    3264. 

  3264. </table>
    3265. 

  3265. <h3 id="external-secrets.io/v1alpha1.VaultLdapAuth">VaultLdapAuth
    3266. 

  3266. </h3>
    3267. 

  3267. <p>
    3268. 

  3268. (<em>Appears on:</em>
    3269. 

  3269. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
    3270. 

  3270. </p>
    3271. 

  3271. <p>
    3272. 

  3272. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
    3273. 

  3273. with the username and password stored in a Kubernetes Secret resource.</p>
    3274. 

  3274. </p>
    3275. 

  3275. <table>
    3276. 

  3276. <thead>
    3277. 

  3277. <tr>
    3278. 

  3278. <th>Field</th>
    3279. 

  3279. <th>Description</th>
    3280. 

  3280. </tr>
    3281. 

  3281. </thead>
    3282. 

  3282. <tbody>
    3283. 

  3283. <tr>
    3284. 

  3284. <td>
    3285. 

  3285. <code>username</code></br>
    3286. 

  3286. <em>
    3287. 

  3287. string
    3288. 

  3288. </em>
    3289. 

  3289. </td>
    3290. 

  3290. <td>
    3291. 

  3291. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
    3292. 

  3292. authentication method</p>
    3293. 

  3293. </td>
    3294. 

  3294. </tr>
    3295. 

  3295. <tr>
    3296. 

  3296. <td>
    3297. 

  3297. <code>secretRef</code></br>
    3298. 

  3298. <em>
    3299. 

  3299. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    3300. 

  3300. </em>
    3301. 

  3301. </td>
    3302. 

  3302. <td>
    3303. 

  3303. <p>SecretRef to a key in a Secret resource containing password for the LDAP
    3304. 

  3304. user used to authenticate with Vault using the LDAP authentication
    3305. 

  3305. method</p>
    3306. 

  3306. </td>
    3307. 

  3307. </tr>
    3308. 

  3308. </tbody>
    3309. 

  3309. </table>
    3310. 

  3310. <h3 id="external-secrets.io/v1alpha1.VaultProvider">VaultProvider
    3311. 

  3311. </h3>
    3312. 

  3312. <p>
    3313. 

  3313. (<em>Appears on:</em>
    3314. 

  3314. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
    3315. 

  3315. </p>
    3316. 

  3316. <p>
    3317. 

  3317. <p>Configures an store to sync secrets using a HashiCorp Vault
    3318. 

  3318. KV backend.</p>
    3319. 

  3319. </p>
    3320. 

  3320. <table>
    3321. 

  3321. <thead>
    3322. 

  3322. <tr>
    3323. 

  3323. <th>Field</th>
    3324. 

  3324. <th>Description</th>
    3325. 

  3325. </tr>
    3326. 

  3326. </thead>
    3327. 

  3327. <tbody>
    3328. 

  3328. <tr>
    3329. 

  3329. <td>
    3330. 

  3330. <code>auth</code></br>
    3331. 

  3331. <em>
    3332. 

  3332. <a href="#external-secrets.io/v1alpha1.VaultAuth">
    3333. 

  3333. VaultAuth
    3334. 

  3334. </a>
    3335. 

  3335. </em>
    3336. 

  3336. </td>
    3337. 

  3337. <td>
    3338. 

  3338. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
    3339. 

  3339. </td>
    3340. 

  3340. </tr>
    3341. 

  3341. <tr>
    3342. 

  3342. <td>
    3343. 

  3343. <code>server</code></br>
    3344. 

  3344. <em>
    3345. 

  3345. string
    3346. 

  3346. </em>
    3347. 

  3347. </td>
    3348. 

  3348. <td>
    3349. 

  3349. <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>
    3350. 

  3350. </td>
    3351. 

  3351. </tr>
    3352. 

  3352. <tr>
    3353. 

  3353. <td>
    3354. 

  3354. <code>path</code></br>
    3355. 

  3355. <em>
    3356. 

  3356. string
    3357. 

  3357. </em>
    3358. 

  3358. </td>
    3359. 

  3359. <td>
    3360. 

  3360. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
    3361. 

  3361. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
    3362. 

  3362. for fetching secrets from Vault is optional and will be appended
    3363. 

  3363. if not present in specified path.</p>
    3364. 

  3364. </td>
    3365. 

  3365. </tr>
    3366. 

  3366. <tr>
    3367. 

  3367. <td>
    3368. 

  3368. <code>version</code></br>
    3369. 

  3369. <em>
    3370. 

  3370. <a href="#external-secrets.io/v1alpha1.VaultKVStoreVersion">
    3371. 

  3371. VaultKVStoreVersion
    3372. 

  3372. </a>
    3373. 

  3373. </em>
    3374. 

  3374. </td>
    3375. 

  3375. <td>
    3376. 

  3376. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
    3377. 

  3377. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
    3378. 

  3378. </td>
    3379. 

  3379. </tr>
    3380. 

  3380. <tr>
    3381. 

  3381. <td>
    3382. 

  3382. <code>namespace</code></br>
    3383. 

  3383. <em>
    3384. 

  3384. string
    3385. 

  3385. </em>
    3386. 

  3386. </td>
    3387. 

  3387. <td>
    3388. 

  3388. <em>(Optional)</em>
    3389. 

  3389. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
    3390. 

  3390. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
    3391. 

  3391. 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>
    3392. 

  3392. </td>
    3393. 

  3393. </tr>
    3394. 

  3394. <tr>
    3395. 

  3395. <td>
    3396. 

  3396. <code>caBundle</code></br>
    3397. 

  3397. <em>
    3398. 

  3398. []byte
    3399. 

  3399. </em>
    3400. 

  3400. </td>
    3401. 

  3401. <td>
    3402. 

  3402. <em>(Optional)</em>
    3403. 

  3403. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
    3404. 

  3404. if the Server URL is using HTTPS protocol. This parameter is ignored for
    3405. 

  3405. plain HTTP protocol connection. If not set the system root certificates
    3406. 

  3406. are used to validate the TLS connection.</p>
    3407. 

  3407. </td>
    3408. 

  3408. </tr>
    3409. 

  3409. </tbody>
    3410. 

  3410. </table>
    3411. 

  3411. <h3 id="external-secrets.io/v1alpha1.YandexLockboxAuth">YandexLockboxAuth
    3412. 

  3412. </h3>
    3413. 

  3413. <p>
    3414. 

  3414. (<em>Appears on:</em>
    3415. 

  3415. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider</a>)
    3416. 

  3416. </p>
    3417. 

  3417. <p>
    3418. 

  3418. </p>
    3419. 

  3419. <table>
    3420. 

  3420. <thead>
    3421. 

  3421. <tr>
    3422. 

  3422. <th>Field</th>
    3423. 

  3423. <th>Description</th>
    3424. 

  3424. </tr>
    3425. 

  3425. </thead>
    3426. 

  3426. <tbody>
    3427. 

  3427. <tr>
    3428. 

  3428. <td>
    3429. 

  3429. <code>authorizedKeySecretRef</code></br>
    3430. 

  3430. <em>
    3431. 

  3431. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
    3432. 

  3432. </em>
    3433. 

  3433. </td>
    3434. 

  3434. <td>
    3435. 

  3435. <em>(Optional)</em>
    3436. 

  3436. <p>The authorized key used for authentication</p>
    3437. 

  3437. </td>
    3438. 

  3438. </tr>
    3439. 

  3439. </tbody>
    3440. 

  3440. </table>
    3441. 

  3441. <h3 id="external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider
    3442. 

  3442. </h3>
    3443. 

  3443. <p>
    3444. 

  3444. (<em>Appears on:</em>
    3445. 

  3445. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
    3446. 

  3446. </p>
    3447. 

  3447. <p>
    3448. 

  3448. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
    3449. 

  3449. </p>
    3450. 

  3450. <table>
    3451. 

  3451. <thead>
    3452. 

  3452. <tr>
    3453. 

  3453. <th>Field</th>
    3454. 

  3454. <th>Description</th>
    3455. 

  3455. </tr>
    3456. 

  3456. </thead>
    3457. 

  3457. <tbody>
    3458. 

  3458. <tr>
    3459. 

  3459. <td>
    3460. 

  3460. <code>apiEndpoint</code></br>
    3461. 

  3461. <em>
    3462. 

  3462. string
    3463. 

  3463. </em>
    3464. 

  3464. </td>
    3465. 

  3465. <td>
    3466. 

  3466. <em>(Optional)</em>
    3467. 

  3467. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
    3468. 

  3468. </td>
    3469. 

  3469. </tr>
    3470. 

  3470. <tr>
    3471. 

  3471. <td>
    3472. 

  3472. <code>auth</code></br>
    3473. 

  3473. <em>
    3474. 

  3474. <a href="#external-secrets.io/v1alpha1.YandexLockboxAuth">
    3475. 

  3475. YandexLockboxAuth
    3476. 

  3476. </a>
    3477. 

  3477. </em>
    3478. 

  3478. </td>
    3479. 

  3479. <td>
    3480. 

  3480. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
    3481. 

  3481. </td>
    3482. 

  3482. </tr>
    3483. 

  3483. </tbody>
    3484. 

  3484. </table>
    3485. 

  3485. <hr/>
    3486. 

  3486. <p><em>
    3487. 

  3487. Generated with <code>gen-crd-api-reference-docs</code>.
    3488. 

  3488. </em></p></p>
    3489. 

  3489.                 
    3490. 

  3490.               
    3491. 

  3491.               
    3492. 

  3492.                 
    3493. 

  3493. 

  3494. 

  3495.               
    3496. 

  3496.             </article>
    3497. 

  3497.           </div>
    3498. 

  3498.         </div>
    3499. 

  3499.         
    3500. 

  3500.       </main>
    3501. 

  3501.       
    3502. 

  3502.         
    3503. 

  3503. <footer class="md-footer">
    3504. 

  3504.   
    3505. 

  3505.     <nav class="md-footer__inner md-grid" aria-label="Footer">
    3506. 

  3506.       
    3507. 

  3507.         
    3508. 

  3508.         <a href="../provider-gitlab-project-variables/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Gitlab Project Variables" rel="prev">
    3509. 

  3509.           <div class="md-footer__button md-icon">
    3510. 

  3510.             <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>
    3511. 

  3511.           </div>
    3512. 

  3512.           <div class="md-footer__title">
    3513. 

  3513.             <div class="md-ellipsis">
    3514. 

  3514.               <span class="md-footer__direction">
    3515. 

  3515.                 Previous
    3516. 

  3516.               </span>
    3517. 

  3517.               Gitlab Project Variables
    3518. 

  3518.             </div>
    3519. 

  3519.           </div>
    3520. 

  3520.         </a>
    3521. 

  3521.       
    3522. 

  3522.       
    3523. 

  3523.         
    3524. 

  3524.         <a href="../contributing-devguide/" class="md-footer__link md-footer__link--next" aria-label="Next: Developer guide" rel="next">
    3525. 

  3525.           <div class="md-footer__title">
    3526. 

  3526.             <div class="md-ellipsis">
    3527. 

  3527.               <span class="md-footer__direction">
    3528. 

  3528.                 Next
    3529. 

  3529.               </span>
    3530. 

  3530.               Developer guide
    3531. 

  3531.             </div>
    3532. 

  3532.           </div>
    3533. 

  3533.           <div class="md-footer__button md-icon">
    3534. 

  3534.             <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>
    3535. 

  3535.           </div>
    3536. 

  3536.         </a>
    3537. 

  3537.       
    3538. 

  3538.     </nav>
    3539. 

  3539.   
    3540. 

  3540.   <div class="md-footer-meta md-typeset">
    3541. 

  3541.     <div class="md-footer-meta__inner md-grid">
    3542. 

  3542.       <div class="md-footer-copyright">
    3543. 

  3543.         
    3544. 

  3544.         Made with
    3545. 

  3545.         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
    3546. 

  3546.           Material for MkDocs
    3547. 

  3547.         </a>
    3548. 

  3548.         
    3549. 

  3549.       </div>
    3550. 

  3550.       
    3551. 

  3551.     </div>
    3552. 

  3552.   </div>
    3553. 

  3553. </footer>
    3554. 

  3554.       
    3555. 

  3555.     </div>
    3556. 

  3556.     <div class="md-dialog" data-md-component="dialog">
    3557. 

  3557.       <div class="md-dialog__inner md-typeset"></div>
    3558. 

  3558.     </div>
    3559. 

  3559.     <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>
    3560. 

  3560.     
    3561. 

  3561.     
    3562. 

  3562.       <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
    3563. 

  3563.       
    3564. 

  3564.     
    3565. 

  3565.   </body>
    3566. 

  3566. </html>
    3567.