index.html 118 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="icon" href="../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
  8. <title>API specification - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. </div>
  24. <div data-md-component="announce">
  25. </div>
  26. <div data-md-component="outdated" hidden>
  27. <aside class="md-banner md-banner--warning">
  28. <div class="md-banner__inner md-grid md-typeset">
  29. You're not viewing the latest version.
  30. <a href="../..">
  31. <strong>Click here to go to latest.</strong>
  32. </a>
  33. </div>
  34. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  35. </aside>
  36. </div>
  37. <header class="md-header" data-md-component="header">
  38. <nav class="md-header__inner md-grid" aria-label="Header">
  39. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  40. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  41. </a>
  42. <label class="md-header__button md-icon" for="__drawer">
  43. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  44. </label>
  45. <div class="md-header__title" data-md-component="header-title">
  46. <div class="md-header__ellipsis">
  47. <div class="md-header__topic">
  48. <span class="md-ellipsis">
  49. External Secrets Operator
  50. </span>
  51. </div>
  52. <div class="md-header__topic" data-md-component="header-topic">
  53. <span class="md-ellipsis">
  54. API specification
  55. </span>
  56. </div>
  57. </div>
  58. </div>
  59. <label class="md-header__button md-icon" for="__search">
  60. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  61. </label>
  62. <div class="md-search" data-md-component="search" role="dialog">
  63. <label class="md-search__overlay" for="__search"></label>
  64. <div class="md-search__inner" role="search">
  65. <form class="md-search__form" name="search">
  66. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  67. <label class="md-search__icon md-icon" for="__search">
  68. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  69. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  70. </label>
  71. <nav class="md-search__options" aria-label="Search">
  72. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  73. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  74. </button>
  75. </nav>
  76. </form>
  77. <div class="md-search__output">
  78. <div class="md-search__scrollwrap" data-md-scrollfix>
  79. <div class="md-search-result" data-md-component="search-result">
  80. <div class="md-search-result__meta">
  81. Initializing search
  82. </div>
  83. <ol class="md-search-result__list"></ol>
  84. </div>
  85. </div>
  86. </div>
  87. </div>
  88. </div>
  89. <div class="md-header__source">
  90. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  91. <div class="md-source__icon md-icon">
  92. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  93. </div>
  94. <div class="md-source__repository">
  95. External Secrets Operator
  96. </div>
  97. </a>
  98. </div>
  99. </nav>
  100. </header>
  101. <div class="md-container" data-md-component="container">
  102. <main class="md-main" data-md-component="main">
  103. <div class="md-main__inner md-grid">
  104. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  105. <div class="md-sidebar__scrollwrap">
  106. <div class="md-sidebar__inner">
  107. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  108. <label class="md-nav__title" for="__drawer">
  109. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  110. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  111. </a>
  112. External Secrets Operator
  113. </label>
  114. <div class="md-nav__source">
  115. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  116. <div class="md-source__icon md-icon">
  117. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  118. </div>
  119. <div class="md-source__repository">
  120. External Secrets Operator
  121. </div>
  122. </a>
  123. </div>
  124. <ul class="md-nav__list" data-md-scrollfix>
  125. <li class="md-nav__item">
  126. <a href=".." class="md-nav__link">
  127. Introduction
  128. </a>
  129. </li>
  130. <li class="md-nav__item">
  131. <a href="../api-overview/" class="md-nav__link">
  132. Overview
  133. </a>
  134. </li>
  135. <li class="md-nav__item md-nav__item--nested">
  136. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  137. <label class="md-nav__link" for="__nav_3">
  138. API Types
  139. <span class="md-nav__icon md-icon"></span>
  140. </label>
  141. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  142. <label class="md-nav__title" for="__nav_3">
  143. <span class="md-nav__icon md-icon"></span>
  144. API Types
  145. </label>
  146. <ul class="md-nav__list" data-md-scrollfix>
  147. <li class="md-nav__item">
  148. <a href="../api-externalsecret/" class="md-nav__link">
  149. ExternalSecret
  150. </a>
  151. </li>
  152. <li class="md-nav__item">
  153. <a href="../api-secretstore/" class="md-nav__link">
  154. SecretStore
  155. </a>
  156. </li>
  157. <li class="md-nav__item">
  158. <a href="../api-clustersecretstore/" class="md-nav__link">
  159. ClusterSecretStore
  160. </a>
  161. </li>
  162. <li class="md-nav__item">
  163. <a href="../api-clusterexternalsecret/" class="md-nav__link">
  164. ClusterExternalSecret
  165. </a>
  166. </li>
  167. </ul>
  168. </nav>
  169. </li>
  170. <li class="md-nav__item md-nav__item--nested">
  171. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  172. <label class="md-nav__link" for="__nav_4">
  173. Guides
  174. <span class="md-nav__icon md-icon"></span>
  175. </label>
  176. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  177. <label class="md-nav__title" for="__nav_4">
  178. <span class="md-nav__icon md-icon"></span>
  179. Guides
  180. </label>
  181. <ul class="md-nav__list" data-md-scrollfix>
  182. <li class="md-nav__item">
  183. <a href="../guides-introduction/" class="md-nav__link">
  184. Introduction
  185. </a>
  186. </li>
  187. <li class="md-nav__item">
  188. <a href="../guides-getting-started/" class="md-nav__link">
  189. Getting started
  190. </a>
  191. </li>
  192. <li class="md-nav__item md-nav__item--nested">
  193. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  194. <label class="md-nav__link" for="__nav_4_3">
  195. Advanced Templating
  196. <span class="md-nav__icon md-icon"></span>
  197. </label>
  198. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  199. <label class="md-nav__title" for="__nav_4_3">
  200. <span class="md-nav__icon md-icon"></span>
  201. Advanced Templating
  202. </label>
  203. <ul class="md-nav__list" data-md-scrollfix>
  204. <li class="md-nav__item">
  205. <a href="../guides-templating/" class="md-nav__link">
  206. v2
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../guides-templating-v1/" class="md-nav__link">
  211. v1
  212. </a>
  213. </li>
  214. </ul>
  215. </nav>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  219. All keys, One secret
  220. </a>
  221. </li>
  222. <li class="md-nav__item">
  223. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  224. Common K8S Secret Types
  225. </a>
  226. </li>
  227. <li class="md-nav__item">
  228. <a href="../guides-controller-class/" class="md-nav__link">
  229. Controller Classes
  230. </a>
  231. </li>
  232. <li class="md-nav__item">
  233. <a href="../guides-ownership-deletion-policy/" class="md-nav__link">
  234. Lifecycle: ownership & deletion
  235. </a>
  236. </li>
  237. <li class="md-nav__item">
  238. <a href="../guides-getallsecrets/" class="md-nav__link">
  239. Getting Multiple Secrets
  240. </a>
  241. </li>
  242. <li class="md-nav__item">
  243. <a href="../guides-multi-tenancy/" class="md-nav__link">
  244. Multi Tenancy
  245. </a>
  246. </li>
  247. <li class="md-nav__item">
  248. <a href="../guides-metrics/" class="md-nav__link">
  249. Metrics
  250. </a>
  251. </li>
  252. <li class="md-nav__item">
  253. <a href="../guides-v1beta1/" class="md-nav__link">
  254. Upgrading to v1beta1
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="../guides-using-latest-image/" class="md-nav__link">
  259. Using Latest Image
  260. </a>
  261. </li>
  262. </ul>
  263. </nav>
  264. </li>
  265. <li class="md-nav__item md-nav__item--nested">
  266. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  267. <label class="md-nav__link" for="__nav_5">
  268. Provider
  269. <span class="md-nav__icon md-icon"></span>
  270. </label>
  271. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  272. <label class="md-nav__title" for="__nav_5">
  273. <span class="md-nav__icon md-icon"></span>
  274. Provider
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item md-nav__item--nested">
  278. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  279. <label class="md-nav__link" for="__nav_5_1">
  280. AWS
  281. <span class="md-nav__icon md-icon"></span>
  282. </label>
  283. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  284. <label class="md-nav__title" for="__nav_5_1">
  285. <span class="md-nav__icon md-icon"></span>
  286. AWS
  287. </label>
  288. <ul class="md-nav__list" data-md-scrollfix>
  289. <li class="md-nav__item">
  290. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  291. Secrets Manager
  292. </a>
  293. </li>
  294. <li class="md-nav__item">
  295. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  296. Parameter Store
  297. </a>
  298. </li>
  299. </ul>
  300. </nav>
  301. </li>
  302. <li class="md-nav__item md-nav__item--nested">
  303. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  304. <label class="md-nav__link" for="__nav_5_2">
  305. Azure
  306. <span class="md-nav__icon md-icon"></span>
  307. </label>
  308. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  309. <label class="md-nav__title" for="__nav_5_2">
  310. <span class="md-nav__icon md-icon"></span>
  311. Azure
  312. </label>
  313. <ul class="md-nav__list" data-md-scrollfix>
  314. <li class="md-nav__item">
  315. <a href="../provider-azure-key-vault/" class="md-nav__link">
  316. Key Vault
  317. </a>
  318. </li>
  319. </ul>
  320. </nav>
  321. </li>
  322. <li class="md-nav__item md-nav__item--nested">
  323. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  324. <label class="md-nav__link" for="__nav_5_3">
  325. Google
  326. <span class="md-nav__icon md-icon"></span>
  327. </label>
  328. <nav class="md-nav" aria-label="Google" data-md-level="2">
  329. <label class="md-nav__title" for="__nav_5_3">
  330. <span class="md-nav__icon md-icon"></span>
  331. Google
  332. </label>
  333. <ul class="md-nav__list" data-md-scrollfix>
  334. <li class="md-nav__item">
  335. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  336. Secret Manager
  337. </a>
  338. </li>
  339. </ul>
  340. </nav>
  341. </li>
  342. <li class="md-nav__item md-nav__item--nested">
  343. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  344. <label class="md-nav__link" for="__nav_5_4">
  345. IBM
  346. <span class="md-nav__icon md-icon"></span>
  347. </label>
  348. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  349. <label class="md-nav__title" for="__nav_5_4">
  350. <span class="md-nav__icon md-icon"></span>
  351. IBM
  352. </label>
  353. <ul class="md-nav__list" data-md-scrollfix>
  354. <li class="md-nav__item">
  355. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  356. Secrets Manager
  357. </a>
  358. </li>
  359. </ul>
  360. </nav>
  361. </li>
  362. <li class="md-nav__item">
  363. <a href="../provider-akeyless/" class="md-nav__link">
  364. Akeyless
  365. </a>
  366. </li>
  367. <li class="md-nav__item">
  368. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  369. HashiCorp Vault
  370. </a>
  371. </li>
  372. <li class="md-nav__item md-nav__item--nested">
  373. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  374. <label class="md-nav__link" for="__nav_5_7">
  375. Yandex
  376. <span class="md-nav__icon md-icon"></span>
  377. </label>
  378. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  379. <label class="md-nav__title" for="__nav_5_7">
  380. <span class="md-nav__icon md-icon"></span>
  381. Yandex
  382. </label>
  383. <ul class="md-nav__list" data-md-scrollfix>
  384. <li class="md-nav__item">
  385. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  386. Lockbox
  387. </a>
  388. </li>
  389. </ul>
  390. </nav>
  391. </li>
  392. <li class="md-nav__item md-nav__item--nested">
  393. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  394. <label class="md-nav__link" for="__nav_5_8">
  395. Gitlab
  396. <span class="md-nav__icon md-icon"></span>
  397. </label>
  398. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  399. <label class="md-nav__title" for="__nav_5_8">
  400. <span class="md-nav__icon md-icon"></span>
  401. Gitlab
  402. </label>
  403. <ul class="md-nav__list" data-md-scrollfix>
  404. <li class="md-nav__item">
  405. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  406. Gitlab Project Variables
  407. </a>
  408. </li>
  409. </ul>
  410. </nav>
  411. </li>
  412. <li class="md-nav__item md-nav__item--nested">
  413. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  414. <label class="md-nav__link" for="__nav_5_9">
  415. Oracle
  416. <span class="md-nav__icon md-icon"></span>
  417. </label>
  418. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  419. <label class="md-nav__title" for="__nav_5_9">
  420. <span class="md-nav__icon md-icon"></span>
  421. Oracle
  422. </label>
  423. <ul class="md-nav__list" data-md-scrollfix>
  424. <li class="md-nav__item">
  425. <a href="../provider-oracle-vault/" class="md-nav__link">
  426. Oracle Vault
  427. </a>
  428. </li>
  429. </ul>
  430. </nav>
  431. </li>
  432. <li class="md-nav__item">
  433. <a href="../provider-webhook/" class="md-nav__link">
  434. Webhook
  435. </a>
  436. </li>
  437. <li class="md-nav__item">
  438. <a href="../provider-fake/" class="md-nav__link">
  439. Fake
  440. </a>
  441. </li>
  442. <li class="md-nav__item">
  443. <a href="../provider-kubernetes/" class="md-nav__link">
  444. Kubernetes
  445. </a>
  446. </li>
  447. </ul>
  448. </nav>
  449. </li>
  450. <li class="md-nav__item md-nav__item--nested">
  451. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  452. <label class="md-nav__link" for="__nav_6">
  453. Examples
  454. <span class="md-nav__icon md-icon"></span>
  455. </label>
  456. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  457. <label class="md-nav__title" for="__nav_6">
  458. <span class="md-nav__icon md-icon"></span>
  459. Examples
  460. </label>
  461. <ul class="md-nav__list" data-md-scrollfix>
  462. <li class="md-nav__item">
  463. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  464. FluxCD
  465. </a>
  466. </li>
  467. <li class="md-nav__item">
  468. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  469. Anchore Engine
  470. </a>
  471. </li>
  472. <li class="md-nav__item">
  473. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  474. Jenkins
  475. </a>
  476. </li>
  477. </ul>
  478. </nav>
  479. </li>
  480. <li class="md-nav__item md-nav__item--nested">
  481. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  482. <label class="md-nav__link" for="__nav_7">
  483. External Resources
  484. <span class="md-nav__icon md-icon"></span>
  485. </label>
  486. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  487. <label class="md-nav__title" for="__nav_7">
  488. <span class="md-nav__icon md-icon"></span>
  489. External Resources
  490. </label>
  491. <ul class="md-nav__list" data-md-scrollfix>
  492. <li class="md-nav__item">
  493. <a href="../eso-talks/" class="md-nav__link">
  494. Talks
  495. </a>
  496. </li>
  497. <li class="md-nav__item">
  498. <a href="../eso-demos/" class="md-nav__link">
  499. Demos
  500. </a>
  501. </li>
  502. <li class="md-nav__item">
  503. <a href="../eso-blogs/" class="md-nav__link">
  504. Blogs
  505. </a>
  506. </li>
  507. </ul>
  508. </nav>
  509. </li>
  510. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  511. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" checked>
  512. <label class="md-nav__link" for="__nav_8">
  513. References
  514. <span class="md-nav__icon md-icon"></span>
  515. </label>
  516. <nav class="md-nav" aria-label="References" data-md-level="1">
  517. <label class="md-nav__title" for="__nav_8">
  518. <span class="md-nav__icon md-icon"></span>
  519. References
  520. </label>
  521. <ul class="md-nav__list" data-md-scrollfix>
  522. <li class="md-nav__item md-nav__item--active">
  523. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  524. <a href="./" class="md-nav__link md-nav__link--active">
  525. API specification
  526. </a>
  527. </li>
  528. </ul>
  529. </nav>
  530. </li>
  531. <li class="md-nav__item md-nav__item--nested">
  532. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  533. <label class="md-nav__link" for="__nav_9">
  534. Contributing
  535. <span class="md-nav__icon md-icon"></span>
  536. </label>
  537. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  538. <label class="md-nav__title" for="__nav_9">
  539. <span class="md-nav__icon md-icon"></span>
  540. Contributing
  541. </label>
  542. <ul class="md-nav__list" data-md-scrollfix>
  543. <li class="md-nav__item">
  544. <a href="../contributing-devguide/" class="md-nav__link">
  545. Developer guide
  546. </a>
  547. </li>
  548. <li class="md-nav__item">
  549. <a href="../contributing-process/" class="md-nav__link">
  550. Contributing Process
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../contributing-release/" class="md-nav__link">
  555. Release Process
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../contributing-coc/" class="md-nav__link">
  560. Code of Conduct
  561. </a>
  562. </li>
  563. </ul>
  564. </nav>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="../deprecation-policy/" class="md-nav__link">
  568. Deprecation Policy
  569. </a>
  570. </li>
  571. </ul>
  572. </nav>
  573. </div>
  574. </div>
  575. </div>
  576. <div class="md-content" data-md-component="content">
  577. <article class="md-content__inner md-typeset">
  578. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/spec.md" title="Edit this page" class="md-content__button md-icon">
  579. <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>
  580. </a>
  581. <h1>API specification</h1>
  582. <p>Packages:</p>
  583. <ul>
  584. <li>
  585. <a href="#external-secrets.io%2fv1beta1">external-secrets.io/v1beta1</a>
  586. </li>
  587. </ul>
  588. <h2 id="external-secrets.io/v1beta1">external-secrets.io/v1beta1</h2>
  589. <p>
  590. <p>Package v1beta1 contains resources for external-secrets</p>
  591. </p>
  592. <p>Resource Types:</p>
  593. <ul></ul>
  594. <h3 id="external-secrets.io/v1beta1.AWSAuth">AWSAuth
  595. </h3>
  596. <p>
  597. (<em>Appears on:</em>
  598. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  599. </p>
  600. <p>
  601. <p>AWSAuth tells the controller how to do authentication with aws.
  602. Only one of secretRef or jwt can be specified.
  603. if none is specified the controller will load credentials using the aws sdk defaults.</p>
  604. </p>
  605. <table>
  606. <thead>
  607. <tr>
  608. <th>Field</th>
  609. <th>Description</th>
  610. </tr>
  611. </thead>
  612. <tbody>
  613. <tr>
  614. <td>
  615. <code>secretRef</code></br>
  616. <em>
  617. <a href="#external-secrets.io/v1beta1.AWSAuthSecretRef">
  618. AWSAuthSecretRef
  619. </a>
  620. </em>
  621. </td>
  622. <td>
  623. <em>(Optional)</em>
  624. </td>
  625. </tr>
  626. <tr>
  627. <td>
  628. <code>jwt</code></br>
  629. <em>
  630. <a href="#external-secrets.io/v1beta1.AWSJWTAuth">
  631. AWSJWTAuth
  632. </a>
  633. </em>
  634. </td>
  635. <td>
  636. <em>(Optional)</em>
  637. </td>
  638. </tr>
  639. </tbody>
  640. </table>
  641. <h3 id="external-secrets.io/v1beta1.AWSAuthSecretRef">AWSAuthSecretRef
  642. </h3>
  643. <p>
  644. (<em>Appears on:</em>
  645. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  646. </p>
  647. <p>
  648. <p>AWSAuthSecretRef holds secret references for AWS credentials
  649. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  650. </p>
  651. <table>
  652. <thead>
  653. <tr>
  654. <th>Field</th>
  655. <th>Description</th>
  656. </tr>
  657. </thead>
  658. <tbody>
  659. <tr>
  660. <td>
  661. <code>accessKeyIDSecretRef</code></br>
  662. <em>
  663. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  664. </em>
  665. </td>
  666. <td>
  667. <p>The AccessKeyID is used for authentication</p>
  668. </td>
  669. </tr>
  670. <tr>
  671. <td>
  672. <code>secretAccessKeySecretRef</code></br>
  673. <em>
  674. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  675. </em>
  676. </td>
  677. <td>
  678. <p>The SecretAccessKey is used for authentication</p>
  679. </td>
  680. </tr>
  681. </tbody>
  682. </table>
  683. <h3 id="external-secrets.io/v1beta1.AWSJWTAuth">AWSJWTAuth
  684. </h3>
  685. <p>
  686. (<em>Appears on:</em>
  687. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  688. </p>
  689. <p>
  690. <p>Authenticate against AWS using service account tokens.</p>
  691. </p>
  692. <table>
  693. <thead>
  694. <tr>
  695. <th>Field</th>
  696. <th>Description</th>
  697. </tr>
  698. </thead>
  699. <tbody>
  700. <tr>
  701. <td>
  702. <code>serviceAccountRef</code></br>
  703. <em>
  704. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  705. </em>
  706. </td>
  707. <td>
  708. </td>
  709. </tr>
  710. </tbody>
  711. </table>
  712. <h3 id="external-secrets.io/v1beta1.AWSProvider">AWSProvider
  713. </h3>
  714. <p>
  715. (<em>Appears on:</em>
  716. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  717. </p>
  718. <p>
  719. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  720. </p>
  721. <table>
  722. <thead>
  723. <tr>
  724. <th>Field</th>
  725. <th>Description</th>
  726. </tr>
  727. </thead>
  728. <tbody>
  729. <tr>
  730. <td>
  731. <code>service</code></br>
  732. <em>
  733. <a href="#external-secrets.io/v1beta1.AWSServiceType">
  734. AWSServiceType
  735. </a>
  736. </em>
  737. </td>
  738. <td>
  739. <p>Service defines which service should be used to fetch the secrets</p>
  740. </td>
  741. </tr>
  742. <tr>
  743. <td>
  744. <code>auth</code></br>
  745. <em>
  746. <a href="#external-secrets.io/v1beta1.AWSAuth">
  747. AWSAuth
  748. </a>
  749. </em>
  750. </td>
  751. <td>
  752. <em>(Optional)</em>
  753. <p>Auth defines the information necessary to authenticate against AWS
  754. if not set aws sdk will infer credentials from your environment
  755. 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>
  756. </td>
  757. </tr>
  758. <tr>
  759. <td>
  760. <code>role</code></br>
  761. <em>
  762. string
  763. </em>
  764. </td>
  765. <td>
  766. <em>(Optional)</em>
  767. <p>Role is a Role ARN which the SecretManager provider will assume</p>
  768. </td>
  769. </tr>
  770. <tr>
  771. <td>
  772. <code>region</code></br>
  773. <em>
  774. string
  775. </em>
  776. </td>
  777. <td>
  778. <p>AWS Region to be used for the provider</p>
  779. </td>
  780. </tr>
  781. </tbody>
  782. </table>
  783. <h3 id="external-secrets.io/v1beta1.AWSServiceType">AWSServiceType
  784. (<code>string</code> alias)</p></h3>
  785. <p>
  786. (<em>Appears on:</em>
  787. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  788. </p>
  789. <p>
  790. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  791. </p>
  792. <table>
  793. <thead>
  794. <tr>
  795. <th>Value</th>
  796. <th>Description</th>
  797. </tr>
  798. </thead>
  799. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  800. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore.
  801. 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>
  802. </td>
  803. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  804. <td><p>AWSServiceSecretsManager is the AWS SecretsManager.
  805. 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>
  806. </td>
  807. </tr></tbody>
  808. </table>
  809. <h3 id="external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth
  810. </h3>
  811. <p>
  812. (<em>Appears on:</em>
  813. <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>)
  814. </p>
  815. <p>
  816. </p>
  817. <table>
  818. <thead>
  819. <tr>
  820. <th>Field</th>
  821. <th>Description</th>
  822. </tr>
  823. </thead>
  824. <tbody>
  825. <tr>
  826. <td>
  827. <code>secretRef</code></br>
  828. <em>
  829. <a href="#external-secrets.io/v1beta1.AkeylessAuthSecretRef">
  830. AkeylessAuthSecretRef
  831. </a>
  832. </em>
  833. </td>
  834. <td>
  835. </td>
  836. </tr>
  837. </tbody>
  838. </table>
  839. <h3 id="external-secrets.io/v1beta1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
  840. </h3>
  841. <p>
  842. (<em>Appears on:</em>
  843. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  844. </p>
  845. <p>
  846. <p>AkeylessAuthSecretRef
  847. AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
  848. </p>
  849. <table>
  850. <thead>
  851. <tr>
  852. <th>Field</th>
  853. <th>Description</th>
  854. </tr>
  855. </thead>
  856. <tbody>
  857. <tr>
  858. <td>
  859. <code>accessID</code></br>
  860. <em>
  861. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  862. </em>
  863. </td>
  864. <td>
  865. <p>The SecretAccessID is used for authentication</p>
  866. </td>
  867. </tr>
  868. <tr>
  869. <td>
  870. <code>accessType</code></br>
  871. <em>
  872. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  873. </em>
  874. </td>
  875. <td>
  876. </td>
  877. </tr>
  878. <tr>
  879. <td>
  880. <code>accessTypeParam</code></br>
  881. <em>
  882. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  883. </em>
  884. </td>
  885. <td>
  886. </td>
  887. </tr>
  888. </tbody>
  889. </table>
  890. <h3 id="external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider
  891. </h3>
  892. <p>
  893. (<em>Appears on:</em>
  894. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  895. </p>
  896. <p>
  897. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  898. </p>
  899. <table>
  900. <thead>
  901. <tr>
  902. <th>Field</th>
  903. <th>Description</th>
  904. </tr>
  905. </thead>
  906. <tbody>
  907. <tr>
  908. <td>
  909. <code>akeylessGWApiURL</code></br>
  910. <em>
  911. string
  912. </em>
  913. </td>
  914. <td>
  915. <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
  916. </td>
  917. </tr>
  918. <tr>
  919. <td>
  920. <code>authSecretRef</code></br>
  921. <em>
  922. <a href="#external-secrets.io/v1beta1.AkeylessAuth">
  923. AkeylessAuth
  924. </a>
  925. </em>
  926. </td>
  927. <td>
  928. <p>Auth configures how the operator authenticates with Akeyless.</p>
  929. </td>
  930. </tr>
  931. </tbody>
  932. </table>
  933. <h3 id="external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth
  934. </h3>
  935. <p>
  936. (<em>Appears on:</em>
  937. <a href="#external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider</a>)
  938. </p>
  939. <p>
  940. <p>AlibabaAuth contains a secretRef for credentials.</p>
  941. </p>
  942. <table>
  943. <thead>
  944. <tr>
  945. <th>Field</th>
  946. <th>Description</th>
  947. </tr>
  948. </thead>
  949. <tbody>
  950. <tr>
  951. <td>
  952. <code>secretRef</code></br>
  953. <em>
  954. <a href="#external-secrets.io/v1beta1.AlibabaAuthSecretRef">
  955. AlibabaAuthSecretRef
  956. </a>
  957. </em>
  958. </td>
  959. <td>
  960. </td>
  961. </tr>
  962. </tbody>
  963. </table>
  964. <h3 id="external-secrets.io/v1beta1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
  965. </h3>
  966. <p>
  967. (<em>Appears on:</em>
  968. <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
  969. </p>
  970. <p>
  971. <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
  972. </p>
  973. <table>
  974. <thead>
  975. <tr>
  976. <th>Field</th>
  977. <th>Description</th>
  978. </tr>
  979. </thead>
  980. <tbody>
  981. <tr>
  982. <td>
  983. <code>accessKeyIDSecretRef</code></br>
  984. <em>
  985. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  986. </em>
  987. </td>
  988. <td>
  989. <p>The AccessKeyID is used for authentication</p>
  990. </td>
  991. </tr>
  992. <tr>
  993. <td>
  994. <code>accessKeySecretSecretRef</code></br>
  995. <em>
  996. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  997. </em>
  998. </td>
  999. <td>
  1000. <p>The AccessKeySecret is used for authentication</p>
  1001. </td>
  1002. </tr>
  1003. </tbody>
  1004. </table>
  1005. <h3 id="external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider
  1006. </h3>
  1007. <p>
  1008. (<em>Appears on:</em>
  1009. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1010. </p>
  1011. <p>
  1012. <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
  1013. </p>
  1014. <table>
  1015. <thead>
  1016. <tr>
  1017. <th>Field</th>
  1018. <th>Description</th>
  1019. </tr>
  1020. </thead>
  1021. <tbody>
  1022. <tr>
  1023. <td>
  1024. <code>auth</code></br>
  1025. <em>
  1026. <a href="#external-secrets.io/v1beta1.AlibabaAuth">
  1027. AlibabaAuth
  1028. </a>
  1029. </em>
  1030. </td>
  1031. <td>
  1032. </td>
  1033. </tr>
  1034. <tr>
  1035. <td>
  1036. <code>endpoint</code></br>
  1037. <em>
  1038. string
  1039. </em>
  1040. </td>
  1041. <td>
  1042. <em>(Optional)</em>
  1043. </td>
  1044. </tr>
  1045. <tr>
  1046. <td>
  1047. <code>regionID</code></br>
  1048. <em>
  1049. string
  1050. </em>
  1051. </td>
  1052. <td>
  1053. <p>Alibaba Region to be used for the provider</p>
  1054. </td>
  1055. </tr>
  1056. </tbody>
  1057. </table>
  1058. <h3 id="external-secrets.io/v1beta1.AzureAuthType">AzureAuthType
  1059. (<code>string</code> alias)</p></h3>
  1060. <p>
  1061. (<em>Appears on:</em>
  1062. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1063. </p>
  1064. <p>
  1065. <p>AuthType describes how to authenticate to the Azure Keyvault
  1066. Only one of the following auth types may be specified.
  1067. If none of the following auth type is specified, the default one
  1068. is ServicePrincipal.</p>
  1069. </p>
  1070. <table>
  1071. <thead>
  1072. <tr>
  1073. <th>Value</th>
  1074. <th>Description</th>
  1075. </tr>
  1076. </thead>
  1077. <tbody><tr><td><p>&#34;ManagedIdentity&#34;</p></td>
  1078. <td><p>Using Managed Identity to authenticate. Used with aad-pod-identity installed in the clister.</p>
  1079. </td>
  1080. </tr><tr><td><p>&#34;ServicePrincipal&#34;</p></td>
  1081. <td><p>Using service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.</p>
  1082. </td>
  1083. </tr><tr><td><p>&#34;WorkloadIdentity&#34;</p></td>
  1084. <td><p>Using Workload Identity service accounts to authenticate.</p>
  1085. </td>
  1086. </tr></tbody>
  1087. </table>
  1088. <h3 id="external-secrets.io/v1beta1.AzureKVAuth">AzureKVAuth
  1089. </h3>
  1090. <p>
  1091. (<em>Appears on:</em>
  1092. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1093. </p>
  1094. <p>
  1095. <p>Configuration used to authenticate with Azure.</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>clientId</code></br>
  1108. <em>
  1109. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1110. </em>
  1111. </td>
  1112. <td>
  1113. <em>(Optional)</em>
  1114. <p>The Azure clientId of the service principle used for authentication.</p>
  1115. </td>
  1116. </tr>
  1117. <tr>
  1118. <td>
  1119. <code>clientSecret</code></br>
  1120. <em>
  1121. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1122. </em>
  1123. </td>
  1124. <td>
  1125. <em>(Optional)</em>
  1126. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  1127. </td>
  1128. </tr>
  1129. </tbody>
  1130. </table>
  1131. <h3 id="external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider
  1132. </h3>
  1133. <p>
  1134. (<em>Appears on:</em>
  1135. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1136. </p>
  1137. <p>
  1138. <p>Configures an store to sync secrets using Azure KV.</p>
  1139. </p>
  1140. <table>
  1141. <thead>
  1142. <tr>
  1143. <th>Field</th>
  1144. <th>Description</th>
  1145. </tr>
  1146. </thead>
  1147. <tbody>
  1148. <tr>
  1149. <td>
  1150. <code>authType</code></br>
  1151. <em>
  1152. <a href="#external-secrets.io/v1beta1.AzureAuthType">
  1153. AzureAuthType
  1154. </a>
  1155. </em>
  1156. </td>
  1157. <td>
  1158. <em>(Optional)</em>
  1159. <p>Auth type defines how to authenticate to the keyvault service.
  1160. Valid values are:
  1161. - &ldquo;ServicePrincipal&rdquo; (default): Using a service principal (tenantId, clientId, clientSecret)
  1162. - &ldquo;ManagedIdentity&rdquo;: Using Managed Identity assigned to the pod (see aad-pod-identity)</p>
  1163. </td>
  1164. </tr>
  1165. <tr>
  1166. <td>
  1167. <code>vaultUrl</code></br>
  1168. <em>
  1169. string
  1170. </em>
  1171. </td>
  1172. <td>
  1173. <p>Vault Url from which the secrets to be fetched from.</p>
  1174. </td>
  1175. </tr>
  1176. <tr>
  1177. <td>
  1178. <code>tenantId</code></br>
  1179. <em>
  1180. string
  1181. </em>
  1182. </td>
  1183. <td>
  1184. <em>(Optional)</em>
  1185. <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type.</p>
  1186. </td>
  1187. </tr>
  1188. <tr>
  1189. <td>
  1190. <code>authSecretRef</code></br>
  1191. <em>
  1192. <a href="#external-secrets.io/v1beta1.AzureKVAuth">
  1193. AzureKVAuth
  1194. </a>
  1195. </em>
  1196. </td>
  1197. <td>
  1198. <em>(Optional)</em>
  1199. <p>Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type.</p>
  1200. </td>
  1201. </tr>
  1202. <tr>
  1203. <td>
  1204. <code>serviceAccountRef</code></br>
  1205. <em>
  1206. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  1207. </em>
  1208. </td>
  1209. <td>
  1210. <em>(Optional)</em>
  1211. <p>ServiceAccountRef specified the service account
  1212. that should be used when authenticating with WorkloadIdentity.</p>
  1213. </td>
  1214. </tr>
  1215. <tr>
  1216. <td>
  1217. <code>identityId</code></br>
  1218. <em>
  1219. string
  1220. </em>
  1221. </td>
  1222. <td>
  1223. <em>(Optional)</em>
  1224. <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
  1225. </td>
  1226. </tr>
  1227. </tbody>
  1228. </table>
  1229. <h3 id="external-secrets.io/v1beta1.CAProvider">CAProvider
  1230. </h3>
  1231. <p>
  1232. (<em>Appears on:</em>
  1233. <a href="#external-secrets.io/v1beta1.KubernetesServer">KubernetesServer</a>,
  1234. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  1235. </p>
  1236. <p>
  1237. <p>Defines a location to fetch the cert for the vault provider from.</p>
  1238. </p>
  1239. <table>
  1240. <thead>
  1241. <tr>
  1242. <th>Field</th>
  1243. <th>Description</th>
  1244. </tr>
  1245. </thead>
  1246. <tbody>
  1247. <tr>
  1248. <td>
  1249. <code>type</code></br>
  1250. <em>
  1251. <a href="#external-secrets.io/v1beta1.CAProviderType">
  1252. CAProviderType
  1253. </a>
  1254. </em>
  1255. </td>
  1256. <td>
  1257. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  1258. </td>
  1259. </tr>
  1260. <tr>
  1261. <td>
  1262. <code>name</code></br>
  1263. <em>
  1264. string
  1265. </em>
  1266. </td>
  1267. <td>
  1268. <p>The name of the object located at the provider type.</p>
  1269. </td>
  1270. </tr>
  1271. <tr>
  1272. <td>
  1273. <code>key</code></br>
  1274. <em>
  1275. string
  1276. </em>
  1277. </td>
  1278. <td>
  1279. <p>The key the value inside of the provider type to use, only used with &ldquo;Secret&rdquo; type</p>
  1280. </td>
  1281. </tr>
  1282. <tr>
  1283. <td>
  1284. <code>namespace</code></br>
  1285. <em>
  1286. string
  1287. </em>
  1288. </td>
  1289. <td>
  1290. <em>(Optional)</em>
  1291. <p>The namespace the Provider type is in.</p>
  1292. </td>
  1293. </tr>
  1294. </tbody>
  1295. </table>
  1296. <h3 id="external-secrets.io/v1beta1.CAProviderType">CAProviderType
  1297. (<code>string</code> alias)</p></h3>
  1298. <p>
  1299. (<em>Appears on:</em>
  1300. <a href="#external-secrets.io/v1beta1.CAProvider">CAProvider</a>)
  1301. </p>
  1302. <p>
  1303. </p>
  1304. <table>
  1305. <thead>
  1306. <tr>
  1307. <th>Value</th>
  1308. <th>Description</th>
  1309. </tr>
  1310. </thead>
  1311. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  1312. <td></td>
  1313. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  1314. <td></td>
  1315. </tr></tbody>
  1316. </table>
  1317. <h3 id="external-secrets.io/v1beta1.CertAuth">CertAuth
  1318. </h3>
  1319. <p>
  1320. (<em>Appears on:</em>
  1321. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  1322. </p>
  1323. <p>
  1324. </p>
  1325. <table>
  1326. <thead>
  1327. <tr>
  1328. <th>Field</th>
  1329. <th>Description</th>
  1330. </tr>
  1331. </thead>
  1332. <tbody>
  1333. <tr>
  1334. <td>
  1335. <code>clientCert</code></br>
  1336. <em>
  1337. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1338. </em>
  1339. </td>
  1340. <td>
  1341. </td>
  1342. </tr>
  1343. <tr>
  1344. <td>
  1345. <code>clientKey</code></br>
  1346. <em>
  1347. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1348. </em>
  1349. </td>
  1350. <td>
  1351. </td>
  1352. </tr>
  1353. </tbody>
  1354. </table>
  1355. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret
  1356. </h3>
  1357. <p>
  1358. <p>ClusterExternalSecret is the Schema for the clusterexternalsecrets API.</p>
  1359. </p>
  1360. <table>
  1361. <thead>
  1362. <tr>
  1363. <th>Field</th>
  1364. <th>Description</th>
  1365. </tr>
  1366. </thead>
  1367. <tbody>
  1368. <tr>
  1369. <td>
  1370. <code>metadata</code></br>
  1371. <em>
  1372. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1373. Kubernetes meta/v1.ObjectMeta
  1374. </a>
  1375. </em>
  1376. </td>
  1377. <td>
  1378. Refer to the Kubernetes API documentation for the fields of the
  1379. <code>metadata</code> field.
  1380. </td>
  1381. </tr>
  1382. <tr>
  1383. <td>
  1384. <code>spec</code></br>
  1385. <em>
  1386. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">
  1387. ClusterExternalSecretSpec
  1388. </a>
  1389. </em>
  1390. </td>
  1391. <td>
  1392. <br/>
  1393. <br/>
  1394. <table>
  1395. <tr>
  1396. <td>
  1397. <code>externalSecretSpec</code></br>
  1398. <em>
  1399. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  1400. ExternalSecretSpec
  1401. </a>
  1402. </em>
  1403. </td>
  1404. <td>
  1405. <p>The spec for the ExternalSecrets to be created</p>
  1406. </td>
  1407. </tr>
  1408. <tr>
  1409. <td>
  1410. <code>externalSecretName</code></br>
  1411. <em>
  1412. string
  1413. </em>
  1414. </td>
  1415. <td>
  1416. <em>(Optional)</em>
  1417. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  1418. </td>
  1419. </tr>
  1420. <tr>
  1421. <td>
  1422. <code>namespaceSelector</code></br>
  1423. <em>
  1424. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#labelselector-v1-meta">
  1425. Kubernetes meta/v1.LabelSelector
  1426. </a>
  1427. </em>
  1428. </td>
  1429. <td>
  1430. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
  1431. </td>
  1432. </tr>
  1433. <tr>
  1434. <td>
  1435. <code>refreshTime</code></br>
  1436. <em>
  1437. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1438. Kubernetes meta/v1.Duration
  1439. </a>
  1440. </em>
  1441. </td>
  1442. <td>
  1443. <p>The time in which the controller should reconcile it&rsquo;s objects and recheck namespaces for labels.</p>
  1444. </td>
  1445. </tr>
  1446. </table>
  1447. </td>
  1448. </tr>
  1449. <tr>
  1450. <td>
  1451. <code>status</code></br>
  1452. <em>
  1453. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">
  1454. ClusterExternalSecretStatus
  1455. </a>
  1456. </em>
  1457. </td>
  1458. <td>
  1459. </td>
  1460. </tr>
  1461. </tbody>
  1462. </table>
  1463. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretConditionType">ClusterExternalSecretConditionType
  1464. (<code>string</code> alias)</p></h3>
  1465. <p>
  1466. (<em>Appears on:</em>
  1467. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition</a>)
  1468. </p>
  1469. <p>
  1470. </p>
  1471. <table>
  1472. <thead>
  1473. <tr>
  1474. <th>Value</th>
  1475. <th>Description</th>
  1476. </tr>
  1477. </thead>
  1478. <tbody><tr><td><p>&#34;NotReady&#34;</p></td>
  1479. <td></td>
  1480. </tr><tr><td><p>&#34;PartiallyReady&#34;</p></td>
  1481. <td></td>
  1482. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  1483. <td></td>
  1484. </tr></tbody>
  1485. </table>
  1486. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">ClusterExternalSecretNamespaceFailure
  1487. </h3>
  1488. <p>
  1489. (<em>Appears on:</em>
  1490. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  1491. </p>
  1492. <p>
  1493. <p>ClusterExternalSecretNamespaceFailure represents a failed namespace deployment and it&rsquo;s reason.</p>
  1494. </p>
  1495. <table>
  1496. <thead>
  1497. <tr>
  1498. <th>Field</th>
  1499. <th>Description</th>
  1500. </tr>
  1501. </thead>
  1502. <tbody>
  1503. <tr>
  1504. <td>
  1505. <code>namespace</code></br>
  1506. <em>
  1507. string
  1508. </em>
  1509. </td>
  1510. <td>
  1511. <p>Namespace is the namespace that failed when trying to apply an ExternalSecret</p>
  1512. </td>
  1513. </tr>
  1514. <tr>
  1515. <td>
  1516. <code>reason</code></br>
  1517. <em>
  1518. string
  1519. </em>
  1520. </td>
  1521. <td>
  1522. <em>(Optional)</em>
  1523. <p>Reason is why the ExternalSecret failed to apply to the namespace</p>
  1524. </td>
  1525. </tr>
  1526. </tbody>
  1527. </table>
  1528. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec
  1529. </h3>
  1530. <p>
  1531. (<em>Appears on:</em>
  1532. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  1533. </p>
  1534. <p>
  1535. <p>ClusterExternalSecretSpec defines the desired state of ClusterExternalSecret.</p>
  1536. </p>
  1537. <table>
  1538. <thead>
  1539. <tr>
  1540. <th>Field</th>
  1541. <th>Description</th>
  1542. </tr>
  1543. </thead>
  1544. <tbody>
  1545. <tr>
  1546. <td>
  1547. <code>externalSecretSpec</code></br>
  1548. <em>
  1549. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  1550. ExternalSecretSpec
  1551. </a>
  1552. </em>
  1553. </td>
  1554. <td>
  1555. <p>The spec for the ExternalSecrets to be created</p>
  1556. </td>
  1557. </tr>
  1558. <tr>
  1559. <td>
  1560. <code>externalSecretName</code></br>
  1561. <em>
  1562. string
  1563. </em>
  1564. </td>
  1565. <td>
  1566. <em>(Optional)</em>
  1567. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  1568. </td>
  1569. </tr>
  1570. <tr>
  1571. <td>
  1572. <code>namespaceSelector</code></br>
  1573. <em>
  1574. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#labelselector-v1-meta">
  1575. Kubernetes meta/v1.LabelSelector
  1576. </a>
  1577. </em>
  1578. </td>
  1579. <td>
  1580. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
  1581. </td>
  1582. </tr>
  1583. <tr>
  1584. <td>
  1585. <code>refreshTime</code></br>
  1586. <em>
  1587. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1588. Kubernetes meta/v1.Duration
  1589. </a>
  1590. </em>
  1591. </td>
  1592. <td>
  1593. <p>The time in which the controller should reconcile it&rsquo;s objects and recheck namespaces for labels.</p>
  1594. </td>
  1595. </tr>
  1596. </tbody>
  1597. </table>
  1598. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus
  1599. </h3>
  1600. <p>
  1601. (<em>Appears on:</em>
  1602. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  1603. </p>
  1604. <p>
  1605. <p>ClusterExternalSecretStatus defines the observed state of ClusterExternalSecret.</p>
  1606. </p>
  1607. <table>
  1608. <thead>
  1609. <tr>
  1610. <th>Field</th>
  1611. <th>Description</th>
  1612. </tr>
  1613. </thead>
  1614. <tbody>
  1615. <tr>
  1616. <td>
  1617. <code>failedNamespaces</code></br>
  1618. <em>
  1619. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">
  1620. []ClusterExternalSecretNamespaceFailure
  1621. </a>
  1622. </em>
  1623. </td>
  1624. <td>
  1625. <em>(Optional)</em>
  1626. <p>Failed namespaces are the namespaces that failed to apply an ExternalSecret</p>
  1627. </td>
  1628. </tr>
  1629. <tr>
  1630. <td>
  1631. <code>provisionedNamespaces</code></br>
  1632. <em>
  1633. []string
  1634. </em>
  1635. </td>
  1636. <td>
  1637. <em>(Optional)</em>
  1638. <p>ProvisionedNamespaces are the namespaces where the ClusterExternalSecret has secrets</p>
  1639. </td>
  1640. </tr>
  1641. <tr>
  1642. <td>
  1643. <code>conditions</code></br>
  1644. <em>
  1645. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">
  1646. []ClusterExternalSecretStatusCondition
  1647. </a>
  1648. </em>
  1649. </td>
  1650. <td>
  1651. <em>(Optional)</em>
  1652. </td>
  1653. </tr>
  1654. </tbody>
  1655. </table>
  1656. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition
  1657. </h3>
  1658. <p>
  1659. (<em>Appears on:</em>
  1660. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  1661. </p>
  1662. <p>
  1663. </p>
  1664. <table>
  1665. <thead>
  1666. <tr>
  1667. <th>Field</th>
  1668. <th>Description</th>
  1669. </tr>
  1670. </thead>
  1671. <tbody>
  1672. <tr>
  1673. <td>
  1674. <code>type</code></br>
  1675. <em>
  1676. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretConditionType">
  1677. ClusterExternalSecretConditionType
  1678. </a>
  1679. </em>
  1680. </td>
  1681. <td>
  1682. </td>
  1683. </tr>
  1684. <tr>
  1685. <td>
  1686. <code>status</code></br>
  1687. <em>
  1688. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  1689. Kubernetes core/v1.ConditionStatus
  1690. </a>
  1691. </em>
  1692. </td>
  1693. <td>
  1694. </td>
  1695. </tr>
  1696. <tr>
  1697. <td>
  1698. <code>message</code></br>
  1699. <em>
  1700. string
  1701. </em>
  1702. </td>
  1703. <td>
  1704. <em>(Optional)</em>
  1705. </td>
  1706. </tr>
  1707. </tbody>
  1708. </table>
  1709. <h3 id="external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore
  1710. </h3>
  1711. <p>
  1712. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  1713. </p>
  1714. <table>
  1715. <thead>
  1716. <tr>
  1717. <th>Field</th>
  1718. <th>Description</th>
  1719. </tr>
  1720. </thead>
  1721. <tbody>
  1722. <tr>
  1723. <td>
  1724. <code>metadata</code></br>
  1725. <em>
  1726. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1727. Kubernetes meta/v1.ObjectMeta
  1728. </a>
  1729. </em>
  1730. </td>
  1731. <td>
  1732. Refer to the Kubernetes API documentation for the fields of the
  1733. <code>metadata</code> field.
  1734. </td>
  1735. </tr>
  1736. <tr>
  1737. <td>
  1738. <code>spec</code></br>
  1739. <em>
  1740. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  1741. SecretStoreSpec
  1742. </a>
  1743. </em>
  1744. </td>
  1745. <td>
  1746. <br/>
  1747. <br/>
  1748. <table>
  1749. <tr>
  1750. <td>
  1751. <code>controller</code></br>
  1752. <em>
  1753. string
  1754. </em>
  1755. </td>
  1756. <td>
  1757. <em>(Optional)</em>
  1758. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  1759. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  1760. </td>
  1761. </tr>
  1762. <tr>
  1763. <td>
  1764. <code>provider</code></br>
  1765. <em>
  1766. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  1767. SecretStoreProvider
  1768. </a>
  1769. </em>
  1770. </td>
  1771. <td>
  1772. <p>Used to configure the provider. Only one provider may be set</p>
  1773. </td>
  1774. </tr>
  1775. <tr>
  1776. <td>
  1777. <code>retrySettings</code></br>
  1778. <em>
  1779. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  1780. SecretStoreRetrySettings
  1781. </a>
  1782. </em>
  1783. </td>
  1784. <td>
  1785. <em>(Optional)</em>
  1786. <p>Used to configure http retries if failed</p>
  1787. </td>
  1788. </tr>
  1789. <tr>
  1790. <td>
  1791. <code>refreshInterval</code></br>
  1792. <em>
  1793. int
  1794. </em>
  1795. </td>
  1796. <td>
  1797. <em>(Optional)</em>
  1798. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  1799. </td>
  1800. </tr>
  1801. </table>
  1802. </td>
  1803. </tr>
  1804. <tr>
  1805. <td>
  1806. <code>status</code></br>
  1807. <em>
  1808. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  1809. SecretStoreStatus
  1810. </a>
  1811. </em>
  1812. </td>
  1813. <td>
  1814. </td>
  1815. </tr>
  1816. </tbody>
  1817. </table>
  1818. <h3 id="external-secrets.io/v1beta1.ExternalSecret">ExternalSecret
  1819. </h3>
  1820. <p>
  1821. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  1822. </p>
  1823. <table>
  1824. <thead>
  1825. <tr>
  1826. <th>Field</th>
  1827. <th>Description</th>
  1828. </tr>
  1829. </thead>
  1830. <tbody>
  1831. <tr>
  1832. <td>
  1833. <code>metadata</code></br>
  1834. <em>
  1835. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1836. Kubernetes meta/v1.ObjectMeta
  1837. </a>
  1838. </em>
  1839. </td>
  1840. <td>
  1841. Refer to the Kubernetes API documentation for the fields of the
  1842. <code>metadata</code> field.
  1843. </td>
  1844. </tr>
  1845. <tr>
  1846. <td>
  1847. <code>spec</code></br>
  1848. <em>
  1849. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  1850. ExternalSecretSpec
  1851. </a>
  1852. </em>
  1853. </td>
  1854. <td>
  1855. <br/>
  1856. <br/>
  1857. <table>
  1858. <tr>
  1859. <td>
  1860. <code>secretStoreRef</code></br>
  1861. <em>
  1862. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  1863. SecretStoreRef
  1864. </a>
  1865. </em>
  1866. </td>
  1867. <td>
  1868. </td>
  1869. </tr>
  1870. <tr>
  1871. <td>
  1872. <code>target</code></br>
  1873. <em>
  1874. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  1875. ExternalSecretTarget
  1876. </a>
  1877. </em>
  1878. </td>
  1879. <td>
  1880. </td>
  1881. </tr>
  1882. <tr>
  1883. <td>
  1884. <code>refreshInterval</code></br>
  1885. <em>
  1886. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1887. Kubernetes meta/v1.Duration
  1888. </a>
  1889. </em>
  1890. </td>
  1891. <td>
  1892. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  1893. 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;
  1894. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  1895. </td>
  1896. </tr>
  1897. <tr>
  1898. <td>
  1899. <code>data</code></br>
  1900. <em>
  1901. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  1902. []ExternalSecretData
  1903. </a>
  1904. </em>
  1905. </td>
  1906. <td>
  1907. <em>(Optional)</em>
  1908. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  1909. </td>
  1910. </tr>
  1911. <tr>
  1912. <td>
  1913. <code>dataFrom</code></br>
  1914. <em>
  1915. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  1916. []ExternalSecretDataFromRemoteRef
  1917. </a>
  1918. </em>
  1919. </td>
  1920. <td>
  1921. <em>(Optional)</em>
  1922. <p>DataFrom is used to fetch all properties from a specific Provider data
  1923. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  1924. </td>
  1925. </tr>
  1926. </table>
  1927. </td>
  1928. </tr>
  1929. <tr>
  1930. <td>
  1931. <code>status</code></br>
  1932. <em>
  1933. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">
  1934. ExternalSecretStatus
  1935. </a>
  1936. </em>
  1937. </td>
  1938. <td>
  1939. </td>
  1940. </tr>
  1941. </tbody>
  1942. </table>
  1943. <h3 id="external-secrets.io/v1beta1.ExternalSecretConditionType">ExternalSecretConditionType
  1944. (<code>string</code> alias)</p></h3>
  1945. <p>
  1946. (<em>Appears on:</em>
  1947. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  1948. </p>
  1949. <p>
  1950. </p>
  1951. <table>
  1952. <thead>
  1953. <tr>
  1954. <th>Value</th>
  1955. <th>Description</th>
  1956. </tr>
  1957. </thead>
  1958. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
  1959. <td></td>
  1960. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  1961. <td></td>
  1962. </tr></tbody>
  1963. </table>
  1964. <h3 id="external-secrets.io/v1beta1.ExternalSecretConversionStrategy">ExternalSecretConversionStrategy
  1965. (<code>string</code> alias)</p></h3>
  1966. <p>
  1967. (<em>Appears on:</em>
  1968. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  1969. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  1970. </p>
  1971. <p>
  1972. </p>
  1973. <table>
  1974. <thead>
  1975. <tr>
  1976. <th>Value</th>
  1977. <th>Description</th>
  1978. </tr>
  1979. </thead>
  1980. <tbody><tr><td><p>&#34;Default&#34;</p></td>
  1981. <td></td>
  1982. </tr><tr><td><p>&#34;Unicode&#34;</p></td>
  1983. <td></td>
  1984. </tr></tbody>
  1985. </table>
  1986. <h3 id="external-secrets.io/v1beta1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  1987. (<code>string</code> alias)</p></h3>
  1988. <p>
  1989. (<em>Appears on:</em>
  1990. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  1991. </p>
  1992. <p>
  1993. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  1994. </p>
  1995. <table>
  1996. <thead>
  1997. <tr>
  1998. <th>Value</th>
  1999. <th>Description</th>
  2000. </tr>
  2001. </thead>
  2002. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  2003. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  2004. </td>
  2005. </tr><tr><td><p>&#34;None&#34;</p></td>
  2006. <td><p>None does not create a Secret (future use with injector).</p>
  2007. </td>
  2008. </tr><tr><td><p>&#34;Orphan&#34;</p></td>
  2009. <td><p>Orphan creates the Secret and does not set the ownerReference.
  2010. I.e. it will be orphaned after the deletion of the ExternalSecret.</p>
  2011. </td>
  2012. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  2013. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  2014. </td>
  2015. </tr></tbody>
  2016. </table>
  2017. <h3 id="external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData
  2018. </h3>
  2019. <p>
  2020. (<em>Appears on:</em>
  2021. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2022. </p>
  2023. <p>
  2024. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  2025. </p>
  2026. <table>
  2027. <thead>
  2028. <tr>
  2029. <th>Field</th>
  2030. <th>Description</th>
  2031. </tr>
  2032. </thead>
  2033. <tbody>
  2034. <tr>
  2035. <td>
  2036. <code>secretKey</code></br>
  2037. <em>
  2038. string
  2039. </em>
  2040. </td>
  2041. <td>
  2042. </td>
  2043. </tr>
  2044. <tr>
  2045. <td>
  2046. <code>remoteRef</code></br>
  2047. <em>
  2048. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  2049. ExternalSecretDataRemoteRef
  2050. </a>
  2051. </em>
  2052. </td>
  2053. <td>
  2054. </td>
  2055. </tr>
  2056. </tbody>
  2057. </table>
  2058. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef
  2059. </h3>
  2060. <p>
  2061. (<em>Appears on:</em>
  2062. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2063. </p>
  2064. <p>
  2065. </p>
  2066. <table>
  2067. <thead>
  2068. <tr>
  2069. <th>Field</th>
  2070. <th>Description</th>
  2071. </tr>
  2072. </thead>
  2073. <tbody>
  2074. <tr>
  2075. <td>
  2076. <code>extract</code></br>
  2077. <em>
  2078. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  2079. ExternalSecretDataRemoteRef
  2080. </a>
  2081. </em>
  2082. </td>
  2083. <td>
  2084. <em>(Optional)</em>
  2085. <p>Used to extract multiple key/value pairs from one secret</p>
  2086. </td>
  2087. </tr>
  2088. <tr>
  2089. <td>
  2090. <code>find</code></br>
  2091. <em>
  2092. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">
  2093. ExternalSecretFind
  2094. </a>
  2095. </em>
  2096. </td>
  2097. <td>
  2098. <em>(Optional)</em>
  2099. <p>Used to find secrets based on tags or regular expressions</p>
  2100. </td>
  2101. </tr>
  2102. </tbody>
  2103. </table>
  2104. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  2105. </h3>
  2106. <p>
  2107. (<em>Appears on:</em>
  2108. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>,
  2109. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  2110. </p>
  2111. <p>
  2112. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  2113. </p>
  2114. <table>
  2115. <thead>
  2116. <tr>
  2117. <th>Field</th>
  2118. <th>Description</th>
  2119. </tr>
  2120. </thead>
  2121. <tbody>
  2122. <tr>
  2123. <td>
  2124. <code>key</code></br>
  2125. <em>
  2126. string
  2127. </em>
  2128. </td>
  2129. <td>
  2130. <p>Key is the key used in the Provider, mandatory</p>
  2131. </td>
  2132. </tr>
  2133. <tr>
  2134. <td>
  2135. <code>version</code></br>
  2136. <em>
  2137. string
  2138. </em>
  2139. </td>
  2140. <td>
  2141. <em>(Optional)</em>
  2142. <p>Used to select a specific version of the Provider value, if supported</p>
  2143. </td>
  2144. </tr>
  2145. <tr>
  2146. <td>
  2147. <code>property</code></br>
  2148. <em>
  2149. string
  2150. </em>
  2151. </td>
  2152. <td>
  2153. <em>(Optional)</em>
  2154. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  2155. </td>
  2156. </tr>
  2157. <tr>
  2158. <td>
  2159. <code>conversionStrategy</code></br>
  2160. <em>
  2161. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  2162. ExternalSecretConversionStrategy
  2163. </a>
  2164. </em>
  2165. </td>
  2166. <td>
  2167. <em>(Optional)</em>
  2168. <p>Used to define a conversion Strategy</p>
  2169. </td>
  2170. </tr>
  2171. </tbody>
  2172. </table>
  2173. <h3 id="external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">ExternalSecretDeletionPolicy
  2174. (<code>string</code> alias)</p></h3>
  2175. <p>
  2176. (<em>Appears on:</em>
  2177. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  2178. </p>
  2179. <p>
  2180. <p>ExternalSecretDeletionPolicy defines rules on how to delete the resulting Secret.</p>
  2181. </p>
  2182. <table>
  2183. <thead>
  2184. <tr>
  2185. <th>Value</th>
  2186. <th>Description</th>
  2187. </tr>
  2188. </thead>
  2189. <tbody><tr><td><p>&#34;Delete&#34;</p></td>
  2190. <td><p>Delete deletes the secret if all provider secrets are deleted.
  2191. If a secret gets deleted on the provider side and is not accessible
  2192. anymore this is not considered an error and the ExternalSecret
  2193. does not go into SecretSyncedError status.</p>
  2194. </td>
  2195. </tr><tr><td><p>&#34;Merge&#34;</p></td>
  2196. <td><p>Merge removes keys in the secret, but not the secret itself.
  2197. If a secret gets deleted on the provider side and is not accessible
  2198. anymore this is not considered an error and the ExternalSecret
  2199. does not go into SecretSyncedError status.</p>
  2200. </td>
  2201. </tr><tr><td><p>&#34;Retain&#34;</p></td>
  2202. <td><p>Retain will retain the secret if all provider secrets have been deleted.
  2203. If a provider secret does not exist the ExternalSecret gets into the
  2204. SecretSyncedError status.</p>
  2205. </td>
  2206. </tr></tbody>
  2207. </table>
  2208. <h3 id="external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind
  2209. </h3>
  2210. <p>
  2211. (<em>Appears on:</em>
  2212. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</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>path</code></br>
  2227. <em>
  2228. string
  2229. </em>
  2230. </td>
  2231. <td>
  2232. <em>(Optional)</em>
  2233. <p>A root path to start the find operations.</p>
  2234. </td>
  2235. </tr>
  2236. <tr>
  2237. <td>
  2238. <code>name</code></br>
  2239. <em>
  2240. <a href="#external-secrets.io/v1beta1.FindName">
  2241. FindName
  2242. </a>
  2243. </em>
  2244. </td>
  2245. <td>
  2246. <em>(Optional)</em>
  2247. <p>Finds secrets based on the name.</p>
  2248. </td>
  2249. </tr>
  2250. <tr>
  2251. <td>
  2252. <code>tags</code></br>
  2253. <em>
  2254. map[string]string
  2255. </em>
  2256. </td>
  2257. <td>
  2258. <em>(Optional)</em>
  2259. <p>Find secrets based on tags.</p>
  2260. </td>
  2261. </tr>
  2262. <tr>
  2263. <td>
  2264. <code>conversionStrategy</code></br>
  2265. <em>
  2266. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  2267. ExternalSecretConversionStrategy
  2268. </a>
  2269. </em>
  2270. </td>
  2271. <td>
  2272. <em>(Optional)</em>
  2273. <p>Used to define a conversion Strategy</p>
  2274. </td>
  2275. </tr>
  2276. </tbody>
  2277. </table>
  2278. <h3 id="external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec
  2279. </h3>
  2280. <p>
  2281. (<em>Appears on:</em>
  2282. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>,
  2283. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  2284. </p>
  2285. <p>
  2286. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  2287. </p>
  2288. <table>
  2289. <thead>
  2290. <tr>
  2291. <th>Field</th>
  2292. <th>Description</th>
  2293. </tr>
  2294. </thead>
  2295. <tbody>
  2296. <tr>
  2297. <td>
  2298. <code>secretStoreRef</code></br>
  2299. <em>
  2300. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  2301. SecretStoreRef
  2302. </a>
  2303. </em>
  2304. </td>
  2305. <td>
  2306. </td>
  2307. </tr>
  2308. <tr>
  2309. <td>
  2310. <code>target</code></br>
  2311. <em>
  2312. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  2313. ExternalSecretTarget
  2314. </a>
  2315. </em>
  2316. </td>
  2317. <td>
  2318. </td>
  2319. </tr>
  2320. <tr>
  2321. <td>
  2322. <code>refreshInterval</code></br>
  2323. <em>
  2324. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  2325. Kubernetes meta/v1.Duration
  2326. </a>
  2327. </em>
  2328. </td>
  2329. <td>
  2330. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  2331. 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;
  2332. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  2333. </td>
  2334. </tr>
  2335. <tr>
  2336. <td>
  2337. <code>data</code></br>
  2338. <em>
  2339. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  2340. []ExternalSecretData
  2341. </a>
  2342. </em>
  2343. </td>
  2344. <td>
  2345. <em>(Optional)</em>
  2346. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  2347. </td>
  2348. </tr>
  2349. <tr>
  2350. <td>
  2351. <code>dataFrom</code></br>
  2352. <em>
  2353. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  2354. []ExternalSecretDataFromRemoteRef
  2355. </a>
  2356. </em>
  2357. </td>
  2358. <td>
  2359. <em>(Optional)</em>
  2360. <p>DataFrom is used to fetch all properties from a specific Provider data
  2361. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  2362. </td>
  2363. </tr>
  2364. </tbody>
  2365. </table>
  2366. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus
  2367. </h3>
  2368. <p>
  2369. (<em>Appears on:</em>
  2370. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  2371. </p>
  2372. <p>
  2373. </p>
  2374. <table>
  2375. <thead>
  2376. <tr>
  2377. <th>Field</th>
  2378. <th>Description</th>
  2379. </tr>
  2380. </thead>
  2381. <tbody>
  2382. <tr>
  2383. <td>
  2384. <code>refreshTime</code></br>
  2385. <em>
  2386. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  2387. Kubernetes meta/v1.Time
  2388. </a>
  2389. </em>
  2390. </td>
  2391. <td>
  2392. <p>refreshTime is the time and date the external secret was fetched and
  2393. the target secret updated</p>
  2394. </td>
  2395. </tr>
  2396. <tr>
  2397. <td>
  2398. <code>syncedResourceVersion</code></br>
  2399. <em>
  2400. string
  2401. </em>
  2402. </td>
  2403. <td>
  2404. <p>SyncedResourceVersion keeps track of the last synced version</p>
  2405. </td>
  2406. </tr>
  2407. <tr>
  2408. <td>
  2409. <code>conditions</code></br>
  2410. <em>
  2411. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">
  2412. []ExternalSecretStatusCondition
  2413. </a>
  2414. </em>
  2415. </td>
  2416. <td>
  2417. <em>(Optional)</em>
  2418. </td>
  2419. </tr>
  2420. </tbody>
  2421. </table>
  2422. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  2423. </h3>
  2424. <p>
  2425. (<em>Appears on:</em>
  2426. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus</a>)
  2427. </p>
  2428. <p>
  2429. </p>
  2430. <table>
  2431. <thead>
  2432. <tr>
  2433. <th>Field</th>
  2434. <th>Description</th>
  2435. </tr>
  2436. </thead>
  2437. <tbody>
  2438. <tr>
  2439. <td>
  2440. <code>type</code></br>
  2441. <em>
  2442. <a href="#external-secrets.io/v1beta1.ExternalSecretConditionType">
  2443. ExternalSecretConditionType
  2444. </a>
  2445. </em>
  2446. </td>
  2447. <td>
  2448. </td>
  2449. </tr>
  2450. <tr>
  2451. <td>
  2452. <code>status</code></br>
  2453. <em>
  2454. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  2455. Kubernetes core/v1.ConditionStatus
  2456. </a>
  2457. </em>
  2458. </td>
  2459. <td>
  2460. </td>
  2461. </tr>
  2462. <tr>
  2463. <td>
  2464. <code>reason</code></br>
  2465. <em>
  2466. string
  2467. </em>
  2468. </td>
  2469. <td>
  2470. <em>(Optional)</em>
  2471. </td>
  2472. </tr>
  2473. <tr>
  2474. <td>
  2475. <code>message</code></br>
  2476. <em>
  2477. string
  2478. </em>
  2479. </td>
  2480. <td>
  2481. <em>(Optional)</em>
  2482. </td>
  2483. </tr>
  2484. <tr>
  2485. <td>
  2486. <code>lastTransitionTime</code></br>
  2487. <em>
  2488. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  2489. Kubernetes meta/v1.Time
  2490. </a>
  2491. </em>
  2492. </td>
  2493. <td>
  2494. <em>(Optional)</em>
  2495. </td>
  2496. </tr>
  2497. </tbody>
  2498. </table>
  2499. <h3 id="external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget
  2500. </h3>
  2501. <p>
  2502. (<em>Appears on:</em>
  2503. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2504. </p>
  2505. <p>
  2506. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  2507. There can be only one target per ExternalSecret.</p>
  2508. </p>
  2509. <table>
  2510. <thead>
  2511. <tr>
  2512. <th>Field</th>
  2513. <th>Description</th>
  2514. </tr>
  2515. </thead>
  2516. <tbody>
  2517. <tr>
  2518. <td>
  2519. <code>name</code></br>
  2520. <em>
  2521. string
  2522. </em>
  2523. </td>
  2524. <td>
  2525. <em>(Optional)</em>
  2526. <p>Name defines the name of the Secret resource to be managed
  2527. This field is immutable
  2528. Defaults to the .metadata.name of the ExternalSecret resource</p>
  2529. </td>
  2530. </tr>
  2531. <tr>
  2532. <td>
  2533. <code>creationPolicy</code></br>
  2534. <em>
  2535. <a href="#external-secrets.io/v1beta1.ExternalSecretCreationPolicy">
  2536. ExternalSecretCreationPolicy
  2537. </a>
  2538. </em>
  2539. </td>
  2540. <td>
  2541. <em>(Optional)</em>
  2542. <p>CreationPolicy defines rules on how to create the resulting Secret
  2543. Defaults to &lsquo;Owner&rsquo;</p>
  2544. </td>
  2545. </tr>
  2546. <tr>
  2547. <td>
  2548. <code>deletionPolicy</code></br>
  2549. <em>
  2550. <a href="#external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">
  2551. ExternalSecretDeletionPolicy
  2552. </a>
  2553. </em>
  2554. </td>
  2555. <td>
  2556. <em>(Optional)</em>
  2557. <p>DeletionPolicy defines rules on how to delete the resulting Secret
  2558. Defaults to &lsquo;Retain&rsquo;</p>
  2559. </td>
  2560. </tr>
  2561. <tr>
  2562. <td>
  2563. <code>template</code></br>
  2564. <em>
  2565. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">
  2566. ExternalSecretTemplate
  2567. </a>
  2568. </em>
  2569. </td>
  2570. <td>
  2571. <em>(Optional)</em>
  2572. <p>Template defines a blueprint for the created Secret resource.</p>
  2573. </td>
  2574. </tr>
  2575. <tr>
  2576. <td>
  2577. <code>immutable</code></br>
  2578. <em>
  2579. bool
  2580. </em>
  2581. </td>
  2582. <td>
  2583. <em>(Optional)</em>
  2584. <p>Immutable defines if the final secret will be immutable</p>
  2585. </td>
  2586. </tr>
  2587. </tbody>
  2588. </table>
  2589. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate
  2590. </h3>
  2591. <p>
  2592. (<em>Appears on:</em>
  2593. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  2594. </p>
  2595. <p>
  2596. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  2597. 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>
  2598. </p>
  2599. <table>
  2600. <thead>
  2601. <tr>
  2602. <th>Field</th>
  2603. <th>Description</th>
  2604. </tr>
  2605. </thead>
  2606. <tbody>
  2607. <tr>
  2608. <td>
  2609. <code>type</code></br>
  2610. <em>
  2611. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secrettype-v1-core">
  2612. Kubernetes core/v1.SecretType
  2613. </a>
  2614. </em>
  2615. </td>
  2616. <td>
  2617. <em>(Optional)</em>
  2618. </td>
  2619. </tr>
  2620. <tr>
  2621. <td>
  2622. <code>engineVersion</code></br>
  2623. <em>
  2624. <a href="#external-secrets.io/v1beta1.TemplateEngineVersion">
  2625. TemplateEngineVersion
  2626. </a>
  2627. </em>
  2628. </td>
  2629. <td>
  2630. </td>
  2631. </tr>
  2632. <tr>
  2633. <td>
  2634. <code>metadata</code></br>
  2635. <em>
  2636. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">
  2637. ExternalSecretTemplateMetadata
  2638. </a>
  2639. </em>
  2640. </td>
  2641. <td>
  2642. <em>(Optional)</em>
  2643. </td>
  2644. </tr>
  2645. <tr>
  2646. <td>
  2647. <code>data</code></br>
  2648. <em>
  2649. map[string]string
  2650. </em>
  2651. </td>
  2652. <td>
  2653. <em>(Optional)</em>
  2654. </td>
  2655. </tr>
  2656. <tr>
  2657. <td>
  2658. <code>templateFrom</code></br>
  2659. <em>
  2660. <a href="#external-secrets.io/v1beta1.TemplateFrom">
  2661. []TemplateFrom
  2662. </a>
  2663. </em>
  2664. </td>
  2665. <td>
  2666. <em>(Optional)</em>
  2667. </td>
  2668. </tr>
  2669. </tbody>
  2670. </table>
  2671. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  2672. </h3>
  2673. <p>
  2674. (<em>Appears on:</em>
  2675. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  2676. </p>
  2677. <p>
  2678. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  2679. </p>
  2680. <table>
  2681. <thead>
  2682. <tr>
  2683. <th>Field</th>
  2684. <th>Description</th>
  2685. </tr>
  2686. </thead>
  2687. <tbody>
  2688. <tr>
  2689. <td>
  2690. <code>annotations</code></br>
  2691. <em>
  2692. map[string]string
  2693. </em>
  2694. </td>
  2695. <td>
  2696. <em>(Optional)</em>
  2697. </td>
  2698. </tr>
  2699. <tr>
  2700. <td>
  2701. <code>labels</code></br>
  2702. <em>
  2703. map[string]string
  2704. </em>
  2705. </td>
  2706. <td>
  2707. <em>(Optional)</em>
  2708. </td>
  2709. </tr>
  2710. </tbody>
  2711. </table>
  2712. <h3 id="external-secrets.io/v1beta1.ExternalSecretValidator">ExternalSecretValidator
  2713. </h3>
  2714. <p>
  2715. </p>
  2716. <h3 id="external-secrets.io/v1beta1.FakeProvider">FakeProvider
  2717. </h3>
  2718. <p>
  2719. (<em>Appears on:</em>
  2720. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2721. </p>
  2722. <p>
  2723. <p>FakeProvider configures a fake provider that returns static values.</p>
  2724. </p>
  2725. <table>
  2726. <thead>
  2727. <tr>
  2728. <th>Field</th>
  2729. <th>Description</th>
  2730. </tr>
  2731. </thead>
  2732. <tbody>
  2733. <tr>
  2734. <td>
  2735. <code>data</code></br>
  2736. <em>
  2737. <a href="#external-secrets.io/v1beta1.FakeProviderData">
  2738. []FakeProviderData
  2739. </a>
  2740. </em>
  2741. </td>
  2742. <td>
  2743. </td>
  2744. </tr>
  2745. </tbody>
  2746. </table>
  2747. <h3 id="external-secrets.io/v1beta1.FakeProviderData">FakeProviderData
  2748. </h3>
  2749. <p>
  2750. (<em>Appears on:</em>
  2751. <a href="#external-secrets.io/v1beta1.FakeProvider">FakeProvider</a>)
  2752. </p>
  2753. <p>
  2754. </p>
  2755. <table>
  2756. <thead>
  2757. <tr>
  2758. <th>Field</th>
  2759. <th>Description</th>
  2760. </tr>
  2761. </thead>
  2762. <tbody>
  2763. <tr>
  2764. <td>
  2765. <code>key</code></br>
  2766. <em>
  2767. string
  2768. </em>
  2769. </td>
  2770. <td>
  2771. </td>
  2772. </tr>
  2773. <tr>
  2774. <td>
  2775. <code>value</code></br>
  2776. <em>
  2777. string
  2778. </em>
  2779. </td>
  2780. <td>
  2781. </td>
  2782. </tr>
  2783. <tr>
  2784. <td>
  2785. <code>valueMap</code></br>
  2786. <em>
  2787. map[string]string
  2788. </em>
  2789. </td>
  2790. <td>
  2791. </td>
  2792. </tr>
  2793. <tr>
  2794. <td>
  2795. <code>version</code></br>
  2796. <em>
  2797. string
  2798. </em>
  2799. </td>
  2800. <td>
  2801. </td>
  2802. </tr>
  2803. </tbody>
  2804. </table>
  2805. <h3 id="external-secrets.io/v1beta1.FindName">FindName
  2806. </h3>
  2807. <p>
  2808. (<em>Appears on:</em>
  2809. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  2810. </p>
  2811. <p>
  2812. </p>
  2813. <table>
  2814. <thead>
  2815. <tr>
  2816. <th>Field</th>
  2817. <th>Description</th>
  2818. </tr>
  2819. </thead>
  2820. <tbody>
  2821. <tr>
  2822. <td>
  2823. <code>regexp</code></br>
  2824. <em>
  2825. string
  2826. </em>
  2827. </td>
  2828. <td>
  2829. <em>(Optional)</em>
  2830. <p>Finds secrets base</p>
  2831. </td>
  2832. </tr>
  2833. </tbody>
  2834. </table>
  2835. <h3 id="external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth
  2836. </h3>
  2837. <p>
  2838. (<em>Appears on:</em>
  2839. <a href="#external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider</a>)
  2840. </p>
  2841. <p>
  2842. </p>
  2843. <table>
  2844. <thead>
  2845. <tr>
  2846. <th>Field</th>
  2847. <th>Description</th>
  2848. </tr>
  2849. </thead>
  2850. <tbody>
  2851. <tr>
  2852. <td>
  2853. <code>secretRef</code></br>
  2854. <em>
  2855. <a href="#external-secrets.io/v1beta1.GCPSMAuthSecretRef">
  2856. GCPSMAuthSecretRef
  2857. </a>
  2858. </em>
  2859. </td>
  2860. <td>
  2861. <em>(Optional)</em>
  2862. </td>
  2863. </tr>
  2864. <tr>
  2865. <td>
  2866. <code>workloadIdentity</code></br>
  2867. <em>
  2868. <a href="#external-secrets.io/v1beta1.GCPWorkloadIdentity">
  2869. GCPWorkloadIdentity
  2870. </a>
  2871. </em>
  2872. </td>
  2873. <td>
  2874. <em>(Optional)</em>
  2875. </td>
  2876. </tr>
  2877. </tbody>
  2878. </table>
  2879. <h3 id="external-secrets.io/v1beta1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  2880. </h3>
  2881. <p>
  2882. (<em>Appears on:</em>
  2883. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  2884. </p>
  2885. <p>
  2886. </p>
  2887. <table>
  2888. <thead>
  2889. <tr>
  2890. <th>Field</th>
  2891. <th>Description</th>
  2892. </tr>
  2893. </thead>
  2894. <tbody>
  2895. <tr>
  2896. <td>
  2897. <code>secretAccessKeySecretRef</code></br>
  2898. <em>
  2899. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2900. </em>
  2901. </td>
  2902. <td>
  2903. <em>(Optional)</em>
  2904. <p>The SecretAccessKey is used for authentication</p>
  2905. </td>
  2906. </tr>
  2907. </tbody>
  2908. </table>
  2909. <h3 id="external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider
  2910. </h3>
  2911. <p>
  2912. (<em>Appears on:</em>
  2913. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2914. </p>
  2915. <p>
  2916. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  2917. </p>
  2918. <table>
  2919. <thead>
  2920. <tr>
  2921. <th>Field</th>
  2922. <th>Description</th>
  2923. </tr>
  2924. </thead>
  2925. <tbody>
  2926. <tr>
  2927. <td>
  2928. <code>auth</code></br>
  2929. <em>
  2930. <a href="#external-secrets.io/v1beta1.GCPSMAuth">
  2931. GCPSMAuth
  2932. </a>
  2933. </em>
  2934. </td>
  2935. <td>
  2936. <em>(Optional)</em>
  2937. <p>Auth defines the information necessary to authenticate against GCP</p>
  2938. </td>
  2939. </tr>
  2940. <tr>
  2941. <td>
  2942. <code>projectID</code></br>
  2943. <em>
  2944. string
  2945. </em>
  2946. </td>
  2947. <td>
  2948. <p>ProjectID project where secret is located</p>
  2949. </td>
  2950. </tr>
  2951. </tbody>
  2952. </table>
  2953. <h3 id="external-secrets.io/v1beta1.GCPWorkloadIdentity">GCPWorkloadIdentity
  2954. </h3>
  2955. <p>
  2956. (<em>Appears on:</em>
  2957. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  2958. </p>
  2959. <p>
  2960. </p>
  2961. <table>
  2962. <thead>
  2963. <tr>
  2964. <th>Field</th>
  2965. <th>Description</th>
  2966. </tr>
  2967. </thead>
  2968. <tbody>
  2969. <tr>
  2970. <td>
  2971. <code>serviceAccountRef</code></br>
  2972. <em>
  2973. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  2974. </em>
  2975. </td>
  2976. <td>
  2977. </td>
  2978. </tr>
  2979. <tr>
  2980. <td>
  2981. <code>clusterLocation</code></br>
  2982. <em>
  2983. string
  2984. </em>
  2985. </td>
  2986. <td>
  2987. </td>
  2988. </tr>
  2989. <tr>
  2990. <td>
  2991. <code>clusterName</code></br>
  2992. <em>
  2993. string
  2994. </em>
  2995. </td>
  2996. <td>
  2997. </td>
  2998. </tr>
  2999. <tr>
  3000. <td>
  3001. <code>clusterProjectID</code></br>
  3002. <em>
  3003. string
  3004. </em>
  3005. </td>
  3006. <td>
  3007. </td>
  3008. </tr>
  3009. </tbody>
  3010. </table>
  3011. <h3 id="external-secrets.io/v1beta1.GenericStore">GenericStore
  3012. </h3>
  3013. <p>
  3014. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  3015. or a namespaced SecretStore.</p>
  3016. </p>
  3017. <h3 id="external-secrets.io/v1beta1.GenericStoreValidator">GenericStoreValidator
  3018. </h3>
  3019. <p>
  3020. </p>
  3021. <h3 id="external-secrets.io/v1beta1.GitlabAuth">GitlabAuth
  3022. </h3>
  3023. <p>
  3024. (<em>Appears on:</em>
  3025. <a href="#external-secrets.io/v1beta1.GitlabProvider">GitlabProvider</a>)
  3026. </p>
  3027. <p>
  3028. </p>
  3029. <table>
  3030. <thead>
  3031. <tr>
  3032. <th>Field</th>
  3033. <th>Description</th>
  3034. </tr>
  3035. </thead>
  3036. <tbody>
  3037. <tr>
  3038. <td>
  3039. <code>SecretRef</code></br>
  3040. <em>
  3041. <a href="#external-secrets.io/v1beta1.GitlabSecretRef">
  3042. GitlabSecretRef
  3043. </a>
  3044. </em>
  3045. </td>
  3046. <td>
  3047. </td>
  3048. </tr>
  3049. </tbody>
  3050. </table>
  3051. <h3 id="external-secrets.io/v1beta1.GitlabProvider">GitlabProvider
  3052. </h3>
  3053. <p>
  3054. (<em>Appears on:</em>
  3055. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3056. </p>
  3057. <p>
  3058. <p>Configures a store to sync secrets with a GitLab instance.</p>
  3059. </p>
  3060. <table>
  3061. <thead>
  3062. <tr>
  3063. <th>Field</th>
  3064. <th>Description</th>
  3065. </tr>
  3066. </thead>
  3067. <tbody>
  3068. <tr>
  3069. <td>
  3070. <code>url</code></br>
  3071. <em>
  3072. string
  3073. </em>
  3074. </td>
  3075. <td>
  3076. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
  3077. </td>
  3078. </tr>
  3079. <tr>
  3080. <td>
  3081. <code>auth</code></br>
  3082. <em>
  3083. <a href="#external-secrets.io/v1beta1.GitlabAuth">
  3084. GitlabAuth
  3085. </a>
  3086. </em>
  3087. </td>
  3088. <td>
  3089. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
  3090. </td>
  3091. </tr>
  3092. <tr>
  3093. <td>
  3094. <code>projectID</code></br>
  3095. <em>
  3096. string
  3097. </em>
  3098. </td>
  3099. <td>
  3100. <p>ProjectID specifies a project where secrets are located.</p>
  3101. </td>
  3102. </tr>
  3103. </tbody>
  3104. </table>
  3105. <h3 id="external-secrets.io/v1beta1.GitlabSecretRef">GitlabSecretRef
  3106. </h3>
  3107. <p>
  3108. (<em>Appears on:</em>
  3109. <a href="#external-secrets.io/v1beta1.GitlabAuth">GitlabAuth</a>)
  3110. </p>
  3111. <p>
  3112. </p>
  3113. <table>
  3114. <thead>
  3115. <tr>
  3116. <th>Field</th>
  3117. <th>Description</th>
  3118. </tr>
  3119. </thead>
  3120. <tbody>
  3121. <tr>
  3122. <td>
  3123. <code>accessToken</code></br>
  3124. <em>
  3125. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3126. </em>
  3127. </td>
  3128. <td>
  3129. <p>AccessToken is used for authentication.</p>
  3130. </td>
  3131. </tr>
  3132. </tbody>
  3133. </table>
  3134. <h3 id="external-secrets.io/v1beta1.IBMAuth">IBMAuth
  3135. </h3>
  3136. <p>
  3137. (<em>Appears on:</em>
  3138. <a href="#external-secrets.io/v1beta1.IBMProvider">IBMProvider</a>)
  3139. </p>
  3140. <p>
  3141. </p>
  3142. <table>
  3143. <thead>
  3144. <tr>
  3145. <th>Field</th>
  3146. <th>Description</th>
  3147. </tr>
  3148. </thead>
  3149. <tbody>
  3150. <tr>
  3151. <td>
  3152. <code>secretRef</code></br>
  3153. <em>
  3154. <a href="#external-secrets.io/v1beta1.IBMAuthSecretRef">
  3155. IBMAuthSecretRef
  3156. </a>
  3157. </em>
  3158. </td>
  3159. <td>
  3160. </td>
  3161. </tr>
  3162. </tbody>
  3163. </table>
  3164. <h3 id="external-secrets.io/v1beta1.IBMAuthSecretRef">IBMAuthSecretRef
  3165. </h3>
  3166. <p>
  3167. (<em>Appears on:</em>
  3168. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  3169. </p>
  3170. <p>
  3171. </p>
  3172. <table>
  3173. <thead>
  3174. <tr>
  3175. <th>Field</th>
  3176. <th>Description</th>
  3177. </tr>
  3178. </thead>
  3179. <tbody>
  3180. <tr>
  3181. <td>
  3182. <code>secretApiKeySecretRef</code></br>
  3183. <em>
  3184. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3185. </em>
  3186. </td>
  3187. <td>
  3188. <em>(Optional)</em>
  3189. <p>The SecretAccessKey is used for authentication</p>
  3190. </td>
  3191. </tr>
  3192. </tbody>
  3193. </table>
  3194. <h3 id="external-secrets.io/v1beta1.IBMProvider">IBMProvider
  3195. </h3>
  3196. <p>
  3197. (<em>Appears on:</em>
  3198. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3199. </p>
  3200. <p>
  3201. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
  3202. backend.</p>
  3203. </p>
  3204. <table>
  3205. <thead>
  3206. <tr>
  3207. <th>Field</th>
  3208. <th>Description</th>
  3209. </tr>
  3210. </thead>
  3211. <tbody>
  3212. <tr>
  3213. <td>
  3214. <code>auth</code></br>
  3215. <em>
  3216. <a href="#external-secrets.io/v1beta1.IBMAuth">
  3217. IBMAuth
  3218. </a>
  3219. </em>
  3220. </td>
  3221. <td>
  3222. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
  3223. </td>
  3224. </tr>
  3225. <tr>
  3226. <td>
  3227. <code>serviceUrl</code></br>
  3228. <em>
  3229. string
  3230. </em>
  3231. </td>
  3232. <td>
  3233. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
  3234. </td>
  3235. </tr>
  3236. </tbody>
  3237. </table>
  3238. <h3 id="external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth
  3239. </h3>
  3240. <p>
  3241. (<em>Appears on:</em>
  3242. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  3243. </p>
  3244. <p>
  3245. </p>
  3246. <table>
  3247. <thead>
  3248. <tr>
  3249. <th>Field</th>
  3250. <th>Description</th>
  3251. </tr>
  3252. </thead>
  3253. <tbody>
  3254. <tr>
  3255. <td>
  3256. <code>cert</code></br>
  3257. <em>
  3258. <a href="#external-secrets.io/v1beta1.CertAuth">
  3259. CertAuth
  3260. </a>
  3261. </em>
  3262. </td>
  3263. <td>
  3264. <em>(Optional)</em>
  3265. <p>has both clientCert and clientKey as secretKeySelector</p>
  3266. </td>
  3267. </tr>
  3268. <tr>
  3269. <td>
  3270. <code>token</code></br>
  3271. <em>
  3272. <a href="#external-secrets.io/v1beta1.TokenAuth">
  3273. TokenAuth
  3274. </a>
  3275. </em>
  3276. </td>
  3277. <td>
  3278. <em>(Optional)</em>
  3279. <p>use static token to authenticate with</p>
  3280. </td>
  3281. </tr>
  3282. <tr>
  3283. <td>
  3284. <code>serviceAccount</code></br>
  3285. <em>
  3286. <a href="#external-secrets.io/v1beta1.ServiceAccountAuth">
  3287. ServiceAccountAuth
  3288. </a>
  3289. </em>
  3290. </td>
  3291. <td>
  3292. <em>(Optional)</em>
  3293. <p>points to a service account that should be used for authentication</p>
  3294. </td>
  3295. </tr>
  3296. </tbody>
  3297. </table>
  3298. <h3 id="external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider
  3299. </h3>
  3300. <p>
  3301. (<em>Appears on:</em>
  3302. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3303. </p>
  3304. <p>
  3305. <p>Configures a store to sync secrets with a Kubernetes instance.</p>
  3306. </p>
  3307. <table>
  3308. <thead>
  3309. <tr>
  3310. <th>Field</th>
  3311. <th>Description</th>
  3312. </tr>
  3313. </thead>
  3314. <tbody>
  3315. <tr>
  3316. <td>
  3317. <code>server</code></br>
  3318. <em>
  3319. <a href="#external-secrets.io/v1beta1.KubernetesServer">
  3320. KubernetesServer
  3321. </a>
  3322. </em>
  3323. </td>
  3324. <td>
  3325. <p>configures the Kubernetes server Address.</p>
  3326. </td>
  3327. </tr>
  3328. <tr>
  3329. <td>
  3330. <code>auth</code></br>
  3331. <em>
  3332. <a href="#external-secrets.io/v1beta1.KubernetesAuth">
  3333. KubernetesAuth
  3334. </a>
  3335. </em>
  3336. </td>
  3337. <td>
  3338. <p>Auth configures how secret-manager authenticates with a Kubernetes instance.</p>
  3339. </td>
  3340. </tr>
  3341. <tr>
  3342. <td>
  3343. <code>remoteNamespace</code></br>
  3344. <em>
  3345. string
  3346. </em>
  3347. </td>
  3348. <td>
  3349. <em>(Optional)</em>
  3350. <p>Remote namespace to fetch the secrets from</p>
  3351. </td>
  3352. </tr>
  3353. </tbody>
  3354. </table>
  3355. <h3 id="external-secrets.io/v1beta1.KubernetesServer">KubernetesServer
  3356. </h3>
  3357. <p>
  3358. (<em>Appears on:</em>
  3359. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  3360. </p>
  3361. <p>
  3362. </p>
  3363. <table>
  3364. <thead>
  3365. <tr>
  3366. <th>Field</th>
  3367. <th>Description</th>
  3368. </tr>
  3369. </thead>
  3370. <tbody>
  3371. <tr>
  3372. <td>
  3373. <code>url</code></br>
  3374. <em>
  3375. string
  3376. </em>
  3377. </td>
  3378. <td>
  3379. <em>(Optional)</em>
  3380. <p>configures the Kubernetes server Address.</p>
  3381. </td>
  3382. </tr>
  3383. <tr>
  3384. <td>
  3385. <code>caBundle</code></br>
  3386. <em>
  3387. []byte
  3388. </em>
  3389. </td>
  3390. <td>
  3391. <em>(Optional)</em>
  3392. <p>CABundle is a base64-encoded CA certificate</p>
  3393. </td>
  3394. </tr>
  3395. <tr>
  3396. <td>
  3397. <code>caProvider</code></br>
  3398. <em>
  3399. <a href="#external-secrets.io/v1beta1.CAProvider">
  3400. CAProvider
  3401. </a>
  3402. </em>
  3403. </td>
  3404. <td>
  3405. <em>(Optional)</em>
  3406. <p>see: <a href="https://external-secrets.io/v0.4.1/spec/#external-secrets.io/v1alpha1.CAProvider">https://external-secrets.io/v0.4.1/spec/#external-secrets.io/v1alpha1.CAProvider</a></p>
  3407. </td>
  3408. </tr>
  3409. </tbody>
  3410. </table>
  3411. <h3 id="external-secrets.io/v1beta1.NoSecretError">NoSecretError
  3412. </h3>
  3413. <p>
  3414. <p>NoSecretError shall be returned when a GetSecret can not find the
  3415. desired secret. This is used for deletionPolicy.</p>
  3416. </p>
  3417. <h3 id="external-secrets.io/v1beta1.OracleAuth">OracleAuth
  3418. </h3>
  3419. <p>
  3420. (<em>Appears on:</em>
  3421. <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
  3422. </p>
  3423. <p>
  3424. </p>
  3425. <table>
  3426. <thead>
  3427. <tr>
  3428. <th>Field</th>
  3429. <th>Description</th>
  3430. </tr>
  3431. </thead>
  3432. <tbody>
  3433. <tr>
  3434. <td>
  3435. <code>tenancy</code></br>
  3436. <em>
  3437. string
  3438. </em>
  3439. </td>
  3440. <td>
  3441. <p>Tenancy is the tenancy OCID where user is located.</p>
  3442. </td>
  3443. </tr>
  3444. <tr>
  3445. <td>
  3446. <code>user</code></br>
  3447. <em>
  3448. string
  3449. </em>
  3450. </td>
  3451. <td>
  3452. <p>User is an access OCID specific to the account.</p>
  3453. </td>
  3454. </tr>
  3455. <tr>
  3456. <td>
  3457. <code>secretRef</code></br>
  3458. <em>
  3459. <a href="#external-secrets.io/v1beta1.OracleSecretRef">
  3460. OracleSecretRef
  3461. </a>
  3462. </em>
  3463. </td>
  3464. <td>
  3465. <p>SecretRef to pass through sensitive information.</p>
  3466. </td>
  3467. </tr>
  3468. </tbody>
  3469. </table>
  3470. <h3 id="external-secrets.io/v1beta1.OracleProvider">OracleProvider
  3471. </h3>
  3472. <p>
  3473. (<em>Appears on:</em>
  3474. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3475. </p>
  3476. <p>
  3477. <p>Configures an store to sync secrets using a Oracle Vault
  3478. backend.</p>
  3479. </p>
  3480. <table>
  3481. <thead>
  3482. <tr>
  3483. <th>Field</th>
  3484. <th>Description</th>
  3485. </tr>
  3486. </thead>
  3487. <tbody>
  3488. <tr>
  3489. <td>
  3490. <code>region</code></br>
  3491. <em>
  3492. string
  3493. </em>
  3494. </td>
  3495. <td>
  3496. <p>Region is the region where vault is located.</p>
  3497. </td>
  3498. </tr>
  3499. <tr>
  3500. <td>
  3501. <code>vault</code></br>
  3502. <em>
  3503. string
  3504. </em>
  3505. </td>
  3506. <td>
  3507. <p>Vault is the vault&rsquo;s OCID of the specific vault where secret is located.</p>
  3508. </td>
  3509. </tr>
  3510. <tr>
  3511. <td>
  3512. <code>auth</code></br>
  3513. <em>
  3514. <a href="#external-secrets.io/v1beta1.OracleAuth">
  3515. OracleAuth
  3516. </a>
  3517. </em>
  3518. </td>
  3519. <td>
  3520. <em>(Optional)</em>
  3521. <p>Auth configures how secret-manager authenticates with the Oracle Vault.
  3522. If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
  3523. </td>
  3524. </tr>
  3525. </tbody>
  3526. </table>
  3527. <h3 id="external-secrets.io/v1beta1.OracleSecretRef">OracleSecretRef
  3528. </h3>
  3529. <p>
  3530. (<em>Appears on:</em>
  3531. <a href="#external-secrets.io/v1beta1.OracleAuth">OracleAuth</a>)
  3532. </p>
  3533. <p>
  3534. </p>
  3535. <table>
  3536. <thead>
  3537. <tr>
  3538. <th>Field</th>
  3539. <th>Description</th>
  3540. </tr>
  3541. </thead>
  3542. <tbody>
  3543. <tr>
  3544. <td>
  3545. <code>privatekey</code></br>
  3546. <em>
  3547. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3548. </em>
  3549. </td>
  3550. <td>
  3551. <p>PrivateKey is the user&rsquo;s API Signing Key in PEM format, used for authentication.</p>
  3552. </td>
  3553. </tr>
  3554. <tr>
  3555. <td>
  3556. <code>fingerprint</code></br>
  3557. <em>
  3558. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3559. </em>
  3560. </td>
  3561. <td>
  3562. <p>Fingerprint is the fingerprint of the API private key.</p>
  3563. </td>
  3564. </tr>
  3565. </tbody>
  3566. </table>
  3567. <h3 id="external-secrets.io/v1beta1.Provider">Provider
  3568. </h3>
  3569. <p>
  3570. <p>Provider is a common interface for interacting with secret backends.</p>
  3571. </p>
  3572. <h3 id="external-secrets.io/v1beta1.SecretStore">SecretStore
  3573. </h3>
  3574. <p>
  3575. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  3576. </p>
  3577. <table>
  3578. <thead>
  3579. <tr>
  3580. <th>Field</th>
  3581. <th>Description</th>
  3582. </tr>
  3583. </thead>
  3584. <tbody>
  3585. <tr>
  3586. <td>
  3587. <code>metadata</code></br>
  3588. <em>
  3589. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  3590. Kubernetes meta/v1.ObjectMeta
  3591. </a>
  3592. </em>
  3593. </td>
  3594. <td>
  3595. Refer to the Kubernetes API documentation for the fields of the
  3596. <code>metadata</code> field.
  3597. </td>
  3598. </tr>
  3599. <tr>
  3600. <td>
  3601. <code>spec</code></br>
  3602. <em>
  3603. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  3604. SecretStoreSpec
  3605. </a>
  3606. </em>
  3607. </td>
  3608. <td>
  3609. <br/>
  3610. <br/>
  3611. <table>
  3612. <tr>
  3613. <td>
  3614. <code>controller</code></br>
  3615. <em>
  3616. string
  3617. </em>
  3618. </td>
  3619. <td>
  3620. <em>(Optional)</em>
  3621. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  3622. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  3623. </td>
  3624. </tr>
  3625. <tr>
  3626. <td>
  3627. <code>provider</code></br>
  3628. <em>
  3629. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  3630. SecretStoreProvider
  3631. </a>
  3632. </em>
  3633. </td>
  3634. <td>
  3635. <p>Used to configure the provider. Only one provider may be set</p>
  3636. </td>
  3637. </tr>
  3638. <tr>
  3639. <td>
  3640. <code>retrySettings</code></br>
  3641. <em>
  3642. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  3643. SecretStoreRetrySettings
  3644. </a>
  3645. </em>
  3646. </td>
  3647. <td>
  3648. <em>(Optional)</em>
  3649. <p>Used to configure http retries if failed</p>
  3650. </td>
  3651. </tr>
  3652. <tr>
  3653. <td>
  3654. <code>refreshInterval</code></br>
  3655. <em>
  3656. int
  3657. </em>
  3658. </td>
  3659. <td>
  3660. <em>(Optional)</em>
  3661. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  3662. </td>
  3663. </tr>
  3664. </table>
  3665. </td>
  3666. </tr>
  3667. <tr>
  3668. <td>
  3669. <code>status</code></br>
  3670. <em>
  3671. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  3672. SecretStoreStatus
  3673. </a>
  3674. </em>
  3675. </td>
  3676. <td>
  3677. </td>
  3678. </tr>
  3679. </tbody>
  3680. </table>
  3681. <h3 id="external-secrets.io/v1beta1.SecretStoreConditionType">SecretStoreConditionType
  3682. (<code>string</code> alias)</p></h3>
  3683. <p>
  3684. (<em>Appears on:</em>
  3685. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  3686. </p>
  3687. <p>
  3688. </p>
  3689. <table>
  3690. <thead>
  3691. <tr>
  3692. <th>Value</th>
  3693. <th>Description</th>
  3694. </tr>
  3695. </thead>
  3696. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  3697. <td></td>
  3698. </tr></tbody>
  3699. </table>
  3700. <h3 id="external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider
  3701. </h3>
  3702. <p>
  3703. (<em>Appears on:</em>
  3704. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  3705. </p>
  3706. <p>
  3707. <p>SecretStoreProvider contains the provider-specific configration.</p>
  3708. </p>
  3709. <table>
  3710. <thead>
  3711. <tr>
  3712. <th>Field</th>
  3713. <th>Description</th>
  3714. </tr>
  3715. </thead>
  3716. <tbody>
  3717. <tr>
  3718. <td>
  3719. <code>aws</code></br>
  3720. <em>
  3721. <a href="#external-secrets.io/v1beta1.AWSProvider">
  3722. AWSProvider
  3723. </a>
  3724. </em>
  3725. </td>
  3726. <td>
  3727. <em>(Optional)</em>
  3728. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  3729. </td>
  3730. </tr>
  3731. <tr>
  3732. <td>
  3733. <code>azurekv</code></br>
  3734. <em>
  3735. <a href="#external-secrets.io/v1beta1.AzureKVProvider">
  3736. AzureKVProvider
  3737. </a>
  3738. </em>
  3739. </td>
  3740. <td>
  3741. <em>(Optional)</em>
  3742. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  3743. </td>
  3744. </tr>
  3745. <tr>
  3746. <td>
  3747. <code>akeyless</code></br>
  3748. <em>
  3749. <a href="#external-secrets.io/v1beta1.AkeylessProvider">
  3750. AkeylessProvider
  3751. </a>
  3752. </em>
  3753. </td>
  3754. <td>
  3755. <em>(Optional)</em>
  3756. <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
  3757. </td>
  3758. </tr>
  3759. <tr>
  3760. <td>
  3761. <code>vault</code></br>
  3762. <em>
  3763. <a href="#external-secrets.io/v1beta1.VaultProvider">
  3764. VaultProvider
  3765. </a>
  3766. </em>
  3767. </td>
  3768. <td>
  3769. <em>(Optional)</em>
  3770. <p>Vault configures this store to sync secrets using Hashi provider</p>
  3771. </td>
  3772. </tr>
  3773. <tr>
  3774. <td>
  3775. <code>gcpsm</code></br>
  3776. <em>
  3777. <a href="#external-secrets.io/v1beta1.GCPSMProvider">
  3778. GCPSMProvider
  3779. </a>
  3780. </em>
  3781. </td>
  3782. <td>
  3783. <em>(Optional)</em>
  3784. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  3785. </td>
  3786. </tr>
  3787. <tr>
  3788. <td>
  3789. <code>oracle</code></br>
  3790. <em>
  3791. <a href="#external-secrets.io/v1beta1.OracleProvider">
  3792. OracleProvider
  3793. </a>
  3794. </em>
  3795. </td>
  3796. <td>
  3797. <em>(Optional)</em>
  3798. <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
  3799. </td>
  3800. </tr>
  3801. <tr>
  3802. <td>
  3803. <code>ibm</code></br>
  3804. <em>
  3805. <a href="#external-secrets.io/v1beta1.IBMProvider">
  3806. IBMProvider
  3807. </a>
  3808. </em>
  3809. </td>
  3810. <td>
  3811. <em>(Optional)</em>
  3812. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
  3813. </td>
  3814. </tr>
  3815. <tr>
  3816. <td>
  3817. <code>yandexlockbox</code></br>
  3818. <em>
  3819. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">
  3820. YandexLockboxProvider
  3821. </a>
  3822. </em>
  3823. </td>
  3824. <td>
  3825. <em>(Optional)</em>
  3826. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
  3827. </td>
  3828. </tr>
  3829. <tr>
  3830. <td>
  3831. <code>gitlab</code></br>
  3832. <em>
  3833. <a href="#external-secrets.io/v1beta1.GitlabProvider">
  3834. GitlabProvider
  3835. </a>
  3836. </em>
  3837. </td>
  3838. <td>
  3839. <em>(Optional)</em>
  3840. <p>GItlab configures this store to sync secrets using Gitlab Variables provider</p>
  3841. </td>
  3842. </tr>
  3843. <tr>
  3844. <td>
  3845. <code>alibaba</code></br>
  3846. <em>
  3847. <a href="#external-secrets.io/v1beta1.AlibabaProvider">
  3848. AlibabaProvider
  3849. </a>
  3850. </em>
  3851. </td>
  3852. <td>
  3853. <em>(Optional)</em>
  3854. <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
  3855. </td>
  3856. </tr>
  3857. <tr>
  3858. <td>
  3859. <code>webhook</code></br>
  3860. <em>
  3861. <a href="#external-secrets.io/v1beta1.WebhookProvider">
  3862. WebhookProvider
  3863. </a>
  3864. </em>
  3865. </td>
  3866. <td>
  3867. <em>(Optional)</em>
  3868. <p>Webhook configures this store to sync secrets using a generic templated webhook</p>
  3869. </td>
  3870. </tr>
  3871. <tr>
  3872. <td>
  3873. <code>kubernetes</code></br>
  3874. <em>
  3875. <a href="#external-secrets.io/v1beta1.KubernetesProvider">
  3876. KubernetesProvider
  3877. </a>
  3878. </em>
  3879. </td>
  3880. <td>
  3881. <em>(Optional)</em>
  3882. <p>Kubernetes configures this store to sync secrets using a Kubernetes cluster provider</p>
  3883. </td>
  3884. </tr>
  3885. <tr>
  3886. <td>
  3887. <code>fake</code></br>
  3888. <em>
  3889. <a href="#external-secrets.io/v1beta1.FakeProvider">
  3890. FakeProvider
  3891. </a>
  3892. </em>
  3893. </td>
  3894. <td>
  3895. <em>(Optional)</em>
  3896. <p>Fake configures a store with static key/value pairs</p>
  3897. </td>
  3898. </tr>
  3899. </tbody>
  3900. </table>
  3901. <h3 id="external-secrets.io/v1beta1.SecretStoreRef">SecretStoreRef
  3902. </h3>
  3903. <p>
  3904. (<em>Appears on:</em>
  3905. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  3906. </p>
  3907. <p>
  3908. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  3909. </p>
  3910. <table>
  3911. <thead>
  3912. <tr>
  3913. <th>Field</th>
  3914. <th>Description</th>
  3915. </tr>
  3916. </thead>
  3917. <tbody>
  3918. <tr>
  3919. <td>
  3920. <code>name</code></br>
  3921. <em>
  3922. string
  3923. </em>
  3924. </td>
  3925. <td>
  3926. <p>Name of the SecretStore resource</p>
  3927. </td>
  3928. </tr>
  3929. <tr>
  3930. <td>
  3931. <code>kind</code></br>
  3932. <em>
  3933. string
  3934. </em>
  3935. </td>
  3936. <td>
  3937. <em>(Optional)</em>
  3938. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  3939. Defaults to <code>SecretStore</code></p>
  3940. </td>
  3941. </tr>
  3942. </tbody>
  3943. </table>
  3944. <h3 id="external-secrets.io/v1beta1.SecretStoreRetrySettings">SecretStoreRetrySettings
  3945. </h3>
  3946. <p>
  3947. (<em>Appears on:</em>
  3948. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  3949. </p>
  3950. <p>
  3951. </p>
  3952. <table>
  3953. <thead>
  3954. <tr>
  3955. <th>Field</th>
  3956. <th>Description</th>
  3957. </tr>
  3958. </thead>
  3959. <tbody>
  3960. <tr>
  3961. <td>
  3962. <code>maxRetries</code></br>
  3963. <em>
  3964. int32
  3965. </em>
  3966. </td>
  3967. <td>
  3968. </td>
  3969. </tr>
  3970. <tr>
  3971. <td>
  3972. <code>retryInterval</code></br>
  3973. <em>
  3974. string
  3975. </em>
  3976. </td>
  3977. <td>
  3978. </td>
  3979. </tr>
  3980. </tbody>
  3981. </table>
  3982. <h3 id="external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec
  3983. </h3>
  3984. <p>
  3985. (<em>Appears on:</em>
  3986. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  3987. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  3988. </p>
  3989. <p>
  3990. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  3991. </p>
  3992. <table>
  3993. <thead>
  3994. <tr>
  3995. <th>Field</th>
  3996. <th>Description</th>
  3997. </tr>
  3998. </thead>
  3999. <tbody>
  4000. <tr>
  4001. <td>
  4002. <code>controller</code></br>
  4003. <em>
  4004. string
  4005. </em>
  4006. </td>
  4007. <td>
  4008. <em>(Optional)</em>
  4009. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  4010. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  4011. </td>
  4012. </tr>
  4013. <tr>
  4014. <td>
  4015. <code>provider</code></br>
  4016. <em>
  4017. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  4018. SecretStoreProvider
  4019. </a>
  4020. </em>
  4021. </td>
  4022. <td>
  4023. <p>Used to configure the provider. Only one provider may be set</p>
  4024. </td>
  4025. </tr>
  4026. <tr>
  4027. <td>
  4028. <code>retrySettings</code></br>
  4029. <em>
  4030. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  4031. SecretStoreRetrySettings
  4032. </a>
  4033. </em>
  4034. </td>
  4035. <td>
  4036. <em>(Optional)</em>
  4037. <p>Used to configure http retries if failed</p>
  4038. </td>
  4039. </tr>
  4040. <tr>
  4041. <td>
  4042. <code>refreshInterval</code></br>
  4043. <em>
  4044. int
  4045. </em>
  4046. </td>
  4047. <td>
  4048. <em>(Optional)</em>
  4049. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  4050. </td>
  4051. </tr>
  4052. </tbody>
  4053. </table>
  4054. <h3 id="external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus
  4055. </h3>
  4056. <p>
  4057. (<em>Appears on:</em>
  4058. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  4059. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  4060. </p>
  4061. <p>
  4062. <p>SecretStoreStatus defines the observed state of the SecretStore.</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>conditions</code></br>
  4075. <em>
  4076. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">
  4077. []SecretStoreStatusCondition
  4078. </a>
  4079. </em>
  4080. </td>
  4081. <td>
  4082. <em>(Optional)</em>
  4083. </td>
  4084. </tr>
  4085. </tbody>
  4086. </table>
  4087. <h3 id="external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition
  4088. </h3>
  4089. <p>
  4090. (<em>Appears on:</em>
  4091. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  4092. </p>
  4093. <p>
  4094. </p>
  4095. <table>
  4096. <thead>
  4097. <tr>
  4098. <th>Field</th>
  4099. <th>Description</th>
  4100. </tr>
  4101. </thead>
  4102. <tbody>
  4103. <tr>
  4104. <td>
  4105. <code>type</code></br>
  4106. <em>
  4107. <a href="#external-secrets.io/v1beta1.SecretStoreConditionType">
  4108. SecretStoreConditionType
  4109. </a>
  4110. </em>
  4111. </td>
  4112. <td>
  4113. </td>
  4114. </tr>
  4115. <tr>
  4116. <td>
  4117. <code>status</code></br>
  4118. <em>
  4119. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  4120. Kubernetes core/v1.ConditionStatus
  4121. </a>
  4122. </em>
  4123. </td>
  4124. <td>
  4125. </td>
  4126. </tr>
  4127. <tr>
  4128. <td>
  4129. <code>reason</code></br>
  4130. <em>
  4131. string
  4132. </em>
  4133. </td>
  4134. <td>
  4135. <em>(Optional)</em>
  4136. </td>
  4137. </tr>
  4138. <tr>
  4139. <td>
  4140. <code>message</code></br>
  4141. <em>
  4142. string
  4143. </em>
  4144. </td>
  4145. <td>
  4146. <em>(Optional)</em>
  4147. </td>
  4148. </tr>
  4149. <tr>
  4150. <td>
  4151. <code>lastTransitionTime</code></br>
  4152. <em>
  4153. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  4154. Kubernetes meta/v1.Time
  4155. </a>
  4156. </em>
  4157. </td>
  4158. <td>
  4159. <em>(Optional)</em>
  4160. </td>
  4161. </tr>
  4162. </tbody>
  4163. </table>
  4164. <h3 id="external-secrets.io/v1beta1.SecretsClient">SecretsClient
  4165. </h3>
  4166. <p>
  4167. <p>SecretsClient provides access to secrets.</p>
  4168. </p>
  4169. <h3 id="external-secrets.io/v1beta1.ServiceAccountAuth">ServiceAccountAuth
  4170. </h3>
  4171. <p>
  4172. (<em>Appears on:</em>
  4173. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  4174. </p>
  4175. <p>
  4176. </p>
  4177. <table>
  4178. <thead>
  4179. <tr>
  4180. <th>Field</th>
  4181. <th>Description</th>
  4182. </tr>
  4183. </thead>
  4184. <tbody>
  4185. <tr>
  4186. <td>
  4187. <code>serviceAccount</code></br>
  4188. <em>
  4189. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  4190. </em>
  4191. </td>
  4192. <td>
  4193. </td>
  4194. </tr>
  4195. </tbody>
  4196. </table>
  4197. <h3 id="external-secrets.io/v1beta1.TemplateEngineVersion">TemplateEngineVersion
  4198. (<code>string</code> alias)</p></h3>
  4199. <p>
  4200. (<em>Appears on:</em>
  4201. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  4202. </p>
  4203. <p>
  4204. </p>
  4205. <table>
  4206. <thead>
  4207. <tr>
  4208. <th>Value</th>
  4209. <th>Description</th>
  4210. </tr>
  4211. </thead>
  4212. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  4213. <td></td>
  4214. </tr><tr><td><p>&#34;v2&#34;</p></td>
  4215. <td></td>
  4216. </tr></tbody>
  4217. </table>
  4218. <h3 id="external-secrets.io/v1beta1.TemplateFrom">TemplateFrom
  4219. </h3>
  4220. <p>
  4221. (<em>Appears on:</em>
  4222. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  4223. </p>
  4224. <p>
  4225. </p>
  4226. <table>
  4227. <thead>
  4228. <tr>
  4229. <th>Field</th>
  4230. <th>Description</th>
  4231. </tr>
  4232. </thead>
  4233. <tbody>
  4234. <tr>
  4235. <td>
  4236. <code>configMap</code></br>
  4237. <em>
  4238. <a href="#external-secrets.io/v1beta1.TemplateRef">
  4239. TemplateRef
  4240. </a>
  4241. </em>
  4242. </td>
  4243. <td>
  4244. </td>
  4245. </tr>
  4246. <tr>
  4247. <td>
  4248. <code>secret</code></br>
  4249. <em>
  4250. <a href="#external-secrets.io/v1beta1.TemplateRef">
  4251. TemplateRef
  4252. </a>
  4253. </em>
  4254. </td>
  4255. <td>
  4256. </td>
  4257. </tr>
  4258. </tbody>
  4259. </table>
  4260. <h3 id="external-secrets.io/v1beta1.TemplateRef">TemplateRef
  4261. </h3>
  4262. <p>
  4263. (<em>Appears on:</em>
  4264. <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
  4265. </p>
  4266. <p>
  4267. </p>
  4268. <table>
  4269. <thead>
  4270. <tr>
  4271. <th>Field</th>
  4272. <th>Description</th>
  4273. </tr>
  4274. </thead>
  4275. <tbody>
  4276. <tr>
  4277. <td>
  4278. <code>name</code></br>
  4279. <em>
  4280. string
  4281. </em>
  4282. </td>
  4283. <td>
  4284. </td>
  4285. </tr>
  4286. <tr>
  4287. <td>
  4288. <code>items</code></br>
  4289. <em>
  4290. <a href="#external-secrets.io/v1beta1.TemplateRefItem">
  4291. []TemplateRefItem
  4292. </a>
  4293. </em>
  4294. </td>
  4295. <td>
  4296. </td>
  4297. </tr>
  4298. </tbody>
  4299. </table>
  4300. <h3 id="external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem
  4301. </h3>
  4302. <p>
  4303. (<em>Appears on:</em>
  4304. <a href="#external-secrets.io/v1beta1.TemplateRef">TemplateRef</a>)
  4305. </p>
  4306. <p>
  4307. </p>
  4308. <table>
  4309. <thead>
  4310. <tr>
  4311. <th>Field</th>
  4312. <th>Description</th>
  4313. </tr>
  4314. </thead>
  4315. <tbody>
  4316. <tr>
  4317. <td>
  4318. <code>key</code></br>
  4319. <em>
  4320. string
  4321. </em>
  4322. </td>
  4323. <td>
  4324. </td>
  4325. </tr>
  4326. </tbody>
  4327. </table>
  4328. <h3 id="external-secrets.io/v1beta1.TokenAuth">TokenAuth
  4329. </h3>
  4330. <p>
  4331. (<em>Appears on:</em>
  4332. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  4333. </p>
  4334. <p>
  4335. </p>
  4336. <table>
  4337. <thead>
  4338. <tr>
  4339. <th>Field</th>
  4340. <th>Description</th>
  4341. </tr>
  4342. </thead>
  4343. <tbody>
  4344. <tr>
  4345. <td>
  4346. <code>bearerToken</code></br>
  4347. <em>
  4348. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4349. </em>
  4350. </td>
  4351. <td>
  4352. </td>
  4353. </tr>
  4354. </tbody>
  4355. </table>
  4356. <h3 id="external-secrets.io/v1beta1.ValidationResult">ValidationResult
  4357. (<code>byte</code> alias)</p></h3>
  4358. <p>
  4359. </p>
  4360. <table>
  4361. <thead>
  4362. <tr>
  4363. <th>Value</th>
  4364. <th>Description</th>
  4365. </tr>
  4366. </thead>
  4367. <tbody><tr><td><p>2</p></td>
  4368. <td></td>
  4369. </tr><tr><td><p>0</p></td>
  4370. <td></td>
  4371. </tr><tr><td><p>1</p></td>
  4372. <td></td>
  4373. </tr></tbody>
  4374. </table>
  4375. <h3 id="external-secrets.io/v1beta1.VaultAppRole">VaultAppRole
  4376. </h3>
  4377. <p>
  4378. (<em>Appears on:</em>
  4379. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  4380. </p>
  4381. <p>
  4382. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  4383. with the role and secret stored in a Kubernetes Secret resource.</p>
  4384. </p>
  4385. <table>
  4386. <thead>
  4387. <tr>
  4388. <th>Field</th>
  4389. <th>Description</th>
  4390. </tr>
  4391. </thead>
  4392. <tbody>
  4393. <tr>
  4394. <td>
  4395. <code>path</code></br>
  4396. <em>
  4397. string
  4398. </em>
  4399. </td>
  4400. <td>
  4401. <p>Path where the App Role authentication backend is mounted
  4402. in Vault, e.g: &ldquo;approle&rdquo;</p>
  4403. </td>
  4404. </tr>
  4405. <tr>
  4406. <td>
  4407. <code>roleId</code></br>
  4408. <em>
  4409. string
  4410. </em>
  4411. </td>
  4412. <td>
  4413. <p>RoleID configured in the App Role authentication backend when setting
  4414. up the authentication backend in Vault.</p>
  4415. </td>
  4416. </tr>
  4417. <tr>
  4418. <td>
  4419. <code>secretRef</code></br>
  4420. <em>
  4421. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4422. </em>
  4423. </td>
  4424. <td>
  4425. <p>Reference to a key in a Secret that contains the App Role secret used
  4426. to authenticate with Vault.
  4427. The <code>key</code> field must be specified and denotes which entry within the Secret
  4428. resource is used as the app role secret.</p>
  4429. </td>
  4430. </tr>
  4431. </tbody>
  4432. </table>
  4433. <h3 id="external-secrets.io/v1beta1.VaultAuth">VaultAuth
  4434. </h3>
  4435. <p>
  4436. (<em>Appears on:</em>
  4437. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  4438. </p>
  4439. <p>
  4440. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  4441. Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>jwt</code> or <code>cert</code>
  4442. can be specified.</p>
  4443. </p>
  4444. <table>
  4445. <thead>
  4446. <tr>
  4447. <th>Field</th>
  4448. <th>Description</th>
  4449. </tr>
  4450. </thead>
  4451. <tbody>
  4452. <tr>
  4453. <td>
  4454. <code>tokenSecretRef</code></br>
  4455. <em>
  4456. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4457. </em>
  4458. </td>
  4459. <td>
  4460. <em>(Optional)</em>
  4461. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  4462. </td>
  4463. </tr>
  4464. <tr>
  4465. <td>
  4466. <code>appRole</code></br>
  4467. <em>
  4468. <a href="#external-secrets.io/v1beta1.VaultAppRole">
  4469. VaultAppRole
  4470. </a>
  4471. </em>
  4472. </td>
  4473. <td>
  4474. <em>(Optional)</em>
  4475. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  4476. with the role and secret stored in a Kubernetes Secret resource.</p>
  4477. </td>
  4478. </tr>
  4479. <tr>
  4480. <td>
  4481. <code>kubernetes</code></br>
  4482. <em>
  4483. <a href="#external-secrets.io/v1beta1.VaultKubernetesAuth">
  4484. VaultKubernetesAuth
  4485. </a>
  4486. </em>
  4487. </td>
  4488. <td>
  4489. <em>(Optional)</em>
  4490. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  4491. token stored in the named Secret resource to the Vault server.</p>
  4492. </td>
  4493. </tr>
  4494. <tr>
  4495. <td>
  4496. <code>ldap</code></br>
  4497. <em>
  4498. <a href="#external-secrets.io/v1beta1.VaultLdapAuth">
  4499. VaultLdapAuth
  4500. </a>
  4501. </em>
  4502. </td>
  4503. <td>
  4504. <em>(Optional)</em>
  4505. <p>Ldap authenticates with Vault by passing username/password pair using
  4506. the LDAP authentication method</p>
  4507. </td>
  4508. </tr>
  4509. <tr>
  4510. <td>
  4511. <code>jwt</code></br>
  4512. <em>
  4513. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">
  4514. VaultJwtAuth
  4515. </a>
  4516. </em>
  4517. </td>
  4518. <td>
  4519. <em>(Optional)</em>
  4520. <p>Jwt authenticates with Vault by passing role and JWT token using the
  4521. JWT/OIDC authentication method</p>
  4522. </td>
  4523. </tr>
  4524. <tr>
  4525. <td>
  4526. <code>cert</code></br>
  4527. <em>
  4528. <a href="#external-secrets.io/v1beta1.VaultCertAuth">
  4529. VaultCertAuth
  4530. </a>
  4531. </em>
  4532. </td>
  4533. <td>
  4534. <em>(Optional)</em>
  4535. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  4536. Cert authentication method</p>
  4537. </td>
  4538. </tr>
  4539. </tbody>
  4540. </table>
  4541. <h3 id="external-secrets.io/v1beta1.VaultCertAuth">VaultCertAuth
  4542. </h3>
  4543. <p>
  4544. (<em>Appears on:</em>
  4545. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  4546. </p>
  4547. <p>
  4548. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  4549. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  4550. </p>
  4551. <table>
  4552. <thead>
  4553. <tr>
  4554. <th>Field</th>
  4555. <th>Description</th>
  4556. </tr>
  4557. </thead>
  4558. <tbody>
  4559. <tr>
  4560. <td>
  4561. <code>clientCert</code></br>
  4562. <em>
  4563. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4564. </em>
  4565. </td>
  4566. <td>
  4567. <em>(Optional)</em>
  4568. <p>ClientCert is a certificate to authenticate using the Cert Vault
  4569. authentication method</p>
  4570. </td>
  4571. </tr>
  4572. <tr>
  4573. <td>
  4574. <code>secretRef</code></br>
  4575. <em>
  4576. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4577. </em>
  4578. </td>
  4579. <td>
  4580. <p>SecretRef to a key in a Secret resource containing client private key to
  4581. authenticate with Vault using the Cert authentication method</p>
  4582. </td>
  4583. </tr>
  4584. </tbody>
  4585. </table>
  4586. <h3 id="external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth
  4587. </h3>
  4588. <p>
  4589. (<em>Appears on:</em>
  4590. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  4591. </p>
  4592. <p>
  4593. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  4594. method, with the role name and a token stored in a Kubernetes Secret resource or
  4595. a Kubernetes service account token retrieved via <code>TokenRequest</code>.</p>
  4596. </p>
  4597. <table>
  4598. <thead>
  4599. <tr>
  4600. <th>Field</th>
  4601. <th>Description</th>
  4602. </tr>
  4603. </thead>
  4604. <tbody>
  4605. <tr>
  4606. <td>
  4607. <code>path</code></br>
  4608. <em>
  4609. string
  4610. </em>
  4611. </td>
  4612. <td>
  4613. <p>Path where the JWT authentication backend is mounted
  4614. in Vault, e.g: &ldquo;jwt&rdquo;</p>
  4615. </td>
  4616. </tr>
  4617. <tr>
  4618. <td>
  4619. <code>role</code></br>
  4620. <em>
  4621. string
  4622. </em>
  4623. </td>
  4624. <td>
  4625. <em>(Optional)</em>
  4626. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  4627. authentication method</p>
  4628. </td>
  4629. </tr>
  4630. <tr>
  4631. <td>
  4632. <code>secretRef</code></br>
  4633. <em>
  4634. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4635. </em>
  4636. </td>
  4637. <td>
  4638. <em>(Optional)</em>
  4639. <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  4640. authenticate with Vault using the JWT/OIDC authentication method.</p>
  4641. </td>
  4642. </tr>
  4643. <tr>
  4644. <td>
  4645. <code>kubernetesServiceAccountToken</code></br>
  4646. <em>
  4647. <a href="#external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">
  4648. VaultKubernetesServiceAccountTokenAuth
  4649. </a>
  4650. </em>
  4651. </td>
  4652. <td>
  4653. <em>(Optional)</em>
  4654. <p>Optional ServiceAccountToken specifies the Kubernetes service account for which to request
  4655. a token for with the <code>TokenRequest</code> API.</p>
  4656. </td>
  4657. </tr>
  4658. </tbody>
  4659. </table>
  4660. <h3 id="external-secrets.io/v1beta1.VaultKVStoreVersion">VaultKVStoreVersion
  4661. (<code>string</code> alias)</p></h3>
  4662. <p>
  4663. (<em>Appears on:</em>
  4664. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  4665. </p>
  4666. <p>
  4667. </p>
  4668. <table>
  4669. <thead>
  4670. <tr>
  4671. <th>Value</th>
  4672. <th>Description</th>
  4673. </tr>
  4674. </thead>
  4675. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  4676. <td></td>
  4677. </tr><tr><td><p>&#34;v2&#34;</p></td>
  4678. <td></td>
  4679. </tr></tbody>
  4680. </table>
  4681. <h3 id="external-secrets.io/v1beta1.VaultKubernetesAuth">VaultKubernetesAuth
  4682. </h3>
  4683. <p>
  4684. (<em>Appears on:</em>
  4685. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  4686. </p>
  4687. <p>
  4688. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  4689. a Secret.</p>
  4690. </p>
  4691. <table>
  4692. <thead>
  4693. <tr>
  4694. <th>Field</th>
  4695. <th>Description</th>
  4696. </tr>
  4697. </thead>
  4698. <tbody>
  4699. <tr>
  4700. <td>
  4701. <code>mountPath</code></br>
  4702. <em>
  4703. string
  4704. </em>
  4705. </td>
  4706. <td>
  4707. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  4708. &ldquo;kubernetes&rdquo;</p>
  4709. </td>
  4710. </tr>
  4711. <tr>
  4712. <td>
  4713. <code>serviceAccountRef</code></br>
  4714. <em>
  4715. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  4716. </em>
  4717. </td>
  4718. <td>
  4719. <em>(Optional)</em>
  4720. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  4721. If the service account is specified, the service account secret token JWT will be used
  4722. for authenticating with Vault. If the service account selector is not supplied,
  4723. the secretRef will be used instead.</p>
  4724. </td>
  4725. </tr>
  4726. <tr>
  4727. <td>
  4728. <code>secretRef</code></br>
  4729. <em>
  4730. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4731. </em>
  4732. </td>
  4733. <td>
  4734. <em>(Optional)</em>
  4735. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  4736. for authenticating with Vault. If a name is specified without a key,
  4737. <code>token</code> is the default. If one is not specified, the one bound to
  4738. the controller will be used.</p>
  4739. </td>
  4740. </tr>
  4741. <tr>
  4742. <td>
  4743. <code>role</code></br>
  4744. <em>
  4745. string
  4746. </em>
  4747. </td>
  4748. <td>
  4749. <p>A required field containing the Vault Role to assume. A Role binds a
  4750. Kubernetes ServiceAccount with a set of Vault policies.</p>
  4751. </td>
  4752. </tr>
  4753. </tbody>
  4754. </table>
  4755. <h3 id="external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">VaultKubernetesServiceAccountTokenAuth
  4756. </h3>
  4757. <p>
  4758. (<em>Appears on:</em>
  4759. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth</a>)
  4760. </p>
  4761. <p>
  4762. <p>VaultKubernetesServiceAccountTokenAuth authenticates with Vault using a temporary
  4763. Kubernetes service account token retrieved by the <code>TokenRequest</code> API.</p>
  4764. </p>
  4765. <table>
  4766. <thead>
  4767. <tr>
  4768. <th>Field</th>
  4769. <th>Description</th>
  4770. </tr>
  4771. </thead>
  4772. <tbody>
  4773. <tr>
  4774. <td>
  4775. <code>serviceAccountRef</code></br>
  4776. <em>
  4777. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  4778. </em>
  4779. </td>
  4780. <td>
  4781. <p>Service account field containing the name of a kubernetes ServiceAccount.</p>
  4782. </td>
  4783. </tr>
  4784. <tr>
  4785. <td>
  4786. <code>audiences</code></br>
  4787. <em>
  4788. []string
  4789. </em>
  4790. </td>
  4791. <td>
  4792. <em>(Optional)</em>
  4793. <p>Optional audiences field that will be used to request a temporary Kubernetes service
  4794. account token for the service account referenced by <code>serviceAccountRef</code>.
  4795. Defaults to a single audience <code>vault</code> it not specified.</p>
  4796. </td>
  4797. </tr>
  4798. <tr>
  4799. <td>
  4800. <code>expirationSeconds</code></br>
  4801. <em>
  4802. int64
  4803. </em>
  4804. </td>
  4805. <td>
  4806. <em>(Optional)</em>
  4807. <p>Optional expiration time in seconds that will be used to request a temporary
  4808. Kubernetes service account token for the service account referenced by
  4809. <code>serviceAccountRef</code>.
  4810. Defaults to 10 minutes.</p>
  4811. </td>
  4812. </tr>
  4813. </tbody>
  4814. </table>
  4815. <h3 id="external-secrets.io/v1beta1.VaultLdapAuth">VaultLdapAuth
  4816. </h3>
  4817. <p>
  4818. (<em>Appears on:</em>
  4819. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  4820. </p>
  4821. <p>
  4822. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  4823. with the username and password stored in a Kubernetes Secret resource.</p>
  4824. </p>
  4825. <table>
  4826. <thead>
  4827. <tr>
  4828. <th>Field</th>
  4829. <th>Description</th>
  4830. </tr>
  4831. </thead>
  4832. <tbody>
  4833. <tr>
  4834. <td>
  4835. <code>path</code></br>
  4836. <em>
  4837. string
  4838. </em>
  4839. </td>
  4840. <td>
  4841. <p>Path where the LDAP authentication backend is mounted
  4842. in Vault, e.g: &ldquo;ldap&rdquo;</p>
  4843. </td>
  4844. </tr>
  4845. <tr>
  4846. <td>
  4847. <code>username</code></br>
  4848. <em>
  4849. string
  4850. </em>
  4851. </td>
  4852. <td>
  4853. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  4854. authentication method</p>
  4855. </td>
  4856. </tr>
  4857. <tr>
  4858. <td>
  4859. <code>secretRef</code></br>
  4860. <em>
  4861. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4862. </em>
  4863. </td>
  4864. <td>
  4865. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  4866. user used to authenticate with Vault using the LDAP authentication
  4867. method</p>
  4868. </td>
  4869. </tr>
  4870. </tbody>
  4871. </table>
  4872. <h3 id="external-secrets.io/v1beta1.VaultProvider">VaultProvider
  4873. </h3>
  4874. <p>
  4875. (<em>Appears on:</em>
  4876. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4877. </p>
  4878. <p>
  4879. <p>Configures an store to sync secrets using a HashiCorp Vault
  4880. KV backend.</p>
  4881. </p>
  4882. <table>
  4883. <thead>
  4884. <tr>
  4885. <th>Field</th>
  4886. <th>Description</th>
  4887. </tr>
  4888. </thead>
  4889. <tbody>
  4890. <tr>
  4891. <td>
  4892. <code>auth</code></br>
  4893. <em>
  4894. <a href="#external-secrets.io/v1beta1.VaultAuth">
  4895. VaultAuth
  4896. </a>
  4897. </em>
  4898. </td>
  4899. <td>
  4900. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  4901. </td>
  4902. </tr>
  4903. <tr>
  4904. <td>
  4905. <code>server</code></br>
  4906. <em>
  4907. string
  4908. </em>
  4909. </td>
  4910. <td>
  4911. <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>
  4912. </td>
  4913. </tr>
  4914. <tr>
  4915. <td>
  4916. <code>path</code></br>
  4917. <em>
  4918. string
  4919. </em>
  4920. </td>
  4921. <td>
  4922. <em>(Optional)</em>
  4923. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  4924. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  4925. for fetching secrets from Vault is optional and will be appended
  4926. if not present in specified path.</p>
  4927. </td>
  4928. </tr>
  4929. <tr>
  4930. <td>
  4931. <code>version</code></br>
  4932. <em>
  4933. <a href="#external-secrets.io/v1beta1.VaultKVStoreVersion">
  4934. VaultKVStoreVersion
  4935. </a>
  4936. </em>
  4937. </td>
  4938. <td>
  4939. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  4940. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  4941. </td>
  4942. </tr>
  4943. <tr>
  4944. <td>
  4945. <code>namespace</code></br>
  4946. <em>
  4947. string
  4948. </em>
  4949. </td>
  4950. <td>
  4951. <em>(Optional)</em>
  4952. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  4953. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  4954. 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>
  4955. </td>
  4956. </tr>
  4957. <tr>
  4958. <td>
  4959. <code>caBundle</code></br>
  4960. <em>
  4961. []byte
  4962. </em>
  4963. </td>
  4964. <td>
  4965. <em>(Optional)</em>
  4966. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  4967. if the Server URL is using HTTPS protocol. This parameter is ignored for
  4968. plain HTTP protocol connection. If not set the system root certificates
  4969. are used to validate the TLS connection.</p>
  4970. </td>
  4971. </tr>
  4972. <tr>
  4973. <td>
  4974. <code>caProvider</code></br>
  4975. <em>
  4976. <a href="#external-secrets.io/v1beta1.CAProvider">
  4977. CAProvider
  4978. </a>
  4979. </em>
  4980. </td>
  4981. <td>
  4982. <em>(Optional)</em>
  4983. <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
  4984. </td>
  4985. </tr>
  4986. <tr>
  4987. <td>
  4988. <code>readYourWrites</code></br>
  4989. <em>
  4990. bool
  4991. </em>
  4992. </td>
  4993. <td>
  4994. <em>(Optional)</em>
  4995. <p>ReadYourWrites ensures isolated read-after-write semantics by
  4996. providing discovered cluster replication states in each request.
  4997. More information about eventual consistency in Vault can be found here
  4998. <a href="https://www.vaultproject.io/docs/enterprise/consistency">https://www.vaultproject.io/docs/enterprise/consistency</a></p>
  4999. </td>
  5000. </tr>
  5001. <tr>
  5002. <td>
  5003. <code>forwardInconsistent</code></br>
  5004. <em>
  5005. bool
  5006. </em>
  5007. </td>
  5008. <td>
  5009. <em>(Optional)</em>
  5010. <p>ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
  5011. leader instead of simply retrying within a loop. This can increase performance if
  5012. the option is enabled serverside.
  5013. <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>
  5014. </td>
  5015. </tr>
  5016. </tbody>
  5017. </table>
  5018. <h3 id="external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider
  5019. </h3>
  5020. <p>
  5021. (<em>Appears on:</em>
  5022. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  5023. </p>
  5024. <p>
  5025. <p>Defines a location to fetch the cert for the webhook provider from.</p>
  5026. </p>
  5027. <table>
  5028. <thead>
  5029. <tr>
  5030. <th>Field</th>
  5031. <th>Description</th>
  5032. </tr>
  5033. </thead>
  5034. <tbody>
  5035. <tr>
  5036. <td>
  5037. <code>type</code></br>
  5038. <em>
  5039. <a href="#external-secrets.io/v1beta1.WebhookCAProviderType">
  5040. WebhookCAProviderType
  5041. </a>
  5042. </em>
  5043. </td>
  5044. <td>
  5045. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  5046. </td>
  5047. </tr>
  5048. <tr>
  5049. <td>
  5050. <code>name</code></br>
  5051. <em>
  5052. string
  5053. </em>
  5054. </td>
  5055. <td>
  5056. <p>The name of the object located at the provider type.</p>
  5057. </td>
  5058. </tr>
  5059. <tr>
  5060. <td>
  5061. <code>key</code></br>
  5062. <em>
  5063. string
  5064. </em>
  5065. </td>
  5066. <td>
  5067. <p>The key the value inside of the provider type to use, only used with &ldquo;Secret&rdquo; type</p>
  5068. </td>
  5069. </tr>
  5070. <tr>
  5071. <td>
  5072. <code>namespace</code></br>
  5073. <em>
  5074. string
  5075. </em>
  5076. </td>
  5077. <td>
  5078. <em>(Optional)</em>
  5079. <p>The namespace the Provider type is in.</p>
  5080. </td>
  5081. </tr>
  5082. </tbody>
  5083. </table>
  5084. <h3 id="external-secrets.io/v1beta1.WebhookCAProviderType">WebhookCAProviderType
  5085. (<code>string</code> alias)</p></h3>
  5086. <p>
  5087. (<em>Appears on:</em>
  5088. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider</a>)
  5089. </p>
  5090. <p>
  5091. </p>
  5092. <table>
  5093. <thead>
  5094. <tr>
  5095. <th>Value</th>
  5096. <th>Description</th>
  5097. </tr>
  5098. </thead>
  5099. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  5100. <td></td>
  5101. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  5102. <td></td>
  5103. </tr></tbody>
  5104. </table>
  5105. <h3 id="external-secrets.io/v1beta1.WebhookProvider">WebhookProvider
  5106. </h3>
  5107. <p>
  5108. (<em>Appears on:</em>
  5109. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5110. </p>
  5111. <p>
  5112. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  5113. </p>
  5114. <table>
  5115. <thead>
  5116. <tr>
  5117. <th>Field</th>
  5118. <th>Description</th>
  5119. </tr>
  5120. </thead>
  5121. <tbody>
  5122. <tr>
  5123. <td>
  5124. <code>method</code></br>
  5125. <em>
  5126. string
  5127. </em>
  5128. </td>
  5129. <td>
  5130. <p>Webhook Method</p>
  5131. </td>
  5132. </tr>
  5133. <tr>
  5134. <td>
  5135. <code>url</code></br>
  5136. <em>
  5137. string
  5138. </em>
  5139. </td>
  5140. <td>
  5141. <p>Webhook url to call</p>
  5142. </td>
  5143. </tr>
  5144. <tr>
  5145. <td>
  5146. <code>headers</code></br>
  5147. <em>
  5148. map[string]string
  5149. </em>
  5150. </td>
  5151. <td>
  5152. <em>(Optional)</em>
  5153. <p>Headers</p>
  5154. </td>
  5155. </tr>
  5156. <tr>
  5157. <td>
  5158. <code>body</code></br>
  5159. <em>
  5160. string
  5161. </em>
  5162. </td>
  5163. <td>
  5164. <em>(Optional)</em>
  5165. <p>Body</p>
  5166. </td>
  5167. </tr>
  5168. <tr>
  5169. <td>
  5170. <code>timeout</code></br>
  5171. <em>
  5172. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  5173. Kubernetes meta/v1.Duration
  5174. </a>
  5175. </em>
  5176. </td>
  5177. <td>
  5178. <em>(Optional)</em>
  5179. <p>Timeout</p>
  5180. </td>
  5181. </tr>
  5182. <tr>
  5183. <td>
  5184. <code>result</code></br>
  5185. <em>
  5186. <a href="#external-secrets.io/v1beta1.WebhookResult">
  5187. WebhookResult
  5188. </a>
  5189. </em>
  5190. </td>
  5191. <td>
  5192. <p>Result formatting</p>
  5193. </td>
  5194. </tr>
  5195. <tr>
  5196. <td>
  5197. <code>secrets</code></br>
  5198. <em>
  5199. <a href="#external-secrets.io/v1beta1.WebhookSecret">
  5200. []WebhookSecret
  5201. </a>
  5202. </em>
  5203. </td>
  5204. <td>
  5205. <em>(Optional)</em>
  5206. <p>Secrets to fill in templates
  5207. These secrets will be passed to the templating function as key value pairs under the given name</p>
  5208. </td>
  5209. </tr>
  5210. <tr>
  5211. <td>
  5212. <code>caBundle</code></br>
  5213. <em>
  5214. []byte
  5215. </em>
  5216. </td>
  5217. <td>
  5218. <em>(Optional)</em>
  5219. <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
  5220. if the Server URL is using HTTPS protocol. This parameter is ignored for
  5221. plain HTTP protocol connection. If not set the system root certificates
  5222. are used to validate the TLS connection.</p>
  5223. </td>
  5224. </tr>
  5225. <tr>
  5226. <td>
  5227. <code>caProvider</code></br>
  5228. <em>
  5229. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">
  5230. WebhookCAProvider
  5231. </a>
  5232. </em>
  5233. </td>
  5234. <td>
  5235. <em>(Optional)</em>
  5236. <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
  5237. </td>
  5238. </tr>
  5239. </tbody>
  5240. </table>
  5241. <h3 id="external-secrets.io/v1beta1.WebhookResult">WebhookResult
  5242. </h3>
  5243. <p>
  5244. (<em>Appears on:</em>
  5245. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  5246. </p>
  5247. <p>
  5248. </p>
  5249. <table>
  5250. <thead>
  5251. <tr>
  5252. <th>Field</th>
  5253. <th>Description</th>
  5254. </tr>
  5255. </thead>
  5256. <tbody>
  5257. <tr>
  5258. <td>
  5259. <code>jsonPath</code></br>
  5260. <em>
  5261. string
  5262. </em>
  5263. </td>
  5264. <td>
  5265. <em>(Optional)</em>
  5266. <p>Json path of return value</p>
  5267. </td>
  5268. </tr>
  5269. </tbody>
  5270. </table>
  5271. <h3 id="external-secrets.io/v1beta1.WebhookSecret">WebhookSecret
  5272. </h3>
  5273. <p>
  5274. (<em>Appears on:</em>
  5275. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  5276. </p>
  5277. <p>
  5278. </p>
  5279. <table>
  5280. <thead>
  5281. <tr>
  5282. <th>Field</th>
  5283. <th>Description</th>
  5284. </tr>
  5285. </thead>
  5286. <tbody>
  5287. <tr>
  5288. <td>
  5289. <code>name</code></br>
  5290. <em>
  5291. string
  5292. </em>
  5293. </td>
  5294. <td>
  5295. <p>Name of this secret in templates</p>
  5296. </td>
  5297. </tr>
  5298. <tr>
  5299. <td>
  5300. <code>secretRef</code></br>
  5301. <em>
  5302. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  5303. </em>
  5304. </td>
  5305. <td>
  5306. <p>Secret ref to fill in credentials</p>
  5307. </td>
  5308. </tr>
  5309. </tbody>
  5310. </table>
  5311. <h3 id="external-secrets.io/v1beta1.YandexLockboxAuth">YandexLockboxAuth
  5312. </h3>
  5313. <p>
  5314. (<em>Appears on:</em>
  5315. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  5316. </p>
  5317. <p>
  5318. </p>
  5319. <table>
  5320. <thead>
  5321. <tr>
  5322. <th>Field</th>
  5323. <th>Description</th>
  5324. </tr>
  5325. </thead>
  5326. <tbody>
  5327. <tr>
  5328. <td>
  5329. <code>authorizedKeySecretRef</code></br>
  5330. <em>
  5331. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  5332. </em>
  5333. </td>
  5334. <td>
  5335. <em>(Optional)</em>
  5336. <p>The authorized key used for authentication</p>
  5337. </td>
  5338. </tr>
  5339. </tbody>
  5340. </table>
  5341. <h3 id="external-secrets.io/v1beta1.YandexLockboxCAProvider">YandexLockboxCAProvider
  5342. </h3>
  5343. <p>
  5344. (<em>Appears on:</em>
  5345. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  5346. </p>
  5347. <p>
  5348. </p>
  5349. <table>
  5350. <thead>
  5351. <tr>
  5352. <th>Field</th>
  5353. <th>Description</th>
  5354. </tr>
  5355. </thead>
  5356. <tbody>
  5357. <tr>
  5358. <td>
  5359. <code>certSecretRef</code></br>
  5360. <em>
  5361. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  5362. </em>
  5363. </td>
  5364. <td>
  5365. </td>
  5366. </tr>
  5367. </tbody>
  5368. </table>
  5369. <h3 id="external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider
  5370. </h3>
  5371. <p>
  5372. (<em>Appears on:</em>
  5373. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5374. </p>
  5375. <p>
  5376. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
  5377. </p>
  5378. <table>
  5379. <thead>
  5380. <tr>
  5381. <th>Field</th>
  5382. <th>Description</th>
  5383. </tr>
  5384. </thead>
  5385. <tbody>
  5386. <tr>
  5387. <td>
  5388. <code>apiEndpoint</code></br>
  5389. <em>
  5390. string
  5391. </em>
  5392. </td>
  5393. <td>
  5394. <em>(Optional)</em>
  5395. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  5396. </td>
  5397. </tr>
  5398. <tr>
  5399. <td>
  5400. <code>auth</code></br>
  5401. <em>
  5402. <a href="#external-secrets.io/v1beta1.YandexLockboxAuth">
  5403. YandexLockboxAuth
  5404. </a>
  5405. </em>
  5406. </td>
  5407. <td>
  5408. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
  5409. </td>
  5410. </tr>
  5411. <tr>
  5412. <td>
  5413. <code>caProvider</code></br>
  5414. <em>
  5415. <a href="#external-secrets.io/v1beta1.YandexLockboxCAProvider">
  5416. YandexLockboxCAProvider
  5417. </a>
  5418. </em>
  5419. </td>
  5420. <td>
  5421. <em>(Optional)</em>
  5422. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  5423. </td>
  5424. </tr>
  5425. </tbody>
  5426. </table>
  5427. <hr/>
  5428. <p><em>
  5429. Generated with <code>gen-crd-api-reference-docs</code>.
  5430. </em></p>
  5431. </article>
  5432. </div>
  5433. </div>
  5434. </main>
  5435. <footer class="md-footer">
  5436. <nav class="md-footer__inner md-grid" aria-label="Footer">
  5437. <a href="../eso-blogs/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Blogs" rel="prev">
  5438. <div class="md-footer__button md-icon">
  5439. <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>
  5440. </div>
  5441. <div class="md-footer__title">
  5442. <div class="md-ellipsis">
  5443. <span class="md-footer__direction">
  5444. Previous
  5445. </span>
  5446. Blogs
  5447. </div>
  5448. </div>
  5449. </a>
  5450. <a href="../contributing-devguide/" class="md-footer__link md-footer__link--next" aria-label="Next: Developer guide" rel="next">
  5451. <div class="md-footer__title">
  5452. <div class="md-ellipsis">
  5453. <span class="md-footer__direction">
  5454. Next
  5455. </span>
  5456. Developer guide
  5457. </div>
  5458. </div>
  5459. <div class="md-footer__button md-icon">
  5460. <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>
  5461. </div>
  5462. </a>
  5463. </nav>
  5464. <div class="md-footer-meta md-typeset">
  5465. <div class="md-footer-meta__inner md-grid">
  5466. <div class="md-copyright">
  5467. Made with
  5468. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  5469. Material for MkDocs
  5470. </a>
  5471. </div>
  5472. </div>
  5473. </div>
  5474. </footer>
  5475. </div>
  5476. <div class="md-dialog" data-md-component="dialog">
  5477. <div class="md-dialog__inner md-typeset"></div>
  5478. </div>
  5479. <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  5480. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  5481. </body>
  5482. </html>