index.html 91 KB

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