index.html 101 KB

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