index.html 91 KB

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