index.html 103 KB

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