index.html 93 KB

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