index.html 94 KB

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