index.html 151 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043
  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. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  103. <div class="md-tabs__inner md-grid">
  104. <ul class="md-tabs__list">
  105. <li class="md-tabs__item">
  106. <a href="../.." class="md-tabs__link">
  107. Introduction
  108. </a>
  109. </li>
  110. <li class="md-tabs__item">
  111. <a href="../components/" class="md-tabs__link md-tabs__link--active">
  112. API
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../../guides/introduction/" class="md-tabs__link">
  117. Guides
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  122. Provider
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  127. Examples
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../contributing/devguide/" class="md-tabs__link">
  132. Community
  133. </a>
  134. </li>
  135. </ul>
  136. </div>
  137. </nav>
  138. <main class="md-main" data-md-component="main">
  139. <div class="md-main__inner md-grid">
  140. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  141. <div class="md-sidebar__scrollwrap">
  142. <div class="md-sidebar__inner">
  143. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  144. <label class="md-nav__title" for="__drawer">
  145. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  146. <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>
  147. </a>
  148. External Secrets Operator
  149. </label>
  150. <div class="md-nav__source">
  151. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  152. <div class="md-source__icon md-icon">
  153. <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>
  154. </div>
  155. <div class="md-source__repository">
  156. External Secrets Operator
  157. </div>
  158. </a>
  159. </div>
  160. <ul class="md-nav__list" data-md-scrollfix>
  161. <li class="md-nav__item md-nav__item--nested">
  162. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  163. <div class="md-nav__link md-nav__link--index ">
  164. <a href="../..">Introduction</a>
  165. <label for="__nav_1">
  166. <span class="md-nav__icon md-icon"></span>
  167. </label>
  168. </div>
  169. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  170. <label class="md-nav__title" for="__nav_1">
  171. <span class="md-nav__icon md-icon"></span>
  172. Introduction
  173. </label>
  174. <ul class="md-nav__list" data-md-scrollfix>
  175. <li class="md-nav__item">
  176. <a href="../../introduction/overview/" class="md-nav__link">
  177. Overview
  178. </a>
  179. </li>
  180. <li class="md-nav__item">
  181. <a href="../../introduction/getting-started/" class="md-nav__link">
  182. Getting started
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../../introduction/faq/" class="md-nav__link">
  187. FAQ
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../../introduction/stability-support/" class="md-nav__link">
  192. Stability and Support
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  197. Deprecation Policy
  198. </a>
  199. </li>
  200. </ul>
  201. </nav>
  202. </li>
  203. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  204. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
  205. <label class="md-nav__link" for="__nav_2">
  206. API
  207. <span class="md-nav__icon md-icon"></span>
  208. </label>
  209. <nav class="md-nav" aria-label="API" data-md-level="1">
  210. <label class="md-nav__title" for="__nav_2">
  211. <span class="md-nav__icon md-icon"></span>
  212. API
  213. </label>
  214. <ul class="md-nav__list" data-md-scrollfix>
  215. <li class="md-nav__item">
  216. <a href="../components/" class="md-nav__link">
  217. Components
  218. </a>
  219. </li>
  220. <li class="md-nav__item md-nav__item--nested">
  221. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  222. <label class="md-nav__link" for="__nav_2_2">
  223. Core Resources
  224. <span class="md-nav__icon md-icon"></span>
  225. </label>
  226. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  227. <label class="md-nav__title" for="__nav_2_2">
  228. <span class="md-nav__icon md-icon"></span>
  229. Core Resources
  230. </label>
  231. <ul class="md-nav__list" data-md-scrollfix>
  232. <li class="md-nav__item">
  233. <a href="../externalsecret/" class="md-nav__link">
  234. ExternalSecret
  235. </a>
  236. </li>
  237. <li class="md-nav__item">
  238. <a href="../secretstore/" class="md-nav__link">
  239. SecretStore
  240. </a>
  241. </li>
  242. <li class="md-nav__item">
  243. <a href="../clustersecretstore/" class="md-nav__link">
  244. ClusterSecretStore
  245. </a>
  246. </li>
  247. <li class="md-nav__item">
  248. <a href="../clusterexternalsecret/" class="md-nav__link">
  249. ClusterExternalSecret
  250. </a>
  251. </li>
  252. <li class="md-nav__item">
  253. <a href="../pushsecret/" class="md-nav__link">
  254. PushSecret
  255. </a>
  256. </li>
  257. </ul>
  258. </nav>
  259. </li>
  260. <li class="md-nav__item md-nav__item--nested">
  261. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  262. <div class="md-nav__link md-nav__link--index ">
  263. <a href="../generator/">Generators</a>
  264. <label for="__nav_2_3">
  265. <span class="md-nav__icon md-icon"></span>
  266. </label>
  267. </div>
  268. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  269. <label class="md-nav__title" for="__nav_2_3">
  270. <span class="md-nav__icon md-icon"></span>
  271. Generators
  272. </label>
  273. <ul class="md-nav__list" data-md-scrollfix>
  274. <li class="md-nav__item">
  275. <a href="../generator/acr/" class="md-nav__link">
  276. Azure Container Registry
  277. </a>
  278. </li>
  279. <li class="md-nav__item">
  280. <a href="../generator/ecr/" class="md-nav__link">
  281. AWS Elastic Container Registry
  282. </a>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="../generator/gcr/" class="md-nav__link">
  286. Google Container Registry
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../generator/password/" class="md-nav__link">
  291. Password
  292. </a>
  293. </li>
  294. <li class="md-nav__item">
  295. <a href="../generator/fake/" class="md-nav__link">
  296. Fake
  297. </a>
  298. </li>
  299. </ul>
  300. </nav>
  301. </li>
  302. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  303. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" type="checkbox" id="__nav_2_4" checked>
  304. <label class="md-nav__link" for="__nav_2_4">
  305. Reference Docs
  306. <span class="md-nav__icon md-icon"></span>
  307. </label>
  308. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  309. <label class="md-nav__title" for="__nav_2_4">
  310. <span class="md-nav__icon md-icon"></span>
  311. Reference Docs
  312. </label>
  313. <ul class="md-nav__list" data-md-scrollfix>
  314. <li class="md-nav__item md-nav__item--active">
  315. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  316. <a href="./" class="md-nav__link md-nav__link--active">
  317. API specification
  318. </a>
  319. </li>
  320. <li class="md-nav__item">
  321. <a href="../controller-options/" class="md-nav__link">
  322. Controller Options
  323. </a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="../metrics/" class="md-nav__link">
  327. Metrics
  328. </a>
  329. </li>
  330. </ul>
  331. </nav>
  332. </li>
  333. </ul>
  334. </nav>
  335. </li>
  336. <li class="md-nav__item md-nav__item--nested">
  337. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  338. <label class="md-nav__link" for="__nav_3">
  339. Guides
  340. <span class="md-nav__icon md-icon"></span>
  341. </label>
  342. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  343. <label class="md-nav__title" for="__nav_3">
  344. <span class="md-nav__icon md-icon"></span>
  345. Guides
  346. </label>
  347. <ul class="md-nav__list" data-md-scrollfix>
  348. <li class="md-nav__item">
  349. <a href="../../guides/introduction/" class="md-nav__link">
  350. Introduction
  351. </a>
  352. </li>
  353. <li class="md-nav__item md-nav__item--nested">
  354. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  355. <label class="md-nav__link" for="__nav_3_2">
  356. Advanced Templating
  357. <span class="md-nav__icon md-icon"></span>
  358. </label>
  359. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  360. <label class="md-nav__title" for="__nav_3_2">
  361. <span class="md-nav__icon md-icon"></span>
  362. Advanced Templating
  363. </label>
  364. <ul class="md-nav__list" data-md-scrollfix>
  365. <li class="md-nav__item">
  366. <a href="../../guides/templating/" class="md-nav__link">
  367. v2
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../../guides/templating-v1/" class="md-nav__link">
  372. v1
  373. </a>
  374. </li>
  375. </ul>
  376. </nav>
  377. </li>
  378. <li class="md-nav__item">
  379. <a href="../../guides/generator/" class="md-nav__link">
  380. Generators
  381. </a>
  382. </li>
  383. <li class="md-nav__item">
  384. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  385. All keys, One secret
  386. </a>
  387. </li>
  388. <li class="md-nav__item">
  389. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  390. Common K8S Secret Types
  391. </a>
  392. </li>
  393. <li class="md-nav__item">
  394. <a href="../../guides/controller-class/" class="md-nav__link">
  395. Controller Classes
  396. </a>
  397. </li>
  398. <li class="md-nav__item">
  399. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  400. Lifecycle: ownership & deletion
  401. </a>
  402. </li>
  403. <li class="md-nav__item">
  404. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  405. Decoding Strategies
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../guides/getallsecrets/" class="md-nav__link">
  410. Getting Multiple Secrets
  411. </a>
  412. </li>
  413. <li class="md-nav__item">
  414. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  415. Multi Tenancy
  416. </a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  420. Rewriting Keys
  421. </a>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../../guides/v1beta1/" class="md-nav__link">
  425. Upgrading to v1beta1
  426. </a>
  427. </li>
  428. <li class="md-nav__item">
  429. <a href="../../guides/using-latest-image/" class="md-nav__link">
  430. Using Latest Image
  431. </a>
  432. </li>
  433. </ul>
  434. </nav>
  435. </li>
  436. <li class="md-nav__item md-nav__item--nested">
  437. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  438. <label class="md-nav__link" for="__nav_4">
  439. Provider
  440. <span class="md-nav__icon md-icon"></span>
  441. </label>
  442. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  443. <label class="md-nav__title" for="__nav_4">
  444. <span class="md-nav__icon md-icon"></span>
  445. Provider
  446. </label>
  447. <ul class="md-nav__list" data-md-scrollfix>
  448. <li class="md-nav__item">
  449. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  450. AWS Secrets Manager
  451. </a>
  452. </li>
  453. <li class="md-nav__item">
  454. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  455. AWS Parameter Store
  456. </a>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  460. Azure Key Vault
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  465. Google Secret Manager
  466. </a>
  467. </li>
  468. <li class="md-nav__item">
  469. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  470. IBM Secrets Manager
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="../../provider/akeyless/" class="md-nav__link">
  475. Akeyless
  476. </a>
  477. </li>
  478. <li class="md-nav__item">
  479. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  480. HashiCorp Vault
  481. </a>
  482. </li>
  483. <li class="md-nav__item">
  484. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  485. Yandex Certificate Manager
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  490. Yandex Lockbox
  491. </a>
  492. </li>
  493. <li class="md-nav__item">
  494. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  495. Gitlab Variables
  496. </a>
  497. </li>
  498. <li class="md-nav__item">
  499. <a href="../../provider/oracle-vault/" class="md-nav__link">
  500. Oracle Vault
  501. </a>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="../../provider/1password-automation/" class="md-nav__link">
  505. 1Password Secrets Automation
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../provider/webhook/" class="md-nav__link">
  510. Webhook
  511. </a>
  512. </li>
  513. <li class="md-nav__item">
  514. <a href="../../provider/fake/" class="md-nav__link">
  515. Fake
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../../provider/kubernetes/" class="md-nav__link">
  520. Kubernetes
  521. </a>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  525. senhasegura DevOps Secrets Management (DSM)
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="../../provider/doppler/" class="md-nav__link">
  530. Doppler
  531. </a>
  532. </li>
  533. </ul>
  534. </nav>
  535. </li>
  536. <li class="md-nav__item md-nav__item--nested">
  537. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  538. <label class="md-nav__link" for="__nav_5">
  539. Examples
  540. <span class="md-nav__icon md-icon"></span>
  541. </label>
  542. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  543. <label class="md-nav__title" for="__nav_5">
  544. <span class="md-nav__icon md-icon"></span>
  545. Examples
  546. </label>
  547. <ul class="md-nav__list" data-md-scrollfix>
  548. <li class="md-nav__item">
  549. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  550. FluxCD
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  555. Anchore Engine
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  560. Jenkins
  561. </a>
  562. </li>
  563. </ul>
  564. </nav>
  565. </li>
  566. <li class="md-nav__item md-nav__item--nested">
  567. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  568. <label class="md-nav__link" for="__nav_6">
  569. Community
  570. <span class="md-nav__icon md-icon"></span>
  571. </label>
  572. <nav class="md-nav" aria-label="Community" data-md-level="1">
  573. <label class="md-nav__title" for="__nav_6">
  574. <span class="md-nav__icon md-icon"></span>
  575. Community
  576. </label>
  577. <ul class="md-nav__list" data-md-scrollfix>
  578. <li class="md-nav__item md-nav__item--nested">
  579. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  580. <label class="md-nav__link" for="__nav_6_1">
  581. Contributing
  582. <span class="md-nav__icon md-icon"></span>
  583. </label>
  584. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  585. <label class="md-nav__title" for="__nav_6_1">
  586. <span class="md-nav__icon md-icon"></span>
  587. Contributing
  588. </label>
  589. <ul class="md-nav__list" data-md-scrollfix>
  590. <li class="md-nav__item">
  591. <a href="../../contributing/devguide/" class="md-nav__link">
  592. Developer guide
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../../contributing/process/" class="md-nav__link">
  597. Contributing Process
  598. </a>
  599. </li>
  600. <li class="md-nav__item">
  601. <a href="../../contributing/release/" class="md-nav__link">
  602. Release Process
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../../contributing/coc/" class="md-nav__link">
  607. Code of Conduct
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="../../contributing/roadmap/" class="md-nav__link">
  612. Roadmap
  613. </a>
  614. </li>
  615. </ul>
  616. </nav>
  617. </li>
  618. <li class="md-nav__item md-nav__item--nested">
  619. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  620. <label class="md-nav__link" for="__nav_6_2">
  621. External Resources
  622. <span class="md-nav__icon md-icon"></span>
  623. </label>
  624. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  625. <label class="md-nav__title" for="__nav_6_2">
  626. <span class="md-nav__icon md-icon"></span>
  627. External Resources
  628. </label>
  629. <ul class="md-nav__list" data-md-scrollfix>
  630. <li class="md-nav__item">
  631. <a href="../../eso-talks/" class="md-nav__link">
  632. Talks
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../../eso-demos/" class="md-nav__link">
  637. Demos
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../../eso-blogs/" class="md-nav__link">
  642. Blogs
  643. </a>
  644. </li>
  645. </ul>
  646. </nav>
  647. </li>
  648. </ul>
  649. </nav>
  650. </li>
  651. </ul>
  652. </nav>
  653. </div>
  654. </div>
  655. </div>
  656. <div class="md-content" data-md-component="content">
  657. <article class="md-content__inner md-typeset">
  658. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/api/spec.md" title="Edit this page" class="md-content__button md-icon">
  659. <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>
  660. </a>
  661. <h1>API specification</h1>
  662. <p>Packages:</p>
  663. <ul>
  664. <li>
  665. <a href="#external-secrets.io%2fv1beta1">external-secrets.io/v1beta1</a>
  666. </li>
  667. </ul>
  668. <h2 id="external-secrets.io/v1beta1">external-secrets.io/v1beta1</h2>
  669. <p>
  670. <p>Package v1beta1 contains resources for external-secrets</p>
  671. </p>
  672. <p>Resource Types:</p>
  673. <ul></ul>
  674. <h3 id="external-secrets.io/v1beta1.AWSAuth">AWSAuth
  675. </h3>
  676. <p>
  677. (<em>Appears on:</em>
  678. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  679. </p>
  680. <p>
  681. <p>AWSAuth tells the controller how to do authentication with aws.
  682. Only one of secretRef or jwt can be specified.
  683. if none is specified the controller will load credentials using the aws sdk defaults.</p>
  684. </p>
  685. <table>
  686. <thead>
  687. <tr>
  688. <th>Field</th>
  689. <th>Description</th>
  690. </tr>
  691. </thead>
  692. <tbody>
  693. <tr>
  694. <td>
  695. <code>secretRef</code></br>
  696. <em>
  697. <a href="#external-secrets.io/v1beta1.AWSAuthSecretRef">
  698. AWSAuthSecretRef
  699. </a>
  700. </em>
  701. </td>
  702. <td>
  703. <em>(Optional)</em>
  704. </td>
  705. </tr>
  706. <tr>
  707. <td>
  708. <code>jwt</code></br>
  709. <em>
  710. <a href="#external-secrets.io/v1beta1.AWSJWTAuth">
  711. AWSJWTAuth
  712. </a>
  713. </em>
  714. </td>
  715. <td>
  716. <em>(Optional)</em>
  717. </td>
  718. </tr>
  719. </tbody>
  720. </table>
  721. <h3 id="external-secrets.io/v1beta1.AWSAuthSecretRef">AWSAuthSecretRef
  722. </h3>
  723. <p>
  724. (<em>Appears on:</em>
  725. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  726. </p>
  727. <p>
  728. <p>AWSAuthSecretRef holds secret references for AWS credentials
  729. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  730. </p>
  731. <table>
  732. <thead>
  733. <tr>
  734. <th>Field</th>
  735. <th>Description</th>
  736. </tr>
  737. </thead>
  738. <tbody>
  739. <tr>
  740. <td>
  741. <code>accessKeyIDSecretRef</code></br>
  742. <em>
  743. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  744. External Secrets meta/v1.SecretKeySelector
  745. </a>
  746. </em>
  747. </td>
  748. <td>
  749. <p>The AccessKeyID is used for authentication</p>
  750. </td>
  751. </tr>
  752. <tr>
  753. <td>
  754. <code>secretAccessKeySecretRef</code></br>
  755. <em>
  756. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  757. External Secrets meta/v1.SecretKeySelector
  758. </a>
  759. </em>
  760. </td>
  761. <td>
  762. <p>The SecretAccessKey is used for authentication</p>
  763. </td>
  764. </tr>
  765. <tr>
  766. <td>
  767. <code>sessionTokenSecretRef</code></br>
  768. <em>
  769. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  770. External Secrets meta/v1.SecretKeySelector
  771. </a>
  772. </em>
  773. </td>
  774. <td>
  775. <p>The SessionToken used for authentication
  776. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  777. see: <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html">https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html</a></p>
  778. </td>
  779. </tr>
  780. </tbody>
  781. </table>
  782. <h3 id="external-secrets.io/v1beta1.AWSJWTAuth">AWSJWTAuth
  783. </h3>
  784. <p>
  785. (<em>Appears on:</em>
  786. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  787. </p>
  788. <p>
  789. <p>Authenticate against AWS using service account tokens.</p>
  790. </p>
  791. <table>
  792. <thead>
  793. <tr>
  794. <th>Field</th>
  795. <th>Description</th>
  796. </tr>
  797. </thead>
  798. <tbody>
  799. <tr>
  800. <td>
  801. <code>serviceAccountRef</code></br>
  802. <em>
  803. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  804. External Secrets meta/v1.ServiceAccountSelector
  805. </a>
  806. </em>
  807. </td>
  808. <td>
  809. </td>
  810. </tr>
  811. </tbody>
  812. </table>
  813. <h3 id="external-secrets.io/v1beta1.AWSProvider">AWSProvider
  814. </h3>
  815. <p>
  816. (<em>Appears on:</em>
  817. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  818. </p>
  819. <p>
  820. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  821. </p>
  822. <table>
  823. <thead>
  824. <tr>
  825. <th>Field</th>
  826. <th>Description</th>
  827. </tr>
  828. </thead>
  829. <tbody>
  830. <tr>
  831. <td>
  832. <code>service</code></br>
  833. <em>
  834. <a href="#external-secrets.io/v1beta1.AWSServiceType">
  835. AWSServiceType
  836. </a>
  837. </em>
  838. </td>
  839. <td>
  840. <p>Service defines which service should be used to fetch the secrets</p>
  841. </td>
  842. </tr>
  843. <tr>
  844. <td>
  845. <code>auth</code></br>
  846. <em>
  847. <a href="#external-secrets.io/v1beta1.AWSAuth">
  848. AWSAuth
  849. </a>
  850. </em>
  851. </td>
  852. <td>
  853. <em>(Optional)</em>
  854. <p>Auth defines the information necessary to authenticate against AWS
  855. if not set aws sdk will infer credentials from your environment
  856. 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>
  857. </td>
  858. </tr>
  859. <tr>
  860. <td>
  861. <code>role</code></br>
  862. <em>
  863. string
  864. </em>
  865. </td>
  866. <td>
  867. <em>(Optional)</em>
  868. <p>Role is a Role ARN which the SecretManager provider will assume</p>
  869. </td>
  870. </tr>
  871. <tr>
  872. <td>
  873. <code>region</code></br>
  874. <em>
  875. string
  876. </em>
  877. </td>
  878. <td>
  879. <p>AWS Region to be used for the provider</p>
  880. </td>
  881. </tr>
  882. </tbody>
  883. </table>
  884. <h3 id="external-secrets.io/v1beta1.AWSServiceType">AWSServiceType
  885. (<code>string</code> alias)</p></h3>
  886. <p>
  887. (<em>Appears on:</em>
  888. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  889. </p>
  890. <p>
  891. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  892. </p>
  893. <table>
  894. <thead>
  895. <tr>
  896. <th>Value</th>
  897. <th>Description</th>
  898. </tr>
  899. </thead>
  900. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  901. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore.
  902. 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>
  903. </td>
  904. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  905. <td><p>AWSServiceSecretsManager is the AWS SecretsManager.
  906. 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>
  907. </td>
  908. </tr></tbody>
  909. </table>
  910. <h3 id="external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth
  911. </h3>
  912. <p>
  913. (<em>Appears on:</em>
  914. <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>)
  915. </p>
  916. <p>
  917. </p>
  918. <table>
  919. <thead>
  920. <tr>
  921. <th>Field</th>
  922. <th>Description</th>
  923. </tr>
  924. </thead>
  925. <tbody>
  926. <tr>
  927. <td>
  928. <code>secretRef</code></br>
  929. <em>
  930. <a href="#external-secrets.io/v1beta1.AkeylessAuthSecretRef">
  931. AkeylessAuthSecretRef
  932. </a>
  933. </em>
  934. </td>
  935. <td>
  936. <em>(Optional)</em>
  937. <p>Reference to a Secret that contains the details
  938. to authenticate with Akeyless.</p>
  939. </td>
  940. </tr>
  941. <tr>
  942. <td>
  943. <code>kubernetesAuth</code></br>
  944. <em>
  945. <a href="#external-secrets.io/v1beta1.AkeylessKubernetesAuth">
  946. AkeylessKubernetesAuth
  947. </a>
  948. </em>
  949. </td>
  950. <td>
  951. <em>(Optional)</em>
  952. <p>Kubernetes authenticates with Akeyless by passing the ServiceAccount
  953. token stored in the named Secret resource.</p>
  954. </td>
  955. </tr>
  956. </tbody>
  957. </table>
  958. <h3 id="external-secrets.io/v1beta1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
  959. </h3>
  960. <p>
  961. (<em>Appears on:</em>
  962. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  963. </p>
  964. <p>
  965. <p>AkeylessAuthSecretRef
  966. AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
  967. </p>
  968. <table>
  969. <thead>
  970. <tr>
  971. <th>Field</th>
  972. <th>Description</th>
  973. </tr>
  974. </thead>
  975. <tbody>
  976. <tr>
  977. <td>
  978. <code>accessID</code></br>
  979. <em>
  980. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  981. External Secrets meta/v1.SecretKeySelector
  982. </a>
  983. </em>
  984. </td>
  985. <td>
  986. <p>The SecretAccessID is used for authentication</p>
  987. </td>
  988. </tr>
  989. <tr>
  990. <td>
  991. <code>accessType</code></br>
  992. <em>
  993. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  994. External Secrets meta/v1.SecretKeySelector
  995. </a>
  996. </em>
  997. </td>
  998. <td>
  999. </td>
  1000. </tr>
  1001. <tr>
  1002. <td>
  1003. <code>accessTypeParam</code></br>
  1004. <em>
  1005. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1006. External Secrets meta/v1.SecretKeySelector
  1007. </a>
  1008. </em>
  1009. </td>
  1010. <td>
  1011. </td>
  1012. </tr>
  1013. </tbody>
  1014. </table>
  1015. <h3 id="external-secrets.io/v1beta1.AkeylessKubernetesAuth">AkeylessKubernetesAuth
  1016. </h3>
  1017. <p>
  1018. (<em>Appears on:</em>
  1019. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  1020. </p>
  1021. <p>
  1022. <p>Authenticate with Kubernetes ServiceAccount token stored.</p>
  1023. </p>
  1024. <table>
  1025. <thead>
  1026. <tr>
  1027. <th>Field</th>
  1028. <th>Description</th>
  1029. </tr>
  1030. </thead>
  1031. <tbody>
  1032. <tr>
  1033. <td>
  1034. <code>accessID</code></br>
  1035. <em>
  1036. string
  1037. </em>
  1038. </td>
  1039. <td>
  1040. <p>the Akeyless Kubernetes auth-method access-id</p>
  1041. </td>
  1042. </tr>
  1043. <tr>
  1044. <td>
  1045. <code>k8sConfName</code></br>
  1046. <em>
  1047. string
  1048. </em>
  1049. </td>
  1050. <td>
  1051. <p>Kubernetes-auth configuration name in Akeyless-Gateway</p>
  1052. </td>
  1053. </tr>
  1054. <tr>
  1055. <td>
  1056. <code>serviceAccountRef</code></br>
  1057. <em>
  1058. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  1059. External Secrets meta/v1.ServiceAccountSelector
  1060. </a>
  1061. </em>
  1062. </td>
  1063. <td>
  1064. <em>(Optional)</em>
  1065. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  1066. If the service account is specified, the service account secret token JWT will be used
  1067. for authenticating with Akeyless. If the service account selector is not supplied,
  1068. the secretRef will be used instead.</p>
  1069. </td>
  1070. </tr>
  1071. <tr>
  1072. <td>
  1073. <code>secretRef</code></br>
  1074. <em>
  1075. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1076. External Secrets meta/v1.SecretKeySelector
  1077. </a>
  1078. </em>
  1079. </td>
  1080. <td>
  1081. <em>(Optional)</em>
  1082. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  1083. for authenticating with Akeyless. If a name is specified without a key,
  1084. <code>token</code> is the default. If one is not specified, the one bound to
  1085. the controller will be used.</p>
  1086. </td>
  1087. </tr>
  1088. </tbody>
  1089. </table>
  1090. <h3 id="external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider
  1091. </h3>
  1092. <p>
  1093. (<em>Appears on:</em>
  1094. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1095. </p>
  1096. <p>
  1097. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  1098. </p>
  1099. <table>
  1100. <thead>
  1101. <tr>
  1102. <th>Field</th>
  1103. <th>Description</th>
  1104. </tr>
  1105. </thead>
  1106. <tbody>
  1107. <tr>
  1108. <td>
  1109. <code>akeylessGWApiURL</code></br>
  1110. <em>
  1111. string
  1112. </em>
  1113. </td>
  1114. <td>
  1115. <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
  1116. </td>
  1117. </tr>
  1118. <tr>
  1119. <td>
  1120. <code>authSecretRef</code></br>
  1121. <em>
  1122. <a href="#external-secrets.io/v1beta1.AkeylessAuth">
  1123. AkeylessAuth
  1124. </a>
  1125. </em>
  1126. </td>
  1127. <td>
  1128. <p>Auth configures how the operator authenticates with Akeyless.</p>
  1129. </td>
  1130. </tr>
  1131. </tbody>
  1132. </table>
  1133. <h3 id="external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth
  1134. </h3>
  1135. <p>
  1136. (<em>Appears on:</em>
  1137. <a href="#external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider</a>)
  1138. </p>
  1139. <p>
  1140. <p>AlibabaAuth contains a secretRef for credentials.</p>
  1141. </p>
  1142. <table>
  1143. <thead>
  1144. <tr>
  1145. <th>Field</th>
  1146. <th>Description</th>
  1147. </tr>
  1148. </thead>
  1149. <tbody>
  1150. <tr>
  1151. <td>
  1152. <code>secretRef</code></br>
  1153. <em>
  1154. <a href="#external-secrets.io/v1beta1.AlibabaAuthSecretRef">
  1155. AlibabaAuthSecretRef
  1156. </a>
  1157. </em>
  1158. </td>
  1159. <td>
  1160. </td>
  1161. </tr>
  1162. </tbody>
  1163. </table>
  1164. <h3 id="external-secrets.io/v1beta1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
  1165. </h3>
  1166. <p>
  1167. (<em>Appears on:</em>
  1168. <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
  1169. </p>
  1170. <p>
  1171. <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
  1172. </p>
  1173. <table>
  1174. <thead>
  1175. <tr>
  1176. <th>Field</th>
  1177. <th>Description</th>
  1178. </tr>
  1179. </thead>
  1180. <tbody>
  1181. <tr>
  1182. <td>
  1183. <code>accessKeyIDSecretRef</code></br>
  1184. <em>
  1185. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1186. External Secrets meta/v1.SecretKeySelector
  1187. </a>
  1188. </em>
  1189. </td>
  1190. <td>
  1191. <p>The AccessKeyID is used for authentication</p>
  1192. </td>
  1193. </tr>
  1194. <tr>
  1195. <td>
  1196. <code>accessKeySecretSecretRef</code></br>
  1197. <em>
  1198. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1199. External Secrets meta/v1.SecretKeySelector
  1200. </a>
  1201. </em>
  1202. </td>
  1203. <td>
  1204. <p>The AccessKeySecret is used for authentication</p>
  1205. </td>
  1206. </tr>
  1207. </tbody>
  1208. </table>
  1209. <h3 id="external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider
  1210. </h3>
  1211. <p>
  1212. (<em>Appears on:</em>
  1213. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1214. </p>
  1215. <p>
  1216. <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
  1217. </p>
  1218. <table>
  1219. <thead>
  1220. <tr>
  1221. <th>Field</th>
  1222. <th>Description</th>
  1223. </tr>
  1224. </thead>
  1225. <tbody>
  1226. <tr>
  1227. <td>
  1228. <code>auth</code></br>
  1229. <em>
  1230. <a href="#external-secrets.io/v1beta1.AlibabaAuth">
  1231. AlibabaAuth
  1232. </a>
  1233. </em>
  1234. </td>
  1235. <td>
  1236. </td>
  1237. </tr>
  1238. <tr>
  1239. <td>
  1240. <code>endpoint</code></br>
  1241. <em>
  1242. string
  1243. </em>
  1244. </td>
  1245. <td>
  1246. <em>(Optional)</em>
  1247. </td>
  1248. </tr>
  1249. <tr>
  1250. <td>
  1251. <code>regionID</code></br>
  1252. <em>
  1253. string
  1254. </em>
  1255. </td>
  1256. <td>
  1257. <p>Alibaba Region to be used for the provider</p>
  1258. </td>
  1259. </tr>
  1260. </tbody>
  1261. </table>
  1262. <h3 id="external-secrets.io/v1beta1.AzureAuthType">AzureAuthType
  1263. (<code>string</code> alias)</p></h3>
  1264. <p>
  1265. (<em>Appears on:</em>
  1266. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1267. </p>
  1268. <p>
  1269. <p>AuthType describes how to authenticate to the Azure Keyvault
  1270. Only one of the following auth types may be specified.
  1271. If none of the following auth type is specified, the default one
  1272. is ServicePrincipal.</p>
  1273. </p>
  1274. <table>
  1275. <thead>
  1276. <tr>
  1277. <th>Value</th>
  1278. <th>Description</th>
  1279. </tr>
  1280. </thead>
  1281. <tbody><tr><td><p>&#34;ManagedIdentity&#34;</p></td>
  1282. <td><p>Using Managed Identity to authenticate. Used with aad-pod-identity installed in the cluster.</p>
  1283. </td>
  1284. </tr><tr><td><p>&#34;ServicePrincipal&#34;</p></td>
  1285. <td><p>Using service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.</p>
  1286. </td>
  1287. </tr><tr><td><p>&#34;WorkloadIdentity&#34;</p></td>
  1288. <td><p>Using Workload Identity service accounts to authenticate.</p>
  1289. </td>
  1290. </tr></tbody>
  1291. </table>
  1292. <h3 id="external-secrets.io/v1beta1.AzureEnvironmentType">AzureEnvironmentType
  1293. (<code>string</code> alias)</p></h3>
  1294. <p>
  1295. (<em>Appears on:</em>
  1296. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1297. </p>
  1298. <p>
  1299. <p>AzureEnvironmentType specifies the Azure cloud environment endpoints to use for
  1300. connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
  1301. The following endpoints are available, also see here: <a href="https://github.com/Azure/go-autorest/blob/main/autorest/azure/environments.go#L152">https://github.com/Azure/go-autorest/blob/main/autorest/azure/environments.go#L152</a>
  1302. PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</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;ChinaCloud&#34;</p></td>
  1312. <td></td>
  1313. </tr><tr><td><p>&#34;GermanCloud&#34;</p></td>
  1314. <td></td>
  1315. </tr><tr><td><p>&#34;PublicCloud&#34;</p></td>
  1316. <td></td>
  1317. </tr><tr><td><p>&#34;USGovernmentCloud&#34;</p></td>
  1318. <td></td>
  1319. </tr></tbody>
  1320. </table>
  1321. <h3 id="external-secrets.io/v1beta1.AzureKVAuth">AzureKVAuth
  1322. </h3>
  1323. <p>
  1324. (<em>Appears on:</em>
  1325. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1326. </p>
  1327. <p>
  1328. <p>Configuration used to authenticate with Azure.</p>
  1329. </p>
  1330. <table>
  1331. <thead>
  1332. <tr>
  1333. <th>Field</th>
  1334. <th>Description</th>
  1335. </tr>
  1336. </thead>
  1337. <tbody>
  1338. <tr>
  1339. <td>
  1340. <code>clientId</code></br>
  1341. <em>
  1342. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1343. External Secrets meta/v1.SecretKeySelector
  1344. </a>
  1345. </em>
  1346. </td>
  1347. <td>
  1348. <em>(Optional)</em>
  1349. <p>The Azure clientId of the service principle used for authentication.</p>
  1350. </td>
  1351. </tr>
  1352. <tr>
  1353. <td>
  1354. <code>clientSecret</code></br>
  1355. <em>
  1356. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1357. External Secrets meta/v1.SecretKeySelector
  1358. </a>
  1359. </em>
  1360. </td>
  1361. <td>
  1362. <em>(Optional)</em>
  1363. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  1364. </td>
  1365. </tr>
  1366. </tbody>
  1367. </table>
  1368. <h3 id="external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider
  1369. </h3>
  1370. <p>
  1371. (<em>Appears on:</em>
  1372. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1373. </p>
  1374. <p>
  1375. <p>Configures an store to sync secrets using Azure KV.</p>
  1376. </p>
  1377. <table>
  1378. <thead>
  1379. <tr>
  1380. <th>Field</th>
  1381. <th>Description</th>
  1382. </tr>
  1383. </thead>
  1384. <tbody>
  1385. <tr>
  1386. <td>
  1387. <code>authType</code></br>
  1388. <em>
  1389. <a href="#external-secrets.io/v1beta1.AzureAuthType">
  1390. AzureAuthType
  1391. </a>
  1392. </em>
  1393. </td>
  1394. <td>
  1395. <em>(Optional)</em>
  1396. <p>Auth type defines how to authenticate to the keyvault service.
  1397. Valid values are:
  1398. - &ldquo;ServicePrincipal&rdquo; (default): Using a service principal (tenantId, clientId, clientSecret)
  1399. - &ldquo;ManagedIdentity&rdquo;: Using Managed Identity assigned to the pod (see aad-pod-identity)</p>
  1400. </td>
  1401. </tr>
  1402. <tr>
  1403. <td>
  1404. <code>vaultUrl</code></br>
  1405. <em>
  1406. string
  1407. </em>
  1408. </td>
  1409. <td>
  1410. <p>Vault Url from which the secrets to be fetched from.</p>
  1411. </td>
  1412. </tr>
  1413. <tr>
  1414. <td>
  1415. <code>tenantId</code></br>
  1416. <em>
  1417. string
  1418. </em>
  1419. </td>
  1420. <td>
  1421. <em>(Optional)</em>
  1422. <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type.</p>
  1423. </td>
  1424. </tr>
  1425. <tr>
  1426. <td>
  1427. <code>environmentType</code></br>
  1428. <em>
  1429. <a href="#external-secrets.io/v1beta1.AzureEnvironmentType">
  1430. AzureEnvironmentType
  1431. </a>
  1432. </em>
  1433. </td>
  1434. <td>
  1435. <p>EnvironmentType specifies the Azure cloud environment endpoints to use for
  1436. connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
  1437. The following endpoints are available, also see here: <a href="https://github.com/Azure/go-autorest/blob/main/autorest/azure/environments.go#L152">https://github.com/Azure/go-autorest/blob/main/autorest/azure/environments.go#L152</a>
  1438. PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
  1439. </td>
  1440. </tr>
  1441. <tr>
  1442. <td>
  1443. <code>authSecretRef</code></br>
  1444. <em>
  1445. <a href="#external-secrets.io/v1beta1.AzureKVAuth">
  1446. AzureKVAuth
  1447. </a>
  1448. </em>
  1449. </td>
  1450. <td>
  1451. <em>(Optional)</em>
  1452. <p>Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type.</p>
  1453. </td>
  1454. </tr>
  1455. <tr>
  1456. <td>
  1457. <code>serviceAccountRef</code></br>
  1458. <em>
  1459. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  1460. External Secrets meta/v1.ServiceAccountSelector
  1461. </a>
  1462. </em>
  1463. </td>
  1464. <td>
  1465. <em>(Optional)</em>
  1466. <p>ServiceAccountRef specified the service account
  1467. that should be used when authenticating with WorkloadIdentity.</p>
  1468. </td>
  1469. </tr>
  1470. <tr>
  1471. <td>
  1472. <code>identityId</code></br>
  1473. <em>
  1474. string
  1475. </em>
  1476. </td>
  1477. <td>
  1478. <em>(Optional)</em>
  1479. <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
  1480. </td>
  1481. </tr>
  1482. </tbody>
  1483. </table>
  1484. <h3 id="external-secrets.io/v1beta1.CAProvider">CAProvider
  1485. </h3>
  1486. <p>
  1487. (<em>Appears on:</em>
  1488. <a href="#external-secrets.io/v1beta1.KubernetesServer">KubernetesServer</a>,
  1489. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  1490. </p>
  1491. <p>
  1492. <p>Used to provide custom certificate authority (CA) certificates
  1493. for a secret store. The CAProvider points to a Secret or ConfigMap resource
  1494. that contains a PEM-encoded certificate.</p>
  1495. </p>
  1496. <table>
  1497. <thead>
  1498. <tr>
  1499. <th>Field</th>
  1500. <th>Description</th>
  1501. </tr>
  1502. </thead>
  1503. <tbody>
  1504. <tr>
  1505. <td>
  1506. <code>type</code></br>
  1507. <em>
  1508. <a href="#external-secrets.io/v1beta1.CAProviderType">
  1509. CAProviderType
  1510. </a>
  1511. </em>
  1512. </td>
  1513. <td>
  1514. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  1515. </td>
  1516. </tr>
  1517. <tr>
  1518. <td>
  1519. <code>name</code></br>
  1520. <em>
  1521. string
  1522. </em>
  1523. </td>
  1524. <td>
  1525. <p>The name of the object located at the provider type.</p>
  1526. </td>
  1527. </tr>
  1528. <tr>
  1529. <td>
  1530. <code>key</code></br>
  1531. <em>
  1532. string
  1533. </em>
  1534. </td>
  1535. <td>
  1536. <p>The key where the CA certificate can be found in the Secret or ConfigMap.</p>
  1537. </td>
  1538. </tr>
  1539. <tr>
  1540. <td>
  1541. <code>namespace</code></br>
  1542. <em>
  1543. string
  1544. </em>
  1545. </td>
  1546. <td>
  1547. <em>(Optional)</em>
  1548. <p>The namespace the Provider type is in.
  1549. Can only be defined when used in a ClusterSecretStore.</p>
  1550. </td>
  1551. </tr>
  1552. </tbody>
  1553. </table>
  1554. <h3 id="external-secrets.io/v1beta1.CAProviderType">CAProviderType
  1555. (<code>string</code> alias)</p></h3>
  1556. <p>
  1557. (<em>Appears on:</em>
  1558. <a href="#external-secrets.io/v1beta1.CAProvider">CAProvider</a>)
  1559. </p>
  1560. <p>
  1561. </p>
  1562. <table>
  1563. <thead>
  1564. <tr>
  1565. <th>Value</th>
  1566. <th>Description</th>
  1567. </tr>
  1568. </thead>
  1569. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  1570. <td></td>
  1571. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  1572. <td></td>
  1573. </tr></tbody>
  1574. </table>
  1575. <h3 id="external-secrets.io/v1beta1.CertAuth">CertAuth
  1576. </h3>
  1577. <p>
  1578. (<em>Appears on:</em>
  1579. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  1580. </p>
  1581. <p>
  1582. </p>
  1583. <table>
  1584. <thead>
  1585. <tr>
  1586. <th>Field</th>
  1587. <th>Description</th>
  1588. </tr>
  1589. </thead>
  1590. <tbody>
  1591. <tr>
  1592. <td>
  1593. <code>clientCert</code></br>
  1594. <em>
  1595. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1596. External Secrets meta/v1.SecretKeySelector
  1597. </a>
  1598. </em>
  1599. </td>
  1600. <td>
  1601. </td>
  1602. </tr>
  1603. <tr>
  1604. <td>
  1605. <code>clientKey</code></br>
  1606. <em>
  1607. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1608. External Secrets meta/v1.SecretKeySelector
  1609. </a>
  1610. </em>
  1611. </td>
  1612. <td>
  1613. </td>
  1614. </tr>
  1615. </tbody>
  1616. </table>
  1617. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret
  1618. </h3>
  1619. <p>
  1620. <p>ClusterExternalSecret is the Schema for the clusterexternalsecrets API.</p>
  1621. </p>
  1622. <table>
  1623. <thead>
  1624. <tr>
  1625. <th>Field</th>
  1626. <th>Description</th>
  1627. </tr>
  1628. </thead>
  1629. <tbody>
  1630. <tr>
  1631. <td>
  1632. <code>metadata</code></br>
  1633. <em>
  1634. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  1635. Kubernetes meta/v1.ObjectMeta
  1636. </a>
  1637. </em>
  1638. </td>
  1639. <td>
  1640. Refer to the Kubernetes API documentation for the fields of the
  1641. <code>metadata</code> field.
  1642. </td>
  1643. </tr>
  1644. <tr>
  1645. <td>
  1646. <code>spec</code></br>
  1647. <em>
  1648. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">
  1649. ClusterExternalSecretSpec
  1650. </a>
  1651. </em>
  1652. </td>
  1653. <td>
  1654. <br/>
  1655. <br/>
  1656. <table>
  1657. <tr>
  1658. <td>
  1659. <code>externalSecretSpec</code></br>
  1660. <em>
  1661. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  1662. ExternalSecretSpec
  1663. </a>
  1664. </em>
  1665. </td>
  1666. <td>
  1667. <p>The spec for the ExternalSecrets to be created</p>
  1668. </td>
  1669. </tr>
  1670. <tr>
  1671. <td>
  1672. <code>externalSecretName</code></br>
  1673. <em>
  1674. string
  1675. </em>
  1676. </td>
  1677. <td>
  1678. <em>(Optional)</em>
  1679. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  1680. </td>
  1681. </tr>
  1682. <tr>
  1683. <td>
  1684. <code>namespaceSelector</code></br>
  1685. <em>
  1686. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  1687. Kubernetes meta/v1.LabelSelector
  1688. </a>
  1689. </em>
  1690. </td>
  1691. <td>
  1692. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
  1693. </td>
  1694. </tr>
  1695. <tr>
  1696. <td>
  1697. <code>refreshTime</code></br>
  1698. <em>
  1699. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  1700. Kubernetes meta/v1.Duration
  1701. </a>
  1702. </em>
  1703. </td>
  1704. <td>
  1705. <p>The time in which the controller should reconcile it&rsquo;s objects and recheck namespaces for labels.</p>
  1706. </td>
  1707. </tr>
  1708. </table>
  1709. </td>
  1710. </tr>
  1711. <tr>
  1712. <td>
  1713. <code>status</code></br>
  1714. <em>
  1715. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">
  1716. ClusterExternalSecretStatus
  1717. </a>
  1718. </em>
  1719. </td>
  1720. <td>
  1721. </td>
  1722. </tr>
  1723. </tbody>
  1724. </table>
  1725. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretConditionType">ClusterExternalSecretConditionType
  1726. (<code>string</code> alias)</p></h3>
  1727. <p>
  1728. (<em>Appears on:</em>
  1729. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition</a>)
  1730. </p>
  1731. <p>
  1732. </p>
  1733. <table>
  1734. <thead>
  1735. <tr>
  1736. <th>Value</th>
  1737. <th>Description</th>
  1738. </tr>
  1739. </thead>
  1740. <tbody><tr><td><p>&#34;NotReady&#34;</p></td>
  1741. <td></td>
  1742. </tr><tr><td><p>&#34;PartiallyReady&#34;</p></td>
  1743. <td></td>
  1744. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  1745. <td></td>
  1746. </tr></tbody>
  1747. </table>
  1748. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">ClusterExternalSecretNamespaceFailure
  1749. </h3>
  1750. <p>
  1751. (<em>Appears on:</em>
  1752. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  1753. </p>
  1754. <p>
  1755. <p>ClusterExternalSecretNamespaceFailure represents a failed namespace deployment and it&rsquo;s reason.</p>
  1756. </p>
  1757. <table>
  1758. <thead>
  1759. <tr>
  1760. <th>Field</th>
  1761. <th>Description</th>
  1762. </tr>
  1763. </thead>
  1764. <tbody>
  1765. <tr>
  1766. <td>
  1767. <code>namespace</code></br>
  1768. <em>
  1769. string
  1770. </em>
  1771. </td>
  1772. <td>
  1773. <p>Namespace is the namespace that failed when trying to apply an ExternalSecret</p>
  1774. </td>
  1775. </tr>
  1776. <tr>
  1777. <td>
  1778. <code>reason</code></br>
  1779. <em>
  1780. string
  1781. </em>
  1782. </td>
  1783. <td>
  1784. <em>(Optional)</em>
  1785. <p>Reason is why the ExternalSecret failed to apply to the namespace</p>
  1786. </td>
  1787. </tr>
  1788. </tbody>
  1789. </table>
  1790. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec
  1791. </h3>
  1792. <p>
  1793. (<em>Appears on:</em>
  1794. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  1795. </p>
  1796. <p>
  1797. <p>ClusterExternalSecretSpec defines the desired state of ClusterExternalSecret.</p>
  1798. </p>
  1799. <table>
  1800. <thead>
  1801. <tr>
  1802. <th>Field</th>
  1803. <th>Description</th>
  1804. </tr>
  1805. </thead>
  1806. <tbody>
  1807. <tr>
  1808. <td>
  1809. <code>externalSecretSpec</code></br>
  1810. <em>
  1811. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  1812. ExternalSecretSpec
  1813. </a>
  1814. </em>
  1815. </td>
  1816. <td>
  1817. <p>The spec for the ExternalSecrets to be created</p>
  1818. </td>
  1819. </tr>
  1820. <tr>
  1821. <td>
  1822. <code>externalSecretName</code></br>
  1823. <em>
  1824. string
  1825. </em>
  1826. </td>
  1827. <td>
  1828. <em>(Optional)</em>
  1829. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  1830. </td>
  1831. </tr>
  1832. <tr>
  1833. <td>
  1834. <code>namespaceSelector</code></br>
  1835. <em>
  1836. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  1837. Kubernetes meta/v1.LabelSelector
  1838. </a>
  1839. </em>
  1840. </td>
  1841. <td>
  1842. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
  1843. </td>
  1844. </tr>
  1845. <tr>
  1846. <td>
  1847. <code>refreshTime</code></br>
  1848. <em>
  1849. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  1850. Kubernetes meta/v1.Duration
  1851. </a>
  1852. </em>
  1853. </td>
  1854. <td>
  1855. <p>The time in which the controller should reconcile it&rsquo;s objects and recheck namespaces for labels.</p>
  1856. </td>
  1857. </tr>
  1858. </tbody>
  1859. </table>
  1860. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus
  1861. </h3>
  1862. <p>
  1863. (<em>Appears on:</em>
  1864. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  1865. </p>
  1866. <p>
  1867. <p>ClusterExternalSecretStatus defines the observed state of ClusterExternalSecret.</p>
  1868. </p>
  1869. <table>
  1870. <thead>
  1871. <tr>
  1872. <th>Field</th>
  1873. <th>Description</th>
  1874. </tr>
  1875. </thead>
  1876. <tbody>
  1877. <tr>
  1878. <td>
  1879. <code>failedNamespaces</code></br>
  1880. <em>
  1881. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">
  1882. []ClusterExternalSecretNamespaceFailure
  1883. </a>
  1884. </em>
  1885. </td>
  1886. <td>
  1887. <em>(Optional)</em>
  1888. <p>Failed namespaces are the namespaces that failed to apply an ExternalSecret</p>
  1889. </td>
  1890. </tr>
  1891. <tr>
  1892. <td>
  1893. <code>provisionedNamespaces</code></br>
  1894. <em>
  1895. []string
  1896. </em>
  1897. </td>
  1898. <td>
  1899. <em>(Optional)</em>
  1900. <p>ProvisionedNamespaces are the namespaces where the ClusterExternalSecret has secrets</p>
  1901. </td>
  1902. </tr>
  1903. <tr>
  1904. <td>
  1905. <code>conditions</code></br>
  1906. <em>
  1907. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">
  1908. []ClusterExternalSecretStatusCondition
  1909. </a>
  1910. </em>
  1911. </td>
  1912. <td>
  1913. <em>(Optional)</em>
  1914. </td>
  1915. </tr>
  1916. </tbody>
  1917. </table>
  1918. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition
  1919. </h3>
  1920. <p>
  1921. (<em>Appears on:</em>
  1922. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  1923. </p>
  1924. <p>
  1925. </p>
  1926. <table>
  1927. <thead>
  1928. <tr>
  1929. <th>Field</th>
  1930. <th>Description</th>
  1931. </tr>
  1932. </thead>
  1933. <tbody>
  1934. <tr>
  1935. <td>
  1936. <code>type</code></br>
  1937. <em>
  1938. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretConditionType">
  1939. ClusterExternalSecretConditionType
  1940. </a>
  1941. </em>
  1942. </td>
  1943. <td>
  1944. </td>
  1945. </tr>
  1946. <tr>
  1947. <td>
  1948. <code>status</code></br>
  1949. <em>
  1950. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  1951. Kubernetes core/v1.ConditionStatus
  1952. </a>
  1953. </em>
  1954. </td>
  1955. <td>
  1956. </td>
  1957. </tr>
  1958. <tr>
  1959. <td>
  1960. <code>message</code></br>
  1961. <em>
  1962. string
  1963. </em>
  1964. </td>
  1965. <td>
  1966. <em>(Optional)</em>
  1967. </td>
  1968. </tr>
  1969. </tbody>
  1970. </table>
  1971. <h3 id="external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore
  1972. </h3>
  1973. <p>
  1974. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  1975. </p>
  1976. <table>
  1977. <thead>
  1978. <tr>
  1979. <th>Field</th>
  1980. <th>Description</th>
  1981. </tr>
  1982. </thead>
  1983. <tbody>
  1984. <tr>
  1985. <td>
  1986. <code>metadata</code></br>
  1987. <em>
  1988. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  1989. Kubernetes meta/v1.ObjectMeta
  1990. </a>
  1991. </em>
  1992. </td>
  1993. <td>
  1994. Refer to the Kubernetes API documentation for the fields of the
  1995. <code>metadata</code> field.
  1996. </td>
  1997. </tr>
  1998. <tr>
  1999. <td>
  2000. <code>spec</code></br>
  2001. <em>
  2002. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  2003. SecretStoreSpec
  2004. </a>
  2005. </em>
  2006. </td>
  2007. <td>
  2008. <br/>
  2009. <br/>
  2010. <table>
  2011. <tr>
  2012. <td>
  2013. <code>controller</code></br>
  2014. <em>
  2015. string
  2016. </em>
  2017. </td>
  2018. <td>
  2019. <em>(Optional)</em>
  2020. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  2021. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  2022. </td>
  2023. </tr>
  2024. <tr>
  2025. <td>
  2026. <code>provider</code></br>
  2027. <em>
  2028. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  2029. SecretStoreProvider
  2030. </a>
  2031. </em>
  2032. </td>
  2033. <td>
  2034. <p>Used to configure the provider. Only one provider may be set</p>
  2035. </td>
  2036. </tr>
  2037. <tr>
  2038. <td>
  2039. <code>retrySettings</code></br>
  2040. <em>
  2041. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  2042. SecretStoreRetrySettings
  2043. </a>
  2044. </em>
  2045. </td>
  2046. <td>
  2047. <em>(Optional)</em>
  2048. <p>Used to configure http retries if failed</p>
  2049. </td>
  2050. </tr>
  2051. <tr>
  2052. <td>
  2053. <code>refreshInterval</code></br>
  2054. <em>
  2055. int
  2056. </em>
  2057. </td>
  2058. <td>
  2059. <em>(Optional)</em>
  2060. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  2061. </td>
  2062. </tr>
  2063. <tr>
  2064. <td>
  2065. <code>conditions</code></br>
  2066. <em>
  2067. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  2068. []ClusterSecretStoreCondition
  2069. </a>
  2070. </em>
  2071. </td>
  2072. <td>
  2073. <em>(Optional)</em>
  2074. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  2075. </td>
  2076. </tr>
  2077. </table>
  2078. </td>
  2079. </tr>
  2080. <tr>
  2081. <td>
  2082. <code>status</code></br>
  2083. <em>
  2084. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  2085. SecretStoreStatus
  2086. </a>
  2087. </em>
  2088. </td>
  2089. <td>
  2090. </td>
  2091. </tr>
  2092. </tbody>
  2093. </table>
  2094. <h3 id="external-secrets.io/v1beta1.ClusterSecretStoreCondition">ClusterSecretStoreCondition
  2095. </h3>
  2096. <p>
  2097. (<em>Appears on:</em>
  2098. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  2099. </p>
  2100. <p>
  2101. <p>ClusterSecretStoreCondition describes a condition by which to choose namespaces to process ExternalSecrets in
  2102. for a ClusterSecretStore instance.</p>
  2103. </p>
  2104. <table>
  2105. <thead>
  2106. <tr>
  2107. <th>Field</th>
  2108. <th>Description</th>
  2109. </tr>
  2110. </thead>
  2111. <tbody>
  2112. <tr>
  2113. <td>
  2114. <code>namespaceSelector</code></br>
  2115. <em>
  2116. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  2117. Kubernetes meta/v1.LabelSelector
  2118. </a>
  2119. </em>
  2120. </td>
  2121. <td>
  2122. <em>(Optional)</em>
  2123. <p>Choose namespace using a labelSelector</p>
  2124. </td>
  2125. </tr>
  2126. <tr>
  2127. <td>
  2128. <code>namespaces</code></br>
  2129. <em>
  2130. []string
  2131. </em>
  2132. </td>
  2133. <td>
  2134. <p>Choose namespaces by name</p>
  2135. </td>
  2136. </tr>
  2137. </tbody>
  2138. </table>
  2139. <h3 id="external-secrets.io/v1beta1.DopplerAuth">DopplerAuth
  2140. </h3>
  2141. <p>
  2142. (<em>Appears on:</em>
  2143. <a href="#external-secrets.io/v1beta1.DopplerProvider">DopplerProvider</a>)
  2144. </p>
  2145. <p>
  2146. </p>
  2147. <table>
  2148. <thead>
  2149. <tr>
  2150. <th>Field</th>
  2151. <th>Description</th>
  2152. </tr>
  2153. </thead>
  2154. <tbody>
  2155. <tr>
  2156. <td>
  2157. <code>secretRef</code></br>
  2158. <em>
  2159. <a href="#external-secrets.io/v1beta1.DopplerAuthSecretRef">
  2160. DopplerAuthSecretRef
  2161. </a>
  2162. </em>
  2163. </td>
  2164. <td>
  2165. </td>
  2166. </tr>
  2167. </tbody>
  2168. </table>
  2169. <h3 id="external-secrets.io/v1beta1.DopplerAuthSecretRef">DopplerAuthSecretRef
  2170. </h3>
  2171. <p>
  2172. (<em>Appears on:</em>
  2173. <a href="#external-secrets.io/v1beta1.DopplerAuth">DopplerAuth</a>)
  2174. </p>
  2175. <p>
  2176. </p>
  2177. <table>
  2178. <thead>
  2179. <tr>
  2180. <th>Field</th>
  2181. <th>Description</th>
  2182. </tr>
  2183. </thead>
  2184. <tbody>
  2185. <tr>
  2186. <td>
  2187. <code>dopplerToken</code></br>
  2188. <em>
  2189. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2190. External Secrets meta/v1.SecretKeySelector
  2191. </a>
  2192. </em>
  2193. </td>
  2194. <td>
  2195. <p>The DopplerToken is used for authentication.
  2196. See <a href="https://docs.doppler.com/reference/api#authentication">https://docs.doppler.com/reference/api#authentication</a> for auth token types.
  2197. The Key attribute defaults to dopplerToken if not specified.</p>
  2198. </td>
  2199. </tr>
  2200. </tbody>
  2201. </table>
  2202. <h3 id="external-secrets.io/v1beta1.DopplerProvider">DopplerProvider
  2203. </h3>
  2204. <p>
  2205. (<em>Appears on:</em>
  2206. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2207. </p>
  2208. <p>
  2209. <p>DopplerProvider configures a store to sync secrets using the Doppler provider.
  2210. Project and Config are required if not using a Service Token.</p>
  2211. </p>
  2212. <table>
  2213. <thead>
  2214. <tr>
  2215. <th>Field</th>
  2216. <th>Description</th>
  2217. </tr>
  2218. </thead>
  2219. <tbody>
  2220. <tr>
  2221. <td>
  2222. <code>auth</code></br>
  2223. <em>
  2224. <a href="#external-secrets.io/v1beta1.DopplerAuth">
  2225. DopplerAuth
  2226. </a>
  2227. </em>
  2228. </td>
  2229. <td>
  2230. <p>Auth configures how the Operator authenticates with the Doppler API</p>
  2231. </td>
  2232. </tr>
  2233. <tr>
  2234. <td>
  2235. <code>project</code></br>
  2236. <em>
  2237. string
  2238. </em>
  2239. </td>
  2240. <td>
  2241. <em>(Optional)</em>
  2242. <p>Doppler project (required if not using a Service Token)</p>
  2243. </td>
  2244. </tr>
  2245. <tr>
  2246. <td>
  2247. <code>config</code></br>
  2248. <em>
  2249. string
  2250. </em>
  2251. </td>
  2252. <td>
  2253. <em>(Optional)</em>
  2254. <p>Doppler config (required if not using a Service Token)</p>
  2255. </td>
  2256. </tr>
  2257. <tr>
  2258. <td>
  2259. <code>nameTransformer</code></br>
  2260. <em>
  2261. string
  2262. </em>
  2263. </td>
  2264. <td>
  2265. <em>(Optional)</em>
  2266. <p>Environment variable compatible name transforms that change secret names to a different format</p>
  2267. </td>
  2268. </tr>
  2269. <tr>
  2270. <td>
  2271. <code>format</code></br>
  2272. <em>
  2273. string
  2274. </em>
  2275. </td>
  2276. <td>
  2277. <em>(Optional)</em>
  2278. <p>Format enables the downloading of secrets as a file (string)</p>
  2279. </td>
  2280. </tr>
  2281. </tbody>
  2282. </table>
  2283. <h3 id="external-secrets.io/v1beta1.ExternalSecret">ExternalSecret
  2284. </h3>
  2285. <p>
  2286. <p>ExternalSecret is the Schema for the external-secrets API.</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>metadata</code></br>
  2299. <em>
  2300. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  2301. Kubernetes meta/v1.ObjectMeta
  2302. </a>
  2303. </em>
  2304. </td>
  2305. <td>
  2306. Refer to the Kubernetes API documentation for the fields of the
  2307. <code>metadata</code> field.
  2308. </td>
  2309. </tr>
  2310. <tr>
  2311. <td>
  2312. <code>spec</code></br>
  2313. <em>
  2314. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  2315. ExternalSecretSpec
  2316. </a>
  2317. </em>
  2318. </td>
  2319. <td>
  2320. <br/>
  2321. <br/>
  2322. <table>
  2323. <tr>
  2324. <td>
  2325. <code>secretStoreRef</code></br>
  2326. <em>
  2327. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  2328. SecretStoreRef
  2329. </a>
  2330. </em>
  2331. </td>
  2332. <td>
  2333. <em>(Optional)</em>
  2334. </td>
  2335. </tr>
  2336. <tr>
  2337. <td>
  2338. <code>target</code></br>
  2339. <em>
  2340. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  2341. ExternalSecretTarget
  2342. </a>
  2343. </em>
  2344. </td>
  2345. <td>
  2346. <em>(Optional)</em>
  2347. </td>
  2348. </tr>
  2349. <tr>
  2350. <td>
  2351. <code>refreshInterval</code></br>
  2352. <em>
  2353. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  2354. Kubernetes meta/v1.Duration
  2355. </a>
  2356. </em>
  2357. </td>
  2358. <td>
  2359. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  2360. 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;
  2361. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  2362. </td>
  2363. </tr>
  2364. <tr>
  2365. <td>
  2366. <code>data</code></br>
  2367. <em>
  2368. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  2369. []ExternalSecretData
  2370. </a>
  2371. </em>
  2372. </td>
  2373. <td>
  2374. <em>(Optional)</em>
  2375. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  2376. </td>
  2377. </tr>
  2378. <tr>
  2379. <td>
  2380. <code>dataFrom</code></br>
  2381. <em>
  2382. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  2383. []ExternalSecretDataFromRemoteRef
  2384. </a>
  2385. </em>
  2386. </td>
  2387. <td>
  2388. <em>(Optional)</em>
  2389. <p>DataFrom is used to fetch all properties from a specific Provider data
  2390. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  2391. </td>
  2392. </tr>
  2393. </table>
  2394. </td>
  2395. </tr>
  2396. <tr>
  2397. <td>
  2398. <code>status</code></br>
  2399. <em>
  2400. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">
  2401. ExternalSecretStatus
  2402. </a>
  2403. </em>
  2404. </td>
  2405. <td>
  2406. </td>
  2407. </tr>
  2408. </tbody>
  2409. </table>
  2410. <h3 id="external-secrets.io/v1beta1.ExternalSecretConditionType">ExternalSecretConditionType
  2411. (<code>string</code> alias)</p></h3>
  2412. <p>
  2413. (<em>Appears on:</em>
  2414. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  2415. </p>
  2416. <p>
  2417. </p>
  2418. <table>
  2419. <thead>
  2420. <tr>
  2421. <th>Value</th>
  2422. <th>Description</th>
  2423. </tr>
  2424. </thead>
  2425. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
  2426. <td></td>
  2427. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  2428. <td></td>
  2429. </tr></tbody>
  2430. </table>
  2431. <h3 id="external-secrets.io/v1beta1.ExternalSecretConversionStrategy">ExternalSecretConversionStrategy
  2432. (<code>string</code> alias)</p></h3>
  2433. <p>
  2434. (<em>Appears on:</em>
  2435. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  2436. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  2437. </p>
  2438. <p>
  2439. </p>
  2440. <table>
  2441. <thead>
  2442. <tr>
  2443. <th>Value</th>
  2444. <th>Description</th>
  2445. </tr>
  2446. </thead>
  2447. <tbody><tr><td><p>&#34;Default&#34;</p></td>
  2448. <td></td>
  2449. </tr><tr><td><p>&#34;Unicode&#34;</p></td>
  2450. <td></td>
  2451. </tr></tbody>
  2452. </table>
  2453. <h3 id="external-secrets.io/v1beta1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  2454. (<code>string</code> alias)</p></h3>
  2455. <p>
  2456. (<em>Appears on:</em>
  2457. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  2458. </p>
  2459. <p>
  2460. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  2461. </p>
  2462. <table>
  2463. <thead>
  2464. <tr>
  2465. <th>Value</th>
  2466. <th>Description</th>
  2467. </tr>
  2468. </thead>
  2469. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  2470. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  2471. </td>
  2472. </tr><tr><td><p>&#34;None&#34;</p></td>
  2473. <td><p>None does not create a Secret (future use with injector).</p>
  2474. </td>
  2475. </tr><tr><td><p>&#34;Orphan&#34;</p></td>
  2476. <td><p>Orphan creates the Secret and does not set the ownerReference.
  2477. I.e. it will be orphaned after the deletion of the ExternalSecret.</p>
  2478. </td>
  2479. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  2480. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  2481. </td>
  2482. </tr></tbody>
  2483. </table>
  2484. <h3 id="external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData
  2485. </h3>
  2486. <p>
  2487. (<em>Appears on:</em>
  2488. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2489. </p>
  2490. <p>
  2491. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  2492. </p>
  2493. <table>
  2494. <thead>
  2495. <tr>
  2496. <th>Field</th>
  2497. <th>Description</th>
  2498. </tr>
  2499. </thead>
  2500. <tbody>
  2501. <tr>
  2502. <td>
  2503. <code>secretKey</code></br>
  2504. <em>
  2505. string
  2506. </em>
  2507. </td>
  2508. <td>
  2509. <p>SecretKey defines the key in which the controller stores
  2510. the value. This is the key in the Kind=Secret</p>
  2511. </td>
  2512. </tr>
  2513. <tr>
  2514. <td>
  2515. <code>remoteRef</code></br>
  2516. <em>
  2517. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  2518. ExternalSecretDataRemoteRef
  2519. </a>
  2520. </em>
  2521. </td>
  2522. <td>
  2523. <p>RemoteRef points to the remote secret and defines
  2524. which secret (version/property/..) to fetch.</p>
  2525. </td>
  2526. </tr>
  2527. <tr>
  2528. <td>
  2529. <code>sourceRef</code></br>
  2530. <em>
  2531. <a href="#external-secrets.io/v1beta1.SourceRef">
  2532. SourceRef
  2533. </a>
  2534. </em>
  2535. </td>
  2536. <td>
  2537. <p>SourceRef allows you to override the source
  2538. from which the value will pulled from.</p>
  2539. </td>
  2540. </tr>
  2541. </tbody>
  2542. </table>
  2543. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef
  2544. </h3>
  2545. <p>
  2546. (<em>Appears on:</em>
  2547. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2548. </p>
  2549. <p>
  2550. </p>
  2551. <table>
  2552. <thead>
  2553. <tr>
  2554. <th>Field</th>
  2555. <th>Description</th>
  2556. </tr>
  2557. </thead>
  2558. <tbody>
  2559. <tr>
  2560. <td>
  2561. <code>extract</code></br>
  2562. <em>
  2563. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  2564. ExternalSecretDataRemoteRef
  2565. </a>
  2566. </em>
  2567. </td>
  2568. <td>
  2569. <em>(Optional)</em>
  2570. <p>Used to extract multiple key/value pairs from one secret
  2571. Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
  2572. </td>
  2573. </tr>
  2574. <tr>
  2575. <td>
  2576. <code>find</code></br>
  2577. <em>
  2578. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">
  2579. ExternalSecretFind
  2580. </a>
  2581. </em>
  2582. </td>
  2583. <td>
  2584. <em>(Optional)</em>
  2585. <p>Used to find secrets based on tags or regular expressions
  2586. Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
  2587. </td>
  2588. </tr>
  2589. <tr>
  2590. <td>
  2591. <code>rewrite</code></br>
  2592. <em>
  2593. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">
  2594. []ExternalSecretRewrite
  2595. </a>
  2596. </em>
  2597. </td>
  2598. <td>
  2599. <em>(Optional)</em>
  2600. <p>Used to rewrite secret Keys after getting them from the secret Provider
  2601. Multiple Rewrite operations can be provided. They are applied in a layered order (first to last)</p>
  2602. </td>
  2603. </tr>
  2604. <tr>
  2605. <td>
  2606. <code>sourceRef</code></br>
  2607. <em>
  2608. <a href="#external-secrets.io/v1beta1.SourceRef">
  2609. SourceRef
  2610. </a>
  2611. </em>
  2612. </td>
  2613. <td>
  2614. <p>SourceRef points to a store or generator
  2615. which contains secret values ready to use.
  2616. Use this in combination with Extract or Find pull values out of
  2617. a specific SecretStore.
  2618. When sourceRef points to a generator Extract or Find is not supported.
  2619. The generator returns a static map of values</p>
  2620. </td>
  2621. </tr>
  2622. </tbody>
  2623. </table>
  2624. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  2625. </h3>
  2626. <p>
  2627. (<em>Appears on:</em>
  2628. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>,
  2629. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  2630. </p>
  2631. <p>
  2632. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  2633. </p>
  2634. <table>
  2635. <thead>
  2636. <tr>
  2637. <th>Field</th>
  2638. <th>Description</th>
  2639. </tr>
  2640. </thead>
  2641. <tbody>
  2642. <tr>
  2643. <td>
  2644. <code>key</code></br>
  2645. <em>
  2646. string
  2647. </em>
  2648. </td>
  2649. <td>
  2650. <p>Key is the key used in the Provider, mandatory</p>
  2651. </td>
  2652. </tr>
  2653. <tr>
  2654. <td>
  2655. <code>metadataPolicy</code></br>
  2656. <em>
  2657. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">
  2658. ExternalSecretMetadataPolicy
  2659. </a>
  2660. </em>
  2661. </td>
  2662. <td>
  2663. <em>(Optional)</em>
  2664. <p>Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None</p>
  2665. </td>
  2666. </tr>
  2667. <tr>
  2668. <td>
  2669. <code>property</code></br>
  2670. <em>
  2671. string
  2672. </em>
  2673. </td>
  2674. <td>
  2675. <em>(Optional)</em>
  2676. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  2677. </td>
  2678. </tr>
  2679. <tr>
  2680. <td>
  2681. <code>version</code></br>
  2682. <em>
  2683. string
  2684. </em>
  2685. </td>
  2686. <td>
  2687. <em>(Optional)</em>
  2688. <p>Used to select a specific version of the Provider value, if supported</p>
  2689. </td>
  2690. </tr>
  2691. <tr>
  2692. <td>
  2693. <code>conversionStrategy</code></br>
  2694. <em>
  2695. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  2696. ExternalSecretConversionStrategy
  2697. </a>
  2698. </em>
  2699. </td>
  2700. <td>
  2701. <em>(Optional)</em>
  2702. <p>Used to define a conversion Strategy</p>
  2703. </td>
  2704. </tr>
  2705. <tr>
  2706. <td>
  2707. <code>decodingStrategy</code></br>
  2708. <em>
  2709. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  2710. ExternalSecretDecodingStrategy
  2711. </a>
  2712. </em>
  2713. </td>
  2714. <td>
  2715. <em>(Optional)</em>
  2716. <p>Used to define a decoding Strategy</p>
  2717. </td>
  2718. </tr>
  2719. </tbody>
  2720. </table>
  2721. <h3 id="external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">ExternalSecretDecodingStrategy
  2722. (<code>string</code> alias)</p></h3>
  2723. <p>
  2724. (<em>Appears on:</em>
  2725. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  2726. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  2727. </p>
  2728. <p>
  2729. </p>
  2730. <table>
  2731. <thead>
  2732. <tr>
  2733. <th>Value</th>
  2734. <th>Description</th>
  2735. </tr>
  2736. </thead>
  2737. <tbody><tr><td><p>&#34;Auto&#34;</p></td>
  2738. <td></td>
  2739. </tr><tr><td><p>&#34;Base64&#34;</p></td>
  2740. <td></td>
  2741. </tr><tr><td><p>&#34;Base64URL&#34;</p></td>
  2742. <td></td>
  2743. </tr><tr><td><p>&#34;None&#34;</p></td>
  2744. <td></td>
  2745. </tr></tbody>
  2746. </table>
  2747. <h3 id="external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">ExternalSecretDeletionPolicy
  2748. (<code>string</code> alias)</p></h3>
  2749. <p>
  2750. (<em>Appears on:</em>
  2751. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  2752. </p>
  2753. <p>
  2754. <p>ExternalSecretDeletionPolicy defines rules on how to delete the resulting Secret.</p>
  2755. </p>
  2756. <table>
  2757. <thead>
  2758. <tr>
  2759. <th>Value</th>
  2760. <th>Description</th>
  2761. </tr>
  2762. </thead>
  2763. <tbody><tr><td><p>&#34;Delete&#34;</p></td>
  2764. <td><p>Delete deletes the secret if all provider secrets are deleted.
  2765. If a secret gets deleted on the provider side and is not accessible
  2766. anymore this is not considered an error and the ExternalSecret
  2767. does not go into SecretSyncedError status.</p>
  2768. </td>
  2769. </tr><tr><td><p>&#34;Merge&#34;</p></td>
  2770. <td><p>Merge removes keys in the secret, but not the secret itself.
  2771. If a secret gets deleted on the provider side and is not accessible
  2772. anymore this is not considered an error and the ExternalSecret
  2773. does not go into SecretSyncedError status.</p>
  2774. </td>
  2775. </tr><tr><td><p>&#34;Retain&#34;</p></td>
  2776. <td><p>Retain will retain the secret if all provider secrets have been deleted.
  2777. If a provider secret does not exist the ExternalSecret gets into the
  2778. SecretSyncedError status.</p>
  2779. </td>
  2780. </tr></tbody>
  2781. </table>
  2782. <h3 id="external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind
  2783. </h3>
  2784. <p>
  2785. (<em>Appears on:</em>
  2786. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  2787. </p>
  2788. <p>
  2789. </p>
  2790. <table>
  2791. <thead>
  2792. <tr>
  2793. <th>Field</th>
  2794. <th>Description</th>
  2795. </tr>
  2796. </thead>
  2797. <tbody>
  2798. <tr>
  2799. <td>
  2800. <code>path</code></br>
  2801. <em>
  2802. string
  2803. </em>
  2804. </td>
  2805. <td>
  2806. <em>(Optional)</em>
  2807. <p>A root path to start the find operations.</p>
  2808. </td>
  2809. </tr>
  2810. <tr>
  2811. <td>
  2812. <code>name</code></br>
  2813. <em>
  2814. <a href="#external-secrets.io/v1beta1.FindName">
  2815. FindName
  2816. </a>
  2817. </em>
  2818. </td>
  2819. <td>
  2820. <em>(Optional)</em>
  2821. <p>Finds secrets based on the name.</p>
  2822. </td>
  2823. </tr>
  2824. <tr>
  2825. <td>
  2826. <code>tags</code></br>
  2827. <em>
  2828. map[string]string
  2829. </em>
  2830. </td>
  2831. <td>
  2832. <em>(Optional)</em>
  2833. <p>Find secrets based on tags.</p>
  2834. </td>
  2835. </tr>
  2836. <tr>
  2837. <td>
  2838. <code>conversionStrategy</code></br>
  2839. <em>
  2840. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  2841. ExternalSecretConversionStrategy
  2842. </a>
  2843. </em>
  2844. </td>
  2845. <td>
  2846. <em>(Optional)</em>
  2847. <p>Used to define a conversion Strategy</p>
  2848. </td>
  2849. </tr>
  2850. <tr>
  2851. <td>
  2852. <code>decodingStrategy</code></br>
  2853. <em>
  2854. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  2855. ExternalSecretDecodingStrategy
  2856. </a>
  2857. </em>
  2858. </td>
  2859. <td>
  2860. <em>(Optional)</em>
  2861. <p>Used to define a decoding Strategy</p>
  2862. </td>
  2863. </tr>
  2864. </tbody>
  2865. </table>
  2866. <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">ExternalSecretMetadataPolicy
  2867. (<code>string</code> alias)</p></h3>
  2868. <p>
  2869. (<em>Appears on:</em>
  2870. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>)
  2871. </p>
  2872. <p>
  2873. </p>
  2874. <table>
  2875. <thead>
  2876. <tr>
  2877. <th>Value</th>
  2878. <th>Description</th>
  2879. </tr>
  2880. </thead>
  2881. <tbody><tr><td><p>&#34;Fetch&#34;</p></td>
  2882. <td></td>
  2883. </tr><tr><td><p>&#34;None&#34;</p></td>
  2884. <td></td>
  2885. </tr></tbody>
  2886. </table>
  2887. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite
  2888. </h3>
  2889. <p>
  2890. (<em>Appears on:</em>
  2891. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  2892. </p>
  2893. <p>
  2894. </p>
  2895. <table>
  2896. <thead>
  2897. <tr>
  2898. <th>Field</th>
  2899. <th>Description</th>
  2900. </tr>
  2901. </thead>
  2902. <tbody>
  2903. <tr>
  2904. <td>
  2905. <code>regexp</code></br>
  2906. <em>
  2907. <a href="#external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">
  2908. ExternalSecretRewriteRegexp
  2909. </a>
  2910. </em>
  2911. </td>
  2912. <td>
  2913. <em>(Optional)</em>
  2914. <p>Used to rewrite with regular expressions.
  2915. The resulting key will be the output of a regexp.ReplaceAll operation.</p>
  2916. </td>
  2917. </tr>
  2918. </tbody>
  2919. </table>
  2920. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">ExternalSecretRewriteRegexp
  2921. </h3>
  2922. <p>
  2923. (<em>Appears on:</em>
  2924. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
  2925. </p>
  2926. <p>
  2927. </p>
  2928. <table>
  2929. <thead>
  2930. <tr>
  2931. <th>Field</th>
  2932. <th>Description</th>
  2933. </tr>
  2934. </thead>
  2935. <tbody>
  2936. <tr>
  2937. <td>
  2938. <code>source</code></br>
  2939. <em>
  2940. string
  2941. </em>
  2942. </td>
  2943. <td>
  2944. <p>Used to define the regular expression of a re.Compiler.</p>
  2945. </td>
  2946. </tr>
  2947. <tr>
  2948. <td>
  2949. <code>target</code></br>
  2950. <em>
  2951. string
  2952. </em>
  2953. </td>
  2954. <td>
  2955. <p>Used to define the target pattern of a ReplaceAll operation.</p>
  2956. </td>
  2957. </tr>
  2958. </tbody>
  2959. </table>
  2960. <h3 id="external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec
  2961. </h3>
  2962. <p>
  2963. (<em>Appears on:</em>
  2964. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>,
  2965. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  2966. </p>
  2967. <p>
  2968. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  2969. </p>
  2970. <table>
  2971. <thead>
  2972. <tr>
  2973. <th>Field</th>
  2974. <th>Description</th>
  2975. </tr>
  2976. </thead>
  2977. <tbody>
  2978. <tr>
  2979. <td>
  2980. <code>secretStoreRef</code></br>
  2981. <em>
  2982. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  2983. SecretStoreRef
  2984. </a>
  2985. </em>
  2986. </td>
  2987. <td>
  2988. <em>(Optional)</em>
  2989. </td>
  2990. </tr>
  2991. <tr>
  2992. <td>
  2993. <code>target</code></br>
  2994. <em>
  2995. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  2996. ExternalSecretTarget
  2997. </a>
  2998. </em>
  2999. </td>
  3000. <td>
  3001. <em>(Optional)</em>
  3002. </td>
  3003. </tr>
  3004. <tr>
  3005. <td>
  3006. <code>refreshInterval</code></br>
  3007. <em>
  3008. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  3009. Kubernetes meta/v1.Duration
  3010. </a>
  3011. </em>
  3012. </td>
  3013. <td>
  3014. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  3015. 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;
  3016. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  3017. </td>
  3018. </tr>
  3019. <tr>
  3020. <td>
  3021. <code>data</code></br>
  3022. <em>
  3023. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  3024. []ExternalSecretData
  3025. </a>
  3026. </em>
  3027. </td>
  3028. <td>
  3029. <em>(Optional)</em>
  3030. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  3031. </td>
  3032. </tr>
  3033. <tr>
  3034. <td>
  3035. <code>dataFrom</code></br>
  3036. <em>
  3037. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  3038. []ExternalSecretDataFromRemoteRef
  3039. </a>
  3040. </em>
  3041. </td>
  3042. <td>
  3043. <em>(Optional)</em>
  3044. <p>DataFrom is used to fetch all properties from a specific Provider data
  3045. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  3046. </td>
  3047. </tr>
  3048. </tbody>
  3049. </table>
  3050. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus
  3051. </h3>
  3052. <p>
  3053. (<em>Appears on:</em>
  3054. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  3055. </p>
  3056. <p>
  3057. </p>
  3058. <table>
  3059. <thead>
  3060. <tr>
  3061. <th>Field</th>
  3062. <th>Description</th>
  3063. </tr>
  3064. </thead>
  3065. <tbody>
  3066. <tr>
  3067. <td>
  3068. <code>refreshTime</code></br>
  3069. <em>
  3070. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  3071. Kubernetes meta/v1.Time
  3072. </a>
  3073. </em>
  3074. </td>
  3075. <td>
  3076. <p>refreshTime is the time and date the external secret was fetched and
  3077. the target secret updated</p>
  3078. </td>
  3079. </tr>
  3080. <tr>
  3081. <td>
  3082. <code>syncedResourceVersion</code></br>
  3083. <em>
  3084. string
  3085. </em>
  3086. </td>
  3087. <td>
  3088. <p>SyncedResourceVersion keeps track of the last synced version</p>
  3089. </td>
  3090. </tr>
  3091. <tr>
  3092. <td>
  3093. <code>conditions</code></br>
  3094. <em>
  3095. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">
  3096. []ExternalSecretStatusCondition
  3097. </a>
  3098. </em>
  3099. </td>
  3100. <td>
  3101. <em>(Optional)</em>
  3102. </td>
  3103. </tr>
  3104. </tbody>
  3105. </table>
  3106. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  3107. </h3>
  3108. <p>
  3109. (<em>Appears on:</em>
  3110. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus</a>)
  3111. </p>
  3112. <p>
  3113. </p>
  3114. <table>
  3115. <thead>
  3116. <tr>
  3117. <th>Field</th>
  3118. <th>Description</th>
  3119. </tr>
  3120. </thead>
  3121. <tbody>
  3122. <tr>
  3123. <td>
  3124. <code>type</code></br>
  3125. <em>
  3126. <a href="#external-secrets.io/v1beta1.ExternalSecretConditionType">
  3127. ExternalSecretConditionType
  3128. </a>
  3129. </em>
  3130. </td>
  3131. <td>
  3132. </td>
  3133. </tr>
  3134. <tr>
  3135. <td>
  3136. <code>status</code></br>
  3137. <em>
  3138. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  3139. Kubernetes core/v1.ConditionStatus
  3140. </a>
  3141. </em>
  3142. </td>
  3143. <td>
  3144. </td>
  3145. </tr>
  3146. <tr>
  3147. <td>
  3148. <code>reason</code></br>
  3149. <em>
  3150. string
  3151. </em>
  3152. </td>
  3153. <td>
  3154. <em>(Optional)</em>
  3155. </td>
  3156. </tr>
  3157. <tr>
  3158. <td>
  3159. <code>message</code></br>
  3160. <em>
  3161. string
  3162. </em>
  3163. </td>
  3164. <td>
  3165. <em>(Optional)</em>
  3166. </td>
  3167. </tr>
  3168. <tr>
  3169. <td>
  3170. <code>lastTransitionTime</code></br>
  3171. <em>
  3172. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  3173. Kubernetes meta/v1.Time
  3174. </a>
  3175. </em>
  3176. </td>
  3177. <td>
  3178. <em>(Optional)</em>
  3179. </td>
  3180. </tr>
  3181. </tbody>
  3182. </table>
  3183. <h3 id="external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget
  3184. </h3>
  3185. <p>
  3186. (<em>Appears on:</em>
  3187. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  3188. </p>
  3189. <p>
  3190. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  3191. There can be only one target per ExternalSecret.</p>
  3192. </p>
  3193. <table>
  3194. <thead>
  3195. <tr>
  3196. <th>Field</th>
  3197. <th>Description</th>
  3198. </tr>
  3199. </thead>
  3200. <tbody>
  3201. <tr>
  3202. <td>
  3203. <code>name</code></br>
  3204. <em>
  3205. string
  3206. </em>
  3207. </td>
  3208. <td>
  3209. <em>(Optional)</em>
  3210. <p>Name defines the name of the Secret resource to be managed
  3211. This field is immutable
  3212. Defaults to the .metadata.name of the ExternalSecret resource</p>
  3213. </td>
  3214. </tr>
  3215. <tr>
  3216. <td>
  3217. <code>creationPolicy</code></br>
  3218. <em>
  3219. <a href="#external-secrets.io/v1beta1.ExternalSecretCreationPolicy">
  3220. ExternalSecretCreationPolicy
  3221. </a>
  3222. </em>
  3223. </td>
  3224. <td>
  3225. <em>(Optional)</em>
  3226. <p>CreationPolicy defines rules on how to create the resulting Secret
  3227. Defaults to &lsquo;Owner&rsquo;</p>
  3228. </td>
  3229. </tr>
  3230. <tr>
  3231. <td>
  3232. <code>deletionPolicy</code></br>
  3233. <em>
  3234. <a href="#external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">
  3235. ExternalSecretDeletionPolicy
  3236. </a>
  3237. </em>
  3238. </td>
  3239. <td>
  3240. <em>(Optional)</em>
  3241. <p>DeletionPolicy defines rules on how to delete the resulting Secret
  3242. Defaults to &lsquo;Retain&rsquo;</p>
  3243. </td>
  3244. </tr>
  3245. <tr>
  3246. <td>
  3247. <code>template</code></br>
  3248. <em>
  3249. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">
  3250. ExternalSecretTemplate
  3251. </a>
  3252. </em>
  3253. </td>
  3254. <td>
  3255. <em>(Optional)</em>
  3256. <p>Template defines a blueprint for the created Secret resource.</p>
  3257. </td>
  3258. </tr>
  3259. <tr>
  3260. <td>
  3261. <code>immutable</code></br>
  3262. <em>
  3263. bool
  3264. </em>
  3265. </td>
  3266. <td>
  3267. <em>(Optional)</em>
  3268. <p>Immutable defines if the final secret will be immutable</p>
  3269. </td>
  3270. </tr>
  3271. </tbody>
  3272. </table>
  3273. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate
  3274. </h3>
  3275. <p>
  3276. (<em>Appears on:</em>
  3277. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  3278. </p>
  3279. <p>
  3280. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  3281. 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>
  3282. </p>
  3283. <table>
  3284. <thead>
  3285. <tr>
  3286. <th>Field</th>
  3287. <th>Description</th>
  3288. </tr>
  3289. </thead>
  3290. <tbody>
  3291. <tr>
  3292. <td>
  3293. <code>type</code></br>
  3294. <em>
  3295. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secrettype-v1-core">
  3296. Kubernetes core/v1.SecretType
  3297. </a>
  3298. </em>
  3299. </td>
  3300. <td>
  3301. <em>(Optional)</em>
  3302. </td>
  3303. </tr>
  3304. <tr>
  3305. <td>
  3306. <code>engineVersion</code></br>
  3307. <em>
  3308. <a href="#external-secrets.io/v1beta1.TemplateEngineVersion">
  3309. TemplateEngineVersion
  3310. </a>
  3311. </em>
  3312. </td>
  3313. <td>
  3314. </td>
  3315. </tr>
  3316. <tr>
  3317. <td>
  3318. <code>metadata</code></br>
  3319. <em>
  3320. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">
  3321. ExternalSecretTemplateMetadata
  3322. </a>
  3323. </em>
  3324. </td>
  3325. <td>
  3326. <em>(Optional)</em>
  3327. </td>
  3328. </tr>
  3329. <tr>
  3330. <td>
  3331. <code>data</code></br>
  3332. <em>
  3333. map[string]string
  3334. </em>
  3335. </td>
  3336. <td>
  3337. <em>(Optional)</em>
  3338. </td>
  3339. </tr>
  3340. <tr>
  3341. <td>
  3342. <code>templateFrom</code></br>
  3343. <em>
  3344. <a href="#external-secrets.io/v1beta1.TemplateFrom">
  3345. []TemplateFrom
  3346. </a>
  3347. </em>
  3348. </td>
  3349. <td>
  3350. <em>(Optional)</em>
  3351. </td>
  3352. </tr>
  3353. </tbody>
  3354. </table>
  3355. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  3356. </h3>
  3357. <p>
  3358. (<em>Appears on:</em>
  3359. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  3360. </p>
  3361. <p>
  3362. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  3363. </p>
  3364. <table>
  3365. <thead>
  3366. <tr>
  3367. <th>Field</th>
  3368. <th>Description</th>
  3369. </tr>
  3370. </thead>
  3371. <tbody>
  3372. <tr>
  3373. <td>
  3374. <code>annotations</code></br>
  3375. <em>
  3376. map[string]string
  3377. </em>
  3378. </td>
  3379. <td>
  3380. <em>(Optional)</em>
  3381. </td>
  3382. </tr>
  3383. <tr>
  3384. <td>
  3385. <code>labels</code></br>
  3386. <em>
  3387. map[string]string
  3388. </em>
  3389. </td>
  3390. <td>
  3391. <em>(Optional)</em>
  3392. </td>
  3393. </tr>
  3394. </tbody>
  3395. </table>
  3396. <h3 id="external-secrets.io/v1beta1.ExternalSecretValidator">ExternalSecretValidator
  3397. </h3>
  3398. <p>
  3399. </p>
  3400. <h3 id="external-secrets.io/v1beta1.FakeProvider">FakeProvider
  3401. </h3>
  3402. <p>
  3403. (<em>Appears on:</em>
  3404. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3405. </p>
  3406. <p>
  3407. <p>FakeProvider configures a fake provider that returns static values.</p>
  3408. </p>
  3409. <table>
  3410. <thead>
  3411. <tr>
  3412. <th>Field</th>
  3413. <th>Description</th>
  3414. </tr>
  3415. </thead>
  3416. <tbody>
  3417. <tr>
  3418. <td>
  3419. <code>data</code></br>
  3420. <em>
  3421. <a href="#external-secrets.io/v1beta1.FakeProviderData">
  3422. []FakeProviderData
  3423. </a>
  3424. </em>
  3425. </td>
  3426. <td>
  3427. </td>
  3428. </tr>
  3429. </tbody>
  3430. </table>
  3431. <h3 id="external-secrets.io/v1beta1.FakeProviderData">FakeProviderData
  3432. </h3>
  3433. <p>
  3434. (<em>Appears on:</em>
  3435. <a href="#external-secrets.io/v1beta1.FakeProvider">FakeProvider</a>)
  3436. </p>
  3437. <p>
  3438. </p>
  3439. <table>
  3440. <thead>
  3441. <tr>
  3442. <th>Field</th>
  3443. <th>Description</th>
  3444. </tr>
  3445. </thead>
  3446. <tbody>
  3447. <tr>
  3448. <td>
  3449. <code>key</code></br>
  3450. <em>
  3451. string
  3452. </em>
  3453. </td>
  3454. <td>
  3455. </td>
  3456. </tr>
  3457. <tr>
  3458. <td>
  3459. <code>value</code></br>
  3460. <em>
  3461. string
  3462. </em>
  3463. </td>
  3464. <td>
  3465. </td>
  3466. </tr>
  3467. <tr>
  3468. <td>
  3469. <code>valueMap</code></br>
  3470. <em>
  3471. map[string]string
  3472. </em>
  3473. </td>
  3474. <td>
  3475. </td>
  3476. </tr>
  3477. <tr>
  3478. <td>
  3479. <code>version</code></br>
  3480. <em>
  3481. string
  3482. </em>
  3483. </td>
  3484. <td>
  3485. </td>
  3486. </tr>
  3487. </tbody>
  3488. </table>
  3489. <h3 id="external-secrets.io/v1beta1.FindName">FindName
  3490. </h3>
  3491. <p>
  3492. (<em>Appears on:</em>
  3493. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  3494. </p>
  3495. <p>
  3496. </p>
  3497. <table>
  3498. <thead>
  3499. <tr>
  3500. <th>Field</th>
  3501. <th>Description</th>
  3502. </tr>
  3503. </thead>
  3504. <tbody>
  3505. <tr>
  3506. <td>
  3507. <code>regexp</code></br>
  3508. <em>
  3509. string
  3510. </em>
  3511. </td>
  3512. <td>
  3513. <em>(Optional)</em>
  3514. <p>Finds secrets base</p>
  3515. </td>
  3516. </tr>
  3517. </tbody>
  3518. </table>
  3519. <h3 id="external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth
  3520. </h3>
  3521. <p>
  3522. (<em>Appears on:</em>
  3523. <a href="#external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider</a>)
  3524. </p>
  3525. <p>
  3526. </p>
  3527. <table>
  3528. <thead>
  3529. <tr>
  3530. <th>Field</th>
  3531. <th>Description</th>
  3532. </tr>
  3533. </thead>
  3534. <tbody>
  3535. <tr>
  3536. <td>
  3537. <code>secretRef</code></br>
  3538. <em>
  3539. <a href="#external-secrets.io/v1beta1.GCPSMAuthSecretRef">
  3540. GCPSMAuthSecretRef
  3541. </a>
  3542. </em>
  3543. </td>
  3544. <td>
  3545. <em>(Optional)</em>
  3546. </td>
  3547. </tr>
  3548. <tr>
  3549. <td>
  3550. <code>workloadIdentity</code></br>
  3551. <em>
  3552. <a href="#external-secrets.io/v1beta1.GCPWorkloadIdentity">
  3553. GCPWorkloadIdentity
  3554. </a>
  3555. </em>
  3556. </td>
  3557. <td>
  3558. <em>(Optional)</em>
  3559. </td>
  3560. </tr>
  3561. </tbody>
  3562. </table>
  3563. <h3 id="external-secrets.io/v1beta1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  3564. </h3>
  3565. <p>
  3566. (<em>Appears on:</em>
  3567. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  3568. </p>
  3569. <p>
  3570. </p>
  3571. <table>
  3572. <thead>
  3573. <tr>
  3574. <th>Field</th>
  3575. <th>Description</th>
  3576. </tr>
  3577. </thead>
  3578. <tbody>
  3579. <tr>
  3580. <td>
  3581. <code>secretAccessKeySecretRef</code></br>
  3582. <em>
  3583. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3584. External Secrets meta/v1.SecretKeySelector
  3585. </a>
  3586. </em>
  3587. </td>
  3588. <td>
  3589. <em>(Optional)</em>
  3590. <p>The SecretAccessKey is used for authentication</p>
  3591. </td>
  3592. </tr>
  3593. </tbody>
  3594. </table>
  3595. <h3 id="external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider
  3596. </h3>
  3597. <p>
  3598. (<em>Appears on:</em>
  3599. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3600. </p>
  3601. <p>
  3602. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  3603. </p>
  3604. <table>
  3605. <thead>
  3606. <tr>
  3607. <th>Field</th>
  3608. <th>Description</th>
  3609. </tr>
  3610. </thead>
  3611. <tbody>
  3612. <tr>
  3613. <td>
  3614. <code>auth</code></br>
  3615. <em>
  3616. <a href="#external-secrets.io/v1beta1.GCPSMAuth">
  3617. GCPSMAuth
  3618. </a>
  3619. </em>
  3620. </td>
  3621. <td>
  3622. <em>(Optional)</em>
  3623. <p>Auth defines the information necessary to authenticate against GCP</p>
  3624. </td>
  3625. </tr>
  3626. <tr>
  3627. <td>
  3628. <code>projectID</code></br>
  3629. <em>
  3630. string
  3631. </em>
  3632. </td>
  3633. <td>
  3634. <p>ProjectID project where secret is located</p>
  3635. </td>
  3636. </tr>
  3637. </tbody>
  3638. </table>
  3639. <h3 id="external-secrets.io/v1beta1.GCPWorkloadIdentity">GCPWorkloadIdentity
  3640. </h3>
  3641. <p>
  3642. (<em>Appears on:</em>
  3643. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  3644. </p>
  3645. <p>
  3646. </p>
  3647. <table>
  3648. <thead>
  3649. <tr>
  3650. <th>Field</th>
  3651. <th>Description</th>
  3652. </tr>
  3653. </thead>
  3654. <tbody>
  3655. <tr>
  3656. <td>
  3657. <code>serviceAccountRef</code></br>
  3658. <em>
  3659. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  3660. External Secrets meta/v1.ServiceAccountSelector
  3661. </a>
  3662. </em>
  3663. </td>
  3664. <td>
  3665. </td>
  3666. </tr>
  3667. <tr>
  3668. <td>
  3669. <code>clusterLocation</code></br>
  3670. <em>
  3671. string
  3672. </em>
  3673. </td>
  3674. <td>
  3675. </td>
  3676. </tr>
  3677. <tr>
  3678. <td>
  3679. <code>clusterName</code></br>
  3680. <em>
  3681. string
  3682. </em>
  3683. </td>
  3684. <td>
  3685. </td>
  3686. </tr>
  3687. <tr>
  3688. <td>
  3689. <code>clusterProjectID</code></br>
  3690. <em>
  3691. string
  3692. </em>
  3693. </td>
  3694. <td>
  3695. </td>
  3696. </tr>
  3697. </tbody>
  3698. </table>
  3699. <h3 id="external-secrets.io/v1beta1.GeneratorRef">GeneratorRef
  3700. </h3>
  3701. <p>
  3702. (<em>Appears on:</em>
  3703. <a href="#external-secrets.io/v1beta1.SourceRef">SourceRef</a>)
  3704. </p>
  3705. <p>
  3706. <p>GeneratorRef points to a generator custom resource.</p>
  3707. </p>
  3708. <table>
  3709. <thead>
  3710. <tr>
  3711. <th>Field</th>
  3712. <th>Description</th>
  3713. </tr>
  3714. </thead>
  3715. <tbody>
  3716. <tr>
  3717. <td>
  3718. <code>apiVersion</code></br>
  3719. <em>
  3720. string
  3721. </em>
  3722. </td>
  3723. <td>
  3724. <p>Specify the apiVersion of the generator resource</p>
  3725. </td>
  3726. </tr>
  3727. <tr>
  3728. <td>
  3729. <code>kind</code></br>
  3730. <em>
  3731. string
  3732. </em>
  3733. </td>
  3734. <td>
  3735. <p>Specify the Kind of the resource, e.g. Password, ACRAccessToken etc.</p>
  3736. </td>
  3737. </tr>
  3738. <tr>
  3739. <td>
  3740. <code>name</code></br>
  3741. <em>
  3742. string
  3743. </em>
  3744. </td>
  3745. <td>
  3746. <p>Specify the name of the generator resource</p>
  3747. </td>
  3748. </tr>
  3749. </tbody>
  3750. </table>
  3751. <h3 id="external-secrets.io/v1beta1.GenericStore">GenericStore
  3752. </h3>
  3753. <p>
  3754. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  3755. or a namespaced SecretStore.</p>
  3756. </p>
  3757. <h3 id="external-secrets.io/v1beta1.GenericStoreValidator">GenericStoreValidator
  3758. </h3>
  3759. <p>
  3760. </p>
  3761. <h3 id="external-secrets.io/v1beta1.GitlabAuth">GitlabAuth
  3762. </h3>
  3763. <p>
  3764. (<em>Appears on:</em>
  3765. <a href="#external-secrets.io/v1beta1.GitlabProvider">GitlabProvider</a>)
  3766. </p>
  3767. <p>
  3768. </p>
  3769. <table>
  3770. <thead>
  3771. <tr>
  3772. <th>Field</th>
  3773. <th>Description</th>
  3774. </tr>
  3775. </thead>
  3776. <tbody>
  3777. <tr>
  3778. <td>
  3779. <code>SecretRef</code></br>
  3780. <em>
  3781. <a href="#external-secrets.io/v1beta1.GitlabSecretRef">
  3782. GitlabSecretRef
  3783. </a>
  3784. </em>
  3785. </td>
  3786. <td>
  3787. </td>
  3788. </tr>
  3789. </tbody>
  3790. </table>
  3791. <h3 id="external-secrets.io/v1beta1.GitlabProvider">GitlabProvider
  3792. </h3>
  3793. <p>
  3794. (<em>Appears on:</em>
  3795. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3796. </p>
  3797. <p>
  3798. <p>Configures a store to sync secrets with a GitLab instance.</p>
  3799. </p>
  3800. <table>
  3801. <thead>
  3802. <tr>
  3803. <th>Field</th>
  3804. <th>Description</th>
  3805. </tr>
  3806. </thead>
  3807. <tbody>
  3808. <tr>
  3809. <td>
  3810. <code>url</code></br>
  3811. <em>
  3812. string
  3813. </em>
  3814. </td>
  3815. <td>
  3816. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
  3817. </td>
  3818. </tr>
  3819. <tr>
  3820. <td>
  3821. <code>auth</code></br>
  3822. <em>
  3823. <a href="#external-secrets.io/v1beta1.GitlabAuth">
  3824. GitlabAuth
  3825. </a>
  3826. </em>
  3827. </td>
  3828. <td>
  3829. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
  3830. </td>
  3831. </tr>
  3832. <tr>
  3833. <td>
  3834. <code>projectID</code></br>
  3835. <em>
  3836. string
  3837. </em>
  3838. </td>
  3839. <td>
  3840. <p>ProjectID specifies a project where secrets are located.</p>
  3841. </td>
  3842. </tr>
  3843. <tr>
  3844. <td>
  3845. <code>inheritFromGroups</code></br>
  3846. <em>
  3847. bool
  3848. </em>
  3849. </td>
  3850. <td>
  3851. <p>InheritFromGroups specifies whether parent groups should be discovered and checked for secrets.</p>
  3852. </td>
  3853. </tr>
  3854. <tr>
  3855. <td>
  3856. <code>groupIDs</code></br>
  3857. <em>
  3858. []string
  3859. </em>
  3860. </td>
  3861. <td>
  3862. <p>GroupIDs specify, which gitlab groups to pull secrets from. Group secrets are read from left to right followed by the project variables.</p>
  3863. </td>
  3864. </tr>
  3865. <tr>
  3866. <td>
  3867. <code>environment</code></br>
  3868. <em>
  3869. string
  3870. </em>
  3871. </td>
  3872. <td>
  3873. <p>Environment environment_scope of gitlab CI/CD variables (Please see <a href="https://docs.gitlab.com/ee/ci/environments/#create-a-static-environment">https://docs.gitlab.com/ee/ci/environments/#create-a-static-environment</a> on how to create environments)</p>
  3874. </td>
  3875. </tr>
  3876. </tbody>
  3877. </table>
  3878. <h3 id="external-secrets.io/v1beta1.GitlabSecretRef">GitlabSecretRef
  3879. </h3>
  3880. <p>
  3881. (<em>Appears on:</em>
  3882. <a href="#external-secrets.io/v1beta1.GitlabAuth">GitlabAuth</a>)
  3883. </p>
  3884. <p>
  3885. </p>
  3886. <table>
  3887. <thead>
  3888. <tr>
  3889. <th>Field</th>
  3890. <th>Description</th>
  3891. </tr>
  3892. </thead>
  3893. <tbody>
  3894. <tr>
  3895. <td>
  3896. <code>accessToken</code></br>
  3897. <em>
  3898. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3899. External Secrets meta/v1.SecretKeySelector
  3900. </a>
  3901. </em>
  3902. </td>
  3903. <td>
  3904. <p>AccessToken is used for authentication.</p>
  3905. </td>
  3906. </tr>
  3907. </tbody>
  3908. </table>
  3909. <h3 id="external-secrets.io/v1beta1.IBMAuth">IBMAuth
  3910. </h3>
  3911. <p>
  3912. (<em>Appears on:</em>
  3913. <a href="#external-secrets.io/v1beta1.IBMProvider">IBMProvider</a>)
  3914. </p>
  3915. <p>
  3916. </p>
  3917. <table>
  3918. <thead>
  3919. <tr>
  3920. <th>Field</th>
  3921. <th>Description</th>
  3922. </tr>
  3923. </thead>
  3924. <tbody>
  3925. <tr>
  3926. <td>
  3927. <code>secretRef</code></br>
  3928. <em>
  3929. <a href="#external-secrets.io/v1beta1.IBMAuthSecretRef">
  3930. IBMAuthSecretRef
  3931. </a>
  3932. </em>
  3933. </td>
  3934. <td>
  3935. </td>
  3936. </tr>
  3937. <tr>
  3938. <td>
  3939. <code>containerAuth</code></br>
  3940. <em>
  3941. <a href="#external-secrets.io/v1beta1.IBMAuthContainerAuth">
  3942. IBMAuthContainerAuth
  3943. </a>
  3944. </em>
  3945. </td>
  3946. <td>
  3947. </td>
  3948. </tr>
  3949. </tbody>
  3950. </table>
  3951. <h3 id="external-secrets.io/v1beta1.IBMAuthContainerAuth">IBMAuthContainerAuth
  3952. </h3>
  3953. <p>
  3954. (<em>Appears on:</em>
  3955. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  3956. </p>
  3957. <p>
  3958. <p>IBM Container-based auth with IAM Trusted Profile.</p>
  3959. </p>
  3960. <table>
  3961. <thead>
  3962. <tr>
  3963. <th>Field</th>
  3964. <th>Description</th>
  3965. </tr>
  3966. </thead>
  3967. <tbody>
  3968. <tr>
  3969. <td>
  3970. <code>profile</code></br>
  3971. <em>
  3972. string
  3973. </em>
  3974. </td>
  3975. <td>
  3976. <p>the IBM Trusted Profile</p>
  3977. </td>
  3978. </tr>
  3979. <tr>
  3980. <td>
  3981. <code>tokenLocation</code></br>
  3982. <em>
  3983. string
  3984. </em>
  3985. </td>
  3986. <td>
  3987. <p>Location the token is mounted on the pod</p>
  3988. </td>
  3989. </tr>
  3990. <tr>
  3991. <td>
  3992. <code>iamEndpoint</code></br>
  3993. <em>
  3994. string
  3995. </em>
  3996. </td>
  3997. <td>
  3998. </td>
  3999. </tr>
  4000. </tbody>
  4001. </table>
  4002. <h3 id="external-secrets.io/v1beta1.IBMAuthSecretRef">IBMAuthSecretRef
  4003. </h3>
  4004. <p>
  4005. (<em>Appears on:</em>
  4006. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  4007. </p>
  4008. <p>
  4009. </p>
  4010. <table>
  4011. <thead>
  4012. <tr>
  4013. <th>Field</th>
  4014. <th>Description</th>
  4015. </tr>
  4016. </thead>
  4017. <tbody>
  4018. <tr>
  4019. <td>
  4020. <code>secretApiKeySecretRef</code></br>
  4021. <em>
  4022. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  4023. External Secrets meta/v1.SecretKeySelector
  4024. </a>
  4025. </em>
  4026. </td>
  4027. <td>
  4028. <p>The SecretAccessKey is used for authentication</p>
  4029. </td>
  4030. </tr>
  4031. </tbody>
  4032. </table>
  4033. <h3 id="external-secrets.io/v1beta1.IBMProvider">IBMProvider
  4034. </h3>
  4035. <p>
  4036. (<em>Appears on:</em>
  4037. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4038. </p>
  4039. <p>
  4040. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
  4041. backend.</p>
  4042. </p>
  4043. <table>
  4044. <thead>
  4045. <tr>
  4046. <th>Field</th>
  4047. <th>Description</th>
  4048. </tr>
  4049. </thead>
  4050. <tbody>
  4051. <tr>
  4052. <td>
  4053. <code>auth</code></br>
  4054. <em>
  4055. <a href="#external-secrets.io/v1beta1.IBMAuth">
  4056. IBMAuth
  4057. </a>
  4058. </em>
  4059. </td>
  4060. <td>
  4061. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
  4062. </td>
  4063. </tr>
  4064. <tr>
  4065. <td>
  4066. <code>serviceUrl</code></br>
  4067. <em>
  4068. string
  4069. </em>
  4070. </td>
  4071. <td>
  4072. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
  4073. </td>
  4074. </tr>
  4075. </tbody>
  4076. </table>
  4077. <h3 id="external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth
  4078. </h3>
  4079. <p>
  4080. (<em>Appears on:</em>
  4081. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  4082. </p>
  4083. <p>
  4084. </p>
  4085. <table>
  4086. <thead>
  4087. <tr>
  4088. <th>Field</th>
  4089. <th>Description</th>
  4090. </tr>
  4091. </thead>
  4092. <tbody>
  4093. <tr>
  4094. <td>
  4095. <code>cert</code></br>
  4096. <em>
  4097. <a href="#external-secrets.io/v1beta1.CertAuth">
  4098. CertAuth
  4099. </a>
  4100. </em>
  4101. </td>
  4102. <td>
  4103. <em>(Optional)</em>
  4104. <p>has both clientCert and clientKey as secretKeySelector</p>
  4105. </td>
  4106. </tr>
  4107. <tr>
  4108. <td>
  4109. <code>token</code></br>
  4110. <em>
  4111. <a href="#external-secrets.io/v1beta1.TokenAuth">
  4112. TokenAuth
  4113. </a>
  4114. </em>
  4115. </td>
  4116. <td>
  4117. <em>(Optional)</em>
  4118. <p>use static token to authenticate with</p>
  4119. </td>
  4120. </tr>
  4121. <tr>
  4122. <td>
  4123. <code>serviceAccount</code></br>
  4124. <em>
  4125. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  4126. External Secrets meta/v1.ServiceAccountSelector
  4127. </a>
  4128. </em>
  4129. </td>
  4130. <td>
  4131. <em>(Optional)</em>
  4132. <p>points to a service account that should be used for authentication</p>
  4133. </td>
  4134. </tr>
  4135. </tbody>
  4136. </table>
  4137. <h3 id="external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider
  4138. </h3>
  4139. <p>
  4140. (<em>Appears on:</em>
  4141. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4142. </p>
  4143. <p>
  4144. <p>Configures a store to sync secrets with a Kubernetes instance.</p>
  4145. </p>
  4146. <table>
  4147. <thead>
  4148. <tr>
  4149. <th>Field</th>
  4150. <th>Description</th>
  4151. </tr>
  4152. </thead>
  4153. <tbody>
  4154. <tr>
  4155. <td>
  4156. <code>server</code></br>
  4157. <em>
  4158. <a href="#external-secrets.io/v1beta1.KubernetesServer">
  4159. KubernetesServer
  4160. </a>
  4161. </em>
  4162. </td>
  4163. <td>
  4164. <p>configures the Kubernetes server Address.</p>
  4165. </td>
  4166. </tr>
  4167. <tr>
  4168. <td>
  4169. <code>auth</code></br>
  4170. <em>
  4171. <a href="#external-secrets.io/v1beta1.KubernetesAuth">
  4172. KubernetesAuth
  4173. </a>
  4174. </em>
  4175. </td>
  4176. <td>
  4177. <p>Auth configures how secret-manager authenticates with a Kubernetes instance.</p>
  4178. </td>
  4179. </tr>
  4180. <tr>
  4181. <td>
  4182. <code>remoteNamespace</code></br>
  4183. <em>
  4184. string
  4185. </em>
  4186. </td>
  4187. <td>
  4188. <em>(Optional)</em>
  4189. <p>Remote namespace to fetch the secrets from</p>
  4190. </td>
  4191. </tr>
  4192. </tbody>
  4193. </table>
  4194. <h3 id="external-secrets.io/v1beta1.KubernetesServer">KubernetesServer
  4195. </h3>
  4196. <p>
  4197. (<em>Appears on:</em>
  4198. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  4199. </p>
  4200. <p>
  4201. </p>
  4202. <table>
  4203. <thead>
  4204. <tr>
  4205. <th>Field</th>
  4206. <th>Description</th>
  4207. </tr>
  4208. </thead>
  4209. <tbody>
  4210. <tr>
  4211. <td>
  4212. <code>url</code></br>
  4213. <em>
  4214. string
  4215. </em>
  4216. </td>
  4217. <td>
  4218. <em>(Optional)</em>
  4219. <p>configures the Kubernetes server Address.</p>
  4220. </td>
  4221. </tr>
  4222. <tr>
  4223. <td>
  4224. <code>caBundle</code></br>
  4225. <em>
  4226. []byte
  4227. </em>
  4228. </td>
  4229. <td>
  4230. <em>(Optional)</em>
  4231. <p>CABundle is a base64-encoded CA certificate</p>
  4232. </td>
  4233. </tr>
  4234. <tr>
  4235. <td>
  4236. <code>caProvider</code></br>
  4237. <em>
  4238. <a href="#external-secrets.io/v1beta1.CAProvider">
  4239. CAProvider
  4240. </a>
  4241. </em>
  4242. </td>
  4243. <td>
  4244. <em>(Optional)</em>
  4245. <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>
  4246. </td>
  4247. </tr>
  4248. </tbody>
  4249. </table>
  4250. <h3 id="external-secrets.io/v1beta1.NoSecretError">NoSecretError
  4251. </h3>
  4252. <p>
  4253. <p>NoSecretError shall be returned when a GetSecret can not find the
  4254. desired secret. This is used for deletionPolicy.</p>
  4255. </p>
  4256. <h3 id="external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth
  4257. </h3>
  4258. <p>
  4259. (<em>Appears on:</em>
  4260. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider</a>)
  4261. </p>
  4262. <p>
  4263. <p>OnePasswordAuth contains a secretRef for credentials.</p>
  4264. </p>
  4265. <table>
  4266. <thead>
  4267. <tr>
  4268. <th>Field</th>
  4269. <th>Description</th>
  4270. </tr>
  4271. </thead>
  4272. <tbody>
  4273. <tr>
  4274. <td>
  4275. <code>secretRef</code></br>
  4276. <em>
  4277. <a href="#external-secrets.io/v1beta1.OnePasswordAuthSecretRef">
  4278. OnePasswordAuthSecretRef
  4279. </a>
  4280. </em>
  4281. </td>
  4282. <td>
  4283. </td>
  4284. </tr>
  4285. </tbody>
  4286. </table>
  4287. <h3 id="external-secrets.io/v1beta1.OnePasswordAuthSecretRef">OnePasswordAuthSecretRef
  4288. </h3>
  4289. <p>
  4290. (<em>Appears on:</em>
  4291. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth</a>)
  4292. </p>
  4293. <p>
  4294. <p>OnePasswordAuthSecretRef holds secret references for 1Password credentials.</p>
  4295. </p>
  4296. <table>
  4297. <thead>
  4298. <tr>
  4299. <th>Field</th>
  4300. <th>Description</th>
  4301. </tr>
  4302. </thead>
  4303. <tbody>
  4304. <tr>
  4305. <td>
  4306. <code>connectTokenSecretRef</code></br>
  4307. <em>
  4308. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  4309. External Secrets meta/v1.SecretKeySelector
  4310. </a>
  4311. </em>
  4312. </td>
  4313. <td>
  4314. <p>The ConnectToken is used for authentication to a 1Password Connect Server.</p>
  4315. </td>
  4316. </tr>
  4317. </tbody>
  4318. </table>
  4319. <h3 id="external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider
  4320. </h3>
  4321. <p>
  4322. (<em>Appears on:</em>
  4323. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4324. </p>
  4325. <p>
  4326. <p>OnePasswordProvider configures a store to sync secrets using the 1Password Secret Manager provider.</p>
  4327. </p>
  4328. <table>
  4329. <thead>
  4330. <tr>
  4331. <th>Field</th>
  4332. <th>Description</th>
  4333. </tr>
  4334. </thead>
  4335. <tbody>
  4336. <tr>
  4337. <td>
  4338. <code>auth</code></br>
  4339. <em>
  4340. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">
  4341. OnePasswordAuth
  4342. </a>
  4343. </em>
  4344. </td>
  4345. <td>
  4346. <p>Auth defines the information necessary to authenticate against OnePassword Connect Server</p>
  4347. </td>
  4348. </tr>
  4349. <tr>
  4350. <td>
  4351. <code>connectHost</code></br>
  4352. <em>
  4353. string
  4354. </em>
  4355. </td>
  4356. <td>
  4357. <p>ConnectHost defines the OnePassword Connect Server to connect to</p>
  4358. </td>
  4359. </tr>
  4360. <tr>
  4361. <td>
  4362. <code>vaults</code></br>
  4363. <em>
  4364. map[string]int
  4365. </em>
  4366. </td>
  4367. <td>
  4368. <p>Vaults defines which OnePassword vaults to search in which order</p>
  4369. </td>
  4370. </tr>
  4371. </tbody>
  4372. </table>
  4373. <h3 id="external-secrets.io/v1beta1.OracleAuth">OracleAuth
  4374. </h3>
  4375. <p>
  4376. (<em>Appears on:</em>
  4377. <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
  4378. </p>
  4379. <p>
  4380. </p>
  4381. <table>
  4382. <thead>
  4383. <tr>
  4384. <th>Field</th>
  4385. <th>Description</th>
  4386. </tr>
  4387. </thead>
  4388. <tbody>
  4389. <tr>
  4390. <td>
  4391. <code>tenancy</code></br>
  4392. <em>
  4393. string
  4394. </em>
  4395. </td>
  4396. <td>
  4397. <p>Tenancy is the tenancy OCID where user is located.</p>
  4398. </td>
  4399. </tr>
  4400. <tr>
  4401. <td>
  4402. <code>user</code></br>
  4403. <em>
  4404. string
  4405. </em>
  4406. </td>
  4407. <td>
  4408. <p>User is an access OCID specific to the account.</p>
  4409. </td>
  4410. </tr>
  4411. <tr>
  4412. <td>
  4413. <code>secretRef</code></br>
  4414. <em>
  4415. <a href="#external-secrets.io/v1beta1.OracleSecretRef">
  4416. OracleSecretRef
  4417. </a>
  4418. </em>
  4419. </td>
  4420. <td>
  4421. <p>SecretRef to pass through sensitive information.</p>
  4422. </td>
  4423. </tr>
  4424. </tbody>
  4425. </table>
  4426. <h3 id="external-secrets.io/v1beta1.OracleProvider">OracleProvider
  4427. </h3>
  4428. <p>
  4429. (<em>Appears on:</em>
  4430. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4431. </p>
  4432. <p>
  4433. <p>Configures an store to sync secrets using a Oracle Vault
  4434. backend.</p>
  4435. </p>
  4436. <table>
  4437. <thead>
  4438. <tr>
  4439. <th>Field</th>
  4440. <th>Description</th>
  4441. </tr>
  4442. </thead>
  4443. <tbody>
  4444. <tr>
  4445. <td>
  4446. <code>region</code></br>
  4447. <em>
  4448. string
  4449. </em>
  4450. </td>
  4451. <td>
  4452. <p>Region is the region where vault is located.</p>
  4453. </td>
  4454. </tr>
  4455. <tr>
  4456. <td>
  4457. <code>vault</code></br>
  4458. <em>
  4459. string
  4460. </em>
  4461. </td>
  4462. <td>
  4463. <p>Vault is the vault&rsquo;s OCID of the specific vault where secret is located.</p>
  4464. </td>
  4465. </tr>
  4466. <tr>
  4467. <td>
  4468. <code>auth</code></br>
  4469. <em>
  4470. <a href="#external-secrets.io/v1beta1.OracleAuth">
  4471. OracleAuth
  4472. </a>
  4473. </em>
  4474. </td>
  4475. <td>
  4476. <em>(Optional)</em>
  4477. <p>Auth configures how secret-manager authenticates with the Oracle Vault.
  4478. If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
  4479. </td>
  4480. </tr>
  4481. </tbody>
  4482. </table>
  4483. <h3 id="external-secrets.io/v1beta1.OracleSecretRef">OracleSecretRef
  4484. </h3>
  4485. <p>
  4486. (<em>Appears on:</em>
  4487. <a href="#external-secrets.io/v1beta1.OracleAuth">OracleAuth</a>)
  4488. </p>
  4489. <p>
  4490. </p>
  4491. <table>
  4492. <thead>
  4493. <tr>
  4494. <th>Field</th>
  4495. <th>Description</th>
  4496. </tr>
  4497. </thead>
  4498. <tbody>
  4499. <tr>
  4500. <td>
  4501. <code>privatekey</code></br>
  4502. <em>
  4503. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  4504. External Secrets meta/v1.SecretKeySelector
  4505. </a>
  4506. </em>
  4507. </td>
  4508. <td>
  4509. <p>PrivateKey is the user&rsquo;s API Signing Key in PEM format, used for authentication.</p>
  4510. </td>
  4511. </tr>
  4512. <tr>
  4513. <td>
  4514. <code>fingerprint</code></br>
  4515. <em>
  4516. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  4517. External Secrets meta/v1.SecretKeySelector
  4518. </a>
  4519. </em>
  4520. </td>
  4521. <td>
  4522. <p>Fingerprint is the fingerprint of the API private key.</p>
  4523. </td>
  4524. </tr>
  4525. </tbody>
  4526. </table>
  4527. <h3 id="external-secrets.io/v1beta1.Provider">Provider
  4528. </h3>
  4529. <p>
  4530. <p>Provider is a common interface for interacting with secret backends.</p>
  4531. </p>
  4532. <h3 id="external-secrets.io/v1beta1.PushRemoteRef">PushRemoteRef
  4533. </h3>
  4534. <p>
  4535. <p>This interface is to allow using v1alpha1 content in Provider registered in v1beta1.</p>
  4536. </p>
  4537. <h3 id="external-secrets.io/v1beta1.SecretStore">SecretStore
  4538. </h3>
  4539. <p>
  4540. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  4541. </p>
  4542. <table>
  4543. <thead>
  4544. <tr>
  4545. <th>Field</th>
  4546. <th>Description</th>
  4547. </tr>
  4548. </thead>
  4549. <tbody>
  4550. <tr>
  4551. <td>
  4552. <code>metadata</code></br>
  4553. <em>
  4554. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  4555. Kubernetes meta/v1.ObjectMeta
  4556. </a>
  4557. </em>
  4558. </td>
  4559. <td>
  4560. Refer to the Kubernetes API documentation for the fields of the
  4561. <code>metadata</code> field.
  4562. </td>
  4563. </tr>
  4564. <tr>
  4565. <td>
  4566. <code>spec</code></br>
  4567. <em>
  4568. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  4569. SecretStoreSpec
  4570. </a>
  4571. </em>
  4572. </td>
  4573. <td>
  4574. <br/>
  4575. <br/>
  4576. <table>
  4577. <tr>
  4578. <td>
  4579. <code>controller</code></br>
  4580. <em>
  4581. string
  4582. </em>
  4583. </td>
  4584. <td>
  4585. <em>(Optional)</em>
  4586. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  4587. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  4588. </td>
  4589. </tr>
  4590. <tr>
  4591. <td>
  4592. <code>provider</code></br>
  4593. <em>
  4594. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  4595. SecretStoreProvider
  4596. </a>
  4597. </em>
  4598. </td>
  4599. <td>
  4600. <p>Used to configure the provider. Only one provider may be set</p>
  4601. </td>
  4602. </tr>
  4603. <tr>
  4604. <td>
  4605. <code>retrySettings</code></br>
  4606. <em>
  4607. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  4608. SecretStoreRetrySettings
  4609. </a>
  4610. </em>
  4611. </td>
  4612. <td>
  4613. <em>(Optional)</em>
  4614. <p>Used to configure http retries if failed</p>
  4615. </td>
  4616. </tr>
  4617. <tr>
  4618. <td>
  4619. <code>refreshInterval</code></br>
  4620. <em>
  4621. int
  4622. </em>
  4623. </td>
  4624. <td>
  4625. <em>(Optional)</em>
  4626. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  4627. </td>
  4628. </tr>
  4629. <tr>
  4630. <td>
  4631. <code>conditions</code></br>
  4632. <em>
  4633. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  4634. []ClusterSecretStoreCondition
  4635. </a>
  4636. </em>
  4637. </td>
  4638. <td>
  4639. <em>(Optional)</em>
  4640. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  4641. </td>
  4642. </tr>
  4643. </table>
  4644. </td>
  4645. </tr>
  4646. <tr>
  4647. <td>
  4648. <code>status</code></br>
  4649. <em>
  4650. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  4651. SecretStoreStatus
  4652. </a>
  4653. </em>
  4654. </td>
  4655. <td>
  4656. </td>
  4657. </tr>
  4658. </tbody>
  4659. </table>
  4660. <h3 id="external-secrets.io/v1beta1.SecretStoreCapabilities">SecretStoreCapabilities
  4661. (<code>string</code> alias)</p></h3>
  4662. <p>
  4663. (<em>Appears on:</em>
  4664. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  4665. </p>
  4666. <p>
  4667. <p>SecretStoreCapabilities defines the possible operations a SecretStore can do.</p>
  4668. </p>
  4669. <table>
  4670. <thead>
  4671. <tr>
  4672. <th>Value</th>
  4673. <th>Description</th>
  4674. </tr>
  4675. </thead>
  4676. <tbody><tr><td><p>&#34;ReadOnly&#34;</p></td>
  4677. <td></td>
  4678. </tr><tr><td><p>&#34;ReadWrite&#34;</p></td>
  4679. <td></td>
  4680. </tr><tr><td><p>&#34;WriteOnly&#34;</p></td>
  4681. <td></td>
  4682. </tr></tbody>
  4683. </table>
  4684. <h3 id="external-secrets.io/v1beta1.SecretStoreConditionType">SecretStoreConditionType
  4685. (<code>string</code> alias)</p></h3>
  4686. <p>
  4687. (<em>Appears on:</em>
  4688. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  4689. </p>
  4690. <p>
  4691. </p>
  4692. <table>
  4693. <thead>
  4694. <tr>
  4695. <th>Value</th>
  4696. <th>Description</th>
  4697. </tr>
  4698. </thead>
  4699. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  4700. <td></td>
  4701. </tr></tbody>
  4702. </table>
  4703. <h3 id="external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider
  4704. </h3>
  4705. <p>
  4706. (<em>Appears on:</em>
  4707. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  4708. </p>
  4709. <p>
  4710. <p>SecretStoreProvider contains the provider-specific configuration.</p>
  4711. </p>
  4712. <table>
  4713. <thead>
  4714. <tr>
  4715. <th>Field</th>
  4716. <th>Description</th>
  4717. </tr>
  4718. </thead>
  4719. <tbody>
  4720. <tr>
  4721. <td>
  4722. <code>aws</code></br>
  4723. <em>
  4724. <a href="#external-secrets.io/v1beta1.AWSProvider">
  4725. AWSProvider
  4726. </a>
  4727. </em>
  4728. </td>
  4729. <td>
  4730. <em>(Optional)</em>
  4731. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  4732. </td>
  4733. </tr>
  4734. <tr>
  4735. <td>
  4736. <code>azurekv</code></br>
  4737. <em>
  4738. <a href="#external-secrets.io/v1beta1.AzureKVProvider">
  4739. AzureKVProvider
  4740. </a>
  4741. </em>
  4742. </td>
  4743. <td>
  4744. <em>(Optional)</em>
  4745. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  4746. </td>
  4747. </tr>
  4748. <tr>
  4749. <td>
  4750. <code>akeyless</code></br>
  4751. <em>
  4752. <a href="#external-secrets.io/v1beta1.AkeylessProvider">
  4753. AkeylessProvider
  4754. </a>
  4755. </em>
  4756. </td>
  4757. <td>
  4758. <em>(Optional)</em>
  4759. <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
  4760. </td>
  4761. </tr>
  4762. <tr>
  4763. <td>
  4764. <code>vault</code></br>
  4765. <em>
  4766. <a href="#external-secrets.io/v1beta1.VaultProvider">
  4767. VaultProvider
  4768. </a>
  4769. </em>
  4770. </td>
  4771. <td>
  4772. <em>(Optional)</em>
  4773. <p>Vault configures this store to sync secrets using Hashi provider</p>
  4774. </td>
  4775. </tr>
  4776. <tr>
  4777. <td>
  4778. <code>gcpsm</code></br>
  4779. <em>
  4780. <a href="#external-secrets.io/v1beta1.GCPSMProvider">
  4781. GCPSMProvider
  4782. </a>
  4783. </em>
  4784. </td>
  4785. <td>
  4786. <em>(Optional)</em>
  4787. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  4788. </td>
  4789. </tr>
  4790. <tr>
  4791. <td>
  4792. <code>oracle</code></br>
  4793. <em>
  4794. <a href="#external-secrets.io/v1beta1.OracleProvider">
  4795. OracleProvider
  4796. </a>
  4797. </em>
  4798. </td>
  4799. <td>
  4800. <em>(Optional)</em>
  4801. <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
  4802. </td>
  4803. </tr>
  4804. <tr>
  4805. <td>
  4806. <code>ibm</code></br>
  4807. <em>
  4808. <a href="#external-secrets.io/v1beta1.IBMProvider">
  4809. IBMProvider
  4810. </a>
  4811. </em>
  4812. </td>
  4813. <td>
  4814. <em>(Optional)</em>
  4815. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
  4816. </td>
  4817. </tr>
  4818. <tr>
  4819. <td>
  4820. <code>yandexcertificatemanager</code></br>
  4821. <em>
  4822. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">
  4823. YandexCertificateManagerProvider
  4824. </a>
  4825. </em>
  4826. </td>
  4827. <td>
  4828. <em>(Optional)</em>
  4829. <p>YandexCertificateManager configures this store to sync secrets using Yandex Certificate Manager provider</p>
  4830. </td>
  4831. </tr>
  4832. <tr>
  4833. <td>
  4834. <code>yandexlockbox</code></br>
  4835. <em>
  4836. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">
  4837. YandexLockboxProvider
  4838. </a>
  4839. </em>
  4840. </td>
  4841. <td>
  4842. <em>(Optional)</em>
  4843. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
  4844. </td>
  4845. </tr>
  4846. <tr>
  4847. <td>
  4848. <code>gitlab</code></br>
  4849. <em>
  4850. <a href="#external-secrets.io/v1beta1.GitlabProvider">
  4851. GitlabProvider
  4852. </a>
  4853. </em>
  4854. </td>
  4855. <td>
  4856. <em>(Optional)</em>
  4857. <p>Gitlab configures this store to sync secrets using Gitlab Variables provider</p>
  4858. </td>
  4859. </tr>
  4860. <tr>
  4861. <td>
  4862. <code>alibaba</code></br>
  4863. <em>
  4864. <a href="#external-secrets.io/v1beta1.AlibabaProvider">
  4865. AlibabaProvider
  4866. </a>
  4867. </em>
  4868. </td>
  4869. <td>
  4870. <em>(Optional)</em>
  4871. <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
  4872. </td>
  4873. </tr>
  4874. <tr>
  4875. <td>
  4876. <code>onepassword</code></br>
  4877. <em>
  4878. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">
  4879. OnePasswordProvider
  4880. </a>
  4881. </em>
  4882. </td>
  4883. <td>
  4884. <em>(Optional)</em>
  4885. <p>OnePassword configures this store to sync secrets using the 1Password Cloud provider</p>
  4886. </td>
  4887. </tr>
  4888. <tr>
  4889. <td>
  4890. <code>webhook</code></br>
  4891. <em>
  4892. <a href="#external-secrets.io/v1beta1.WebhookProvider">
  4893. WebhookProvider
  4894. </a>
  4895. </em>
  4896. </td>
  4897. <td>
  4898. <em>(Optional)</em>
  4899. <p>Webhook configures this store to sync secrets using a generic templated webhook</p>
  4900. </td>
  4901. </tr>
  4902. <tr>
  4903. <td>
  4904. <code>kubernetes</code></br>
  4905. <em>
  4906. <a href="#external-secrets.io/v1beta1.KubernetesProvider">
  4907. KubernetesProvider
  4908. </a>
  4909. </em>
  4910. </td>
  4911. <td>
  4912. <em>(Optional)</em>
  4913. <p>Kubernetes configures this store to sync secrets using a Kubernetes cluster provider</p>
  4914. </td>
  4915. </tr>
  4916. <tr>
  4917. <td>
  4918. <code>fake</code></br>
  4919. <em>
  4920. <a href="#external-secrets.io/v1beta1.FakeProvider">
  4921. FakeProvider
  4922. </a>
  4923. </em>
  4924. </td>
  4925. <td>
  4926. <em>(Optional)</em>
  4927. <p>Fake configures a store with static key/value pairs</p>
  4928. </td>
  4929. </tr>
  4930. <tr>
  4931. <td>
  4932. <code>senhasegura</code></br>
  4933. <em>
  4934. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">
  4935. SenhaseguraProvider
  4936. </a>
  4937. </em>
  4938. </td>
  4939. <td>
  4940. <em>(Optional)</em>
  4941. <p>Senhasegura configures this store to sync secrets using senhasegura provider</p>
  4942. </td>
  4943. </tr>
  4944. <tr>
  4945. <td>
  4946. <code>doppler</code></br>
  4947. <em>
  4948. <a href="#external-secrets.io/v1beta1.DopplerProvider">
  4949. DopplerProvider
  4950. </a>
  4951. </em>
  4952. </td>
  4953. <td>
  4954. <em>(Optional)</em>
  4955. <p>Doppler configures this store to sync secrets using the Doppler provider</p>
  4956. </td>
  4957. </tr>
  4958. </tbody>
  4959. </table>
  4960. <h3 id="external-secrets.io/v1beta1.SecretStoreRef">SecretStoreRef
  4961. </h3>
  4962. <p>
  4963. (<em>Appears on:</em>
  4964. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>,
  4965. <a href="#external-secrets.io/v1beta1.SourceRef">SourceRef</a>)
  4966. </p>
  4967. <p>
  4968. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  4969. </p>
  4970. <table>
  4971. <thead>
  4972. <tr>
  4973. <th>Field</th>
  4974. <th>Description</th>
  4975. </tr>
  4976. </thead>
  4977. <tbody>
  4978. <tr>
  4979. <td>
  4980. <code>name</code></br>
  4981. <em>
  4982. string
  4983. </em>
  4984. </td>
  4985. <td>
  4986. <p>Name of the SecretStore resource</p>
  4987. </td>
  4988. </tr>
  4989. <tr>
  4990. <td>
  4991. <code>kind</code></br>
  4992. <em>
  4993. string
  4994. </em>
  4995. </td>
  4996. <td>
  4997. <em>(Optional)</em>
  4998. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  4999. Defaults to <code>SecretStore</code></p>
  5000. </td>
  5001. </tr>
  5002. </tbody>
  5003. </table>
  5004. <h3 id="external-secrets.io/v1beta1.SecretStoreRetrySettings">SecretStoreRetrySettings
  5005. </h3>
  5006. <p>
  5007. (<em>Appears on:</em>
  5008. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  5009. </p>
  5010. <p>
  5011. </p>
  5012. <table>
  5013. <thead>
  5014. <tr>
  5015. <th>Field</th>
  5016. <th>Description</th>
  5017. </tr>
  5018. </thead>
  5019. <tbody>
  5020. <tr>
  5021. <td>
  5022. <code>maxRetries</code></br>
  5023. <em>
  5024. int32
  5025. </em>
  5026. </td>
  5027. <td>
  5028. </td>
  5029. </tr>
  5030. <tr>
  5031. <td>
  5032. <code>retryInterval</code></br>
  5033. <em>
  5034. string
  5035. </em>
  5036. </td>
  5037. <td>
  5038. </td>
  5039. </tr>
  5040. </tbody>
  5041. </table>
  5042. <h3 id="external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec
  5043. </h3>
  5044. <p>
  5045. (<em>Appears on:</em>
  5046. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  5047. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  5048. </p>
  5049. <p>
  5050. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  5051. </p>
  5052. <table>
  5053. <thead>
  5054. <tr>
  5055. <th>Field</th>
  5056. <th>Description</th>
  5057. </tr>
  5058. </thead>
  5059. <tbody>
  5060. <tr>
  5061. <td>
  5062. <code>controller</code></br>
  5063. <em>
  5064. string
  5065. </em>
  5066. </td>
  5067. <td>
  5068. <em>(Optional)</em>
  5069. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  5070. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  5071. </td>
  5072. </tr>
  5073. <tr>
  5074. <td>
  5075. <code>provider</code></br>
  5076. <em>
  5077. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  5078. SecretStoreProvider
  5079. </a>
  5080. </em>
  5081. </td>
  5082. <td>
  5083. <p>Used to configure the provider. Only one provider may be set</p>
  5084. </td>
  5085. </tr>
  5086. <tr>
  5087. <td>
  5088. <code>retrySettings</code></br>
  5089. <em>
  5090. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  5091. SecretStoreRetrySettings
  5092. </a>
  5093. </em>
  5094. </td>
  5095. <td>
  5096. <em>(Optional)</em>
  5097. <p>Used to configure http retries if failed</p>
  5098. </td>
  5099. </tr>
  5100. <tr>
  5101. <td>
  5102. <code>refreshInterval</code></br>
  5103. <em>
  5104. int
  5105. </em>
  5106. </td>
  5107. <td>
  5108. <em>(Optional)</em>
  5109. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  5110. </td>
  5111. </tr>
  5112. <tr>
  5113. <td>
  5114. <code>conditions</code></br>
  5115. <em>
  5116. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  5117. []ClusterSecretStoreCondition
  5118. </a>
  5119. </em>
  5120. </td>
  5121. <td>
  5122. <em>(Optional)</em>
  5123. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  5124. </td>
  5125. </tr>
  5126. </tbody>
  5127. </table>
  5128. <h3 id="external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus
  5129. </h3>
  5130. <p>
  5131. (<em>Appears on:</em>
  5132. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  5133. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  5134. </p>
  5135. <p>
  5136. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  5137. </p>
  5138. <table>
  5139. <thead>
  5140. <tr>
  5141. <th>Field</th>
  5142. <th>Description</th>
  5143. </tr>
  5144. </thead>
  5145. <tbody>
  5146. <tr>
  5147. <td>
  5148. <code>conditions</code></br>
  5149. <em>
  5150. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">
  5151. []SecretStoreStatusCondition
  5152. </a>
  5153. </em>
  5154. </td>
  5155. <td>
  5156. <em>(Optional)</em>
  5157. </td>
  5158. </tr>
  5159. <tr>
  5160. <td>
  5161. <code>capabilities</code></br>
  5162. <em>
  5163. <a href="#external-secrets.io/v1beta1.SecretStoreCapabilities">
  5164. SecretStoreCapabilities
  5165. </a>
  5166. </em>
  5167. </td>
  5168. <td>
  5169. <em>(Optional)</em>
  5170. </td>
  5171. </tr>
  5172. </tbody>
  5173. </table>
  5174. <h3 id="external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition
  5175. </h3>
  5176. <p>
  5177. (<em>Appears on:</em>
  5178. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  5179. </p>
  5180. <p>
  5181. </p>
  5182. <table>
  5183. <thead>
  5184. <tr>
  5185. <th>Field</th>
  5186. <th>Description</th>
  5187. </tr>
  5188. </thead>
  5189. <tbody>
  5190. <tr>
  5191. <td>
  5192. <code>type</code></br>
  5193. <em>
  5194. <a href="#external-secrets.io/v1beta1.SecretStoreConditionType">
  5195. SecretStoreConditionType
  5196. </a>
  5197. </em>
  5198. </td>
  5199. <td>
  5200. </td>
  5201. </tr>
  5202. <tr>
  5203. <td>
  5204. <code>status</code></br>
  5205. <em>
  5206. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  5207. Kubernetes core/v1.ConditionStatus
  5208. </a>
  5209. </em>
  5210. </td>
  5211. <td>
  5212. </td>
  5213. </tr>
  5214. <tr>
  5215. <td>
  5216. <code>reason</code></br>
  5217. <em>
  5218. string
  5219. </em>
  5220. </td>
  5221. <td>
  5222. <em>(Optional)</em>
  5223. </td>
  5224. </tr>
  5225. <tr>
  5226. <td>
  5227. <code>message</code></br>
  5228. <em>
  5229. string
  5230. </em>
  5231. </td>
  5232. <td>
  5233. <em>(Optional)</em>
  5234. </td>
  5235. </tr>
  5236. <tr>
  5237. <td>
  5238. <code>lastTransitionTime</code></br>
  5239. <em>
  5240. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  5241. Kubernetes meta/v1.Time
  5242. </a>
  5243. </em>
  5244. </td>
  5245. <td>
  5246. <em>(Optional)</em>
  5247. </td>
  5248. </tr>
  5249. </tbody>
  5250. </table>
  5251. <h3 id="external-secrets.io/v1beta1.SecretsClient">SecretsClient
  5252. </h3>
  5253. <p>
  5254. <p>SecretsClient provides access to secrets.</p>
  5255. </p>
  5256. <h3 id="external-secrets.io/v1beta1.SenhaseguraAuth">SenhaseguraAuth
  5257. </h3>
  5258. <p>
  5259. (<em>Appears on:</em>
  5260. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  5261. </p>
  5262. <p>
  5263. <p>SenhaseguraAuth tells the controller how to do auth in senhasegura.</p>
  5264. </p>
  5265. <table>
  5266. <thead>
  5267. <tr>
  5268. <th>Field</th>
  5269. <th>Description</th>
  5270. </tr>
  5271. </thead>
  5272. <tbody>
  5273. <tr>
  5274. <td>
  5275. <code>clientId</code></br>
  5276. <em>
  5277. string
  5278. </em>
  5279. </td>
  5280. <td>
  5281. </td>
  5282. </tr>
  5283. <tr>
  5284. <td>
  5285. <code>clientSecretSecretRef</code></br>
  5286. <em>
  5287. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5288. External Secrets meta/v1.SecretKeySelector
  5289. </a>
  5290. </em>
  5291. </td>
  5292. <td>
  5293. </td>
  5294. </tr>
  5295. </tbody>
  5296. </table>
  5297. <h3 id="external-secrets.io/v1beta1.SenhaseguraModuleType">SenhaseguraModuleType
  5298. (<code>string</code> alias)</p></h3>
  5299. <p>
  5300. (<em>Appears on:</em>
  5301. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  5302. </p>
  5303. <p>
  5304. <p>SenhaseguraModuleType enum defines senhasegura target module to fetch secrets</p>
  5305. </p>
  5306. <table>
  5307. <thead>
  5308. <tr>
  5309. <th>Value</th>
  5310. <th>Description</th>
  5311. </tr>
  5312. </thead>
  5313. <tbody><tr><td><p>&#34;DSM&#34;</p></td>
  5314. <td><pre><code> SenhaseguraModuleDSM is the senhasegura DevOps Secrets Management module
  5315. see: https://senhasegura.com/devops
  5316. </code></pre>
  5317. </td>
  5318. </tr></tbody>
  5319. </table>
  5320. <h3 id="external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider
  5321. </h3>
  5322. <p>
  5323. (<em>Appears on:</em>
  5324. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5325. </p>
  5326. <p>
  5327. <p>SenhaseguraProvider setup a store to sync secrets with senhasegura.</p>
  5328. </p>
  5329. <table>
  5330. <thead>
  5331. <tr>
  5332. <th>Field</th>
  5333. <th>Description</th>
  5334. </tr>
  5335. </thead>
  5336. <tbody>
  5337. <tr>
  5338. <td>
  5339. <code>url</code></br>
  5340. <em>
  5341. string
  5342. </em>
  5343. </td>
  5344. <td>
  5345. <p>URL of senhasegura</p>
  5346. </td>
  5347. </tr>
  5348. <tr>
  5349. <td>
  5350. <code>module</code></br>
  5351. <em>
  5352. <a href="#external-secrets.io/v1beta1.SenhaseguraModuleType">
  5353. SenhaseguraModuleType
  5354. </a>
  5355. </em>
  5356. </td>
  5357. <td>
  5358. <p>Module defines which senhasegura module should be used to get secrets</p>
  5359. </td>
  5360. </tr>
  5361. <tr>
  5362. <td>
  5363. <code>auth</code></br>
  5364. <em>
  5365. <a href="#external-secrets.io/v1beta1.SenhaseguraAuth">
  5366. SenhaseguraAuth
  5367. </a>
  5368. </em>
  5369. </td>
  5370. <td>
  5371. <p>Auth defines parameters to authenticate in senhasegura</p>
  5372. </td>
  5373. </tr>
  5374. <tr>
  5375. <td>
  5376. <code>ignoreSslCertificate</code></br>
  5377. <em>
  5378. bool
  5379. </em>
  5380. </td>
  5381. <td>
  5382. <p>IgnoreSslCertificate defines if SSL certificate must be ignored</p>
  5383. </td>
  5384. </tr>
  5385. </tbody>
  5386. </table>
  5387. <h3 id="external-secrets.io/v1beta1.SourceRef">SourceRef
  5388. </h3>
  5389. <p>
  5390. (<em>Appears on:</em>
  5391. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>,
  5392. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  5393. </p>
  5394. <p>
  5395. <p>SourceRef allows you to override the source
  5396. from which the secret will be pulled from.
  5397. You can define at maximum one property.</p>
  5398. </p>
  5399. <table>
  5400. <thead>
  5401. <tr>
  5402. <th>Field</th>
  5403. <th>Description</th>
  5404. </tr>
  5405. </thead>
  5406. <tbody>
  5407. <tr>
  5408. <td>
  5409. <code>storeRef</code></br>
  5410. <em>
  5411. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  5412. SecretStoreRef
  5413. </a>
  5414. </em>
  5415. </td>
  5416. <td>
  5417. <em>(Optional)</em>
  5418. </td>
  5419. </tr>
  5420. <tr>
  5421. <td>
  5422. <code>generatorRef</code></br>
  5423. <em>
  5424. <a href="#external-secrets.io/v1beta1.GeneratorRef">
  5425. GeneratorRef
  5426. </a>
  5427. </em>
  5428. </td>
  5429. <td>
  5430. <em>(Optional)</em>
  5431. <p>GeneratorRef points to a generator custom resource in</p>
  5432. </td>
  5433. </tr>
  5434. </tbody>
  5435. </table>
  5436. <h3 id="external-secrets.io/v1beta1.TemplateEngineVersion">TemplateEngineVersion
  5437. (<code>string</code> alias)</p></h3>
  5438. <p>
  5439. (<em>Appears on:</em>
  5440. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  5441. </p>
  5442. <p>
  5443. </p>
  5444. <table>
  5445. <thead>
  5446. <tr>
  5447. <th>Value</th>
  5448. <th>Description</th>
  5449. </tr>
  5450. </thead>
  5451. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  5452. <td></td>
  5453. </tr><tr><td><p>&#34;v2&#34;</p></td>
  5454. <td></td>
  5455. </tr></tbody>
  5456. </table>
  5457. <h3 id="external-secrets.io/v1beta1.TemplateFrom">TemplateFrom
  5458. </h3>
  5459. <p>
  5460. (<em>Appears on:</em>
  5461. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  5462. </p>
  5463. <p>
  5464. </p>
  5465. <table>
  5466. <thead>
  5467. <tr>
  5468. <th>Field</th>
  5469. <th>Description</th>
  5470. </tr>
  5471. </thead>
  5472. <tbody>
  5473. <tr>
  5474. <td>
  5475. <code>configMap</code></br>
  5476. <em>
  5477. <a href="#external-secrets.io/v1beta1.TemplateRef">
  5478. TemplateRef
  5479. </a>
  5480. </em>
  5481. </td>
  5482. <td>
  5483. </td>
  5484. </tr>
  5485. <tr>
  5486. <td>
  5487. <code>secret</code></br>
  5488. <em>
  5489. <a href="#external-secrets.io/v1beta1.TemplateRef">
  5490. TemplateRef
  5491. </a>
  5492. </em>
  5493. </td>
  5494. <td>
  5495. </td>
  5496. </tr>
  5497. </tbody>
  5498. </table>
  5499. <h3 id="external-secrets.io/v1beta1.TemplateRef">TemplateRef
  5500. </h3>
  5501. <p>
  5502. (<em>Appears on:</em>
  5503. <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
  5504. </p>
  5505. <p>
  5506. </p>
  5507. <table>
  5508. <thead>
  5509. <tr>
  5510. <th>Field</th>
  5511. <th>Description</th>
  5512. </tr>
  5513. </thead>
  5514. <tbody>
  5515. <tr>
  5516. <td>
  5517. <code>name</code></br>
  5518. <em>
  5519. string
  5520. </em>
  5521. </td>
  5522. <td>
  5523. </td>
  5524. </tr>
  5525. <tr>
  5526. <td>
  5527. <code>items</code></br>
  5528. <em>
  5529. <a href="#external-secrets.io/v1beta1.TemplateRefItem">
  5530. []TemplateRefItem
  5531. </a>
  5532. </em>
  5533. </td>
  5534. <td>
  5535. </td>
  5536. </tr>
  5537. </tbody>
  5538. </table>
  5539. <h3 id="external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem
  5540. </h3>
  5541. <p>
  5542. (<em>Appears on:</em>
  5543. <a href="#external-secrets.io/v1beta1.TemplateRef">TemplateRef</a>)
  5544. </p>
  5545. <p>
  5546. </p>
  5547. <table>
  5548. <thead>
  5549. <tr>
  5550. <th>Field</th>
  5551. <th>Description</th>
  5552. </tr>
  5553. </thead>
  5554. <tbody>
  5555. <tr>
  5556. <td>
  5557. <code>key</code></br>
  5558. <em>
  5559. string
  5560. </em>
  5561. </td>
  5562. <td>
  5563. </td>
  5564. </tr>
  5565. </tbody>
  5566. </table>
  5567. <h3 id="external-secrets.io/v1beta1.TokenAuth">TokenAuth
  5568. </h3>
  5569. <p>
  5570. (<em>Appears on:</em>
  5571. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  5572. </p>
  5573. <p>
  5574. </p>
  5575. <table>
  5576. <thead>
  5577. <tr>
  5578. <th>Field</th>
  5579. <th>Description</th>
  5580. </tr>
  5581. </thead>
  5582. <tbody>
  5583. <tr>
  5584. <td>
  5585. <code>bearerToken</code></br>
  5586. <em>
  5587. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5588. External Secrets meta/v1.SecretKeySelector
  5589. </a>
  5590. </em>
  5591. </td>
  5592. <td>
  5593. </td>
  5594. </tr>
  5595. </tbody>
  5596. </table>
  5597. <h3 id="external-secrets.io/v1beta1.ValidationResult">ValidationResult
  5598. (<code>byte</code> alias)</p></h3>
  5599. <p>
  5600. </p>
  5601. <table>
  5602. <thead>
  5603. <tr>
  5604. <th>Value</th>
  5605. <th>Description</th>
  5606. </tr>
  5607. </thead>
  5608. <tbody><tr><td><p>2</p></td>
  5609. <td><p>Error indicates that there is a misconfiguration.</p>
  5610. </td>
  5611. </tr><tr><td><p>0</p></td>
  5612. <td><p>Ready indicates that the client is confgured correctly
  5613. and can be used.</p>
  5614. </td>
  5615. </tr><tr><td><p>1</p></td>
  5616. <td><p>Unknown indicates that the client can be used
  5617. but information is missing and it can not be validated.</p>
  5618. </td>
  5619. </tr></tbody>
  5620. </table>
  5621. <h3 id="external-secrets.io/v1beta1.VaultAppRole">VaultAppRole
  5622. </h3>
  5623. <p>
  5624. (<em>Appears on:</em>
  5625. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  5626. </p>
  5627. <p>
  5628. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  5629. with the role and secret stored in a Kubernetes Secret resource.</p>
  5630. </p>
  5631. <table>
  5632. <thead>
  5633. <tr>
  5634. <th>Field</th>
  5635. <th>Description</th>
  5636. </tr>
  5637. </thead>
  5638. <tbody>
  5639. <tr>
  5640. <td>
  5641. <code>path</code></br>
  5642. <em>
  5643. string
  5644. </em>
  5645. </td>
  5646. <td>
  5647. <p>Path where the App Role authentication backend is mounted
  5648. in Vault, e.g: &ldquo;approle&rdquo;</p>
  5649. </td>
  5650. </tr>
  5651. <tr>
  5652. <td>
  5653. <code>roleId</code></br>
  5654. <em>
  5655. string
  5656. </em>
  5657. </td>
  5658. <td>
  5659. <p>RoleID configured in the App Role authentication backend when setting
  5660. up the authentication backend in Vault.</p>
  5661. </td>
  5662. </tr>
  5663. <tr>
  5664. <td>
  5665. <code>secretRef</code></br>
  5666. <em>
  5667. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5668. External Secrets meta/v1.SecretKeySelector
  5669. </a>
  5670. </em>
  5671. </td>
  5672. <td>
  5673. <p>Reference to a key in a Secret that contains the App Role secret used
  5674. to authenticate with Vault.
  5675. The <code>key</code> field must be specified and denotes which entry within the Secret
  5676. resource is used as the app role secret.</p>
  5677. </td>
  5678. </tr>
  5679. </tbody>
  5680. </table>
  5681. <h3 id="external-secrets.io/v1beta1.VaultAuth">VaultAuth
  5682. </h3>
  5683. <p>
  5684. (<em>Appears on:</em>
  5685. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  5686. </p>
  5687. <p>
  5688. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  5689. Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>jwt</code> or <code>cert</code>
  5690. can be specified.</p>
  5691. </p>
  5692. <table>
  5693. <thead>
  5694. <tr>
  5695. <th>Field</th>
  5696. <th>Description</th>
  5697. </tr>
  5698. </thead>
  5699. <tbody>
  5700. <tr>
  5701. <td>
  5702. <code>tokenSecretRef</code></br>
  5703. <em>
  5704. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5705. External Secrets meta/v1.SecretKeySelector
  5706. </a>
  5707. </em>
  5708. </td>
  5709. <td>
  5710. <em>(Optional)</em>
  5711. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  5712. </td>
  5713. </tr>
  5714. <tr>
  5715. <td>
  5716. <code>appRole</code></br>
  5717. <em>
  5718. <a href="#external-secrets.io/v1beta1.VaultAppRole">
  5719. VaultAppRole
  5720. </a>
  5721. </em>
  5722. </td>
  5723. <td>
  5724. <em>(Optional)</em>
  5725. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  5726. with the role and secret stored in a Kubernetes Secret resource.</p>
  5727. </td>
  5728. </tr>
  5729. <tr>
  5730. <td>
  5731. <code>kubernetes</code></br>
  5732. <em>
  5733. <a href="#external-secrets.io/v1beta1.VaultKubernetesAuth">
  5734. VaultKubernetesAuth
  5735. </a>
  5736. </em>
  5737. </td>
  5738. <td>
  5739. <em>(Optional)</em>
  5740. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  5741. token stored in the named Secret resource to the Vault server.</p>
  5742. </td>
  5743. </tr>
  5744. <tr>
  5745. <td>
  5746. <code>ldap</code></br>
  5747. <em>
  5748. <a href="#external-secrets.io/v1beta1.VaultLdapAuth">
  5749. VaultLdapAuth
  5750. </a>
  5751. </em>
  5752. </td>
  5753. <td>
  5754. <em>(Optional)</em>
  5755. <p>Ldap authenticates with Vault by passing username/password pair using
  5756. the LDAP authentication method</p>
  5757. </td>
  5758. </tr>
  5759. <tr>
  5760. <td>
  5761. <code>jwt</code></br>
  5762. <em>
  5763. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">
  5764. VaultJwtAuth
  5765. </a>
  5766. </em>
  5767. </td>
  5768. <td>
  5769. <em>(Optional)</em>
  5770. <p>Jwt authenticates with Vault by passing role and JWT token using the
  5771. JWT/OIDC authentication method</p>
  5772. </td>
  5773. </tr>
  5774. <tr>
  5775. <td>
  5776. <code>cert</code></br>
  5777. <em>
  5778. <a href="#external-secrets.io/v1beta1.VaultCertAuth">
  5779. VaultCertAuth
  5780. </a>
  5781. </em>
  5782. </td>
  5783. <td>
  5784. <em>(Optional)</em>
  5785. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  5786. Cert authentication method</p>
  5787. </td>
  5788. </tr>
  5789. </tbody>
  5790. </table>
  5791. <h3 id="external-secrets.io/v1beta1.VaultCertAuth">VaultCertAuth
  5792. </h3>
  5793. <p>
  5794. (<em>Appears on:</em>
  5795. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  5796. </p>
  5797. <p>
  5798. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  5799. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  5800. </p>
  5801. <table>
  5802. <thead>
  5803. <tr>
  5804. <th>Field</th>
  5805. <th>Description</th>
  5806. </tr>
  5807. </thead>
  5808. <tbody>
  5809. <tr>
  5810. <td>
  5811. <code>clientCert</code></br>
  5812. <em>
  5813. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5814. External Secrets meta/v1.SecretKeySelector
  5815. </a>
  5816. </em>
  5817. </td>
  5818. <td>
  5819. <em>(Optional)</em>
  5820. <p>ClientCert is a certificate to authenticate using the Cert Vault
  5821. authentication method</p>
  5822. </td>
  5823. </tr>
  5824. <tr>
  5825. <td>
  5826. <code>secretRef</code></br>
  5827. <em>
  5828. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5829. External Secrets meta/v1.SecretKeySelector
  5830. </a>
  5831. </em>
  5832. </td>
  5833. <td>
  5834. <p>SecretRef to a key in a Secret resource containing client private key to
  5835. authenticate with Vault using the Cert authentication method</p>
  5836. </td>
  5837. </tr>
  5838. </tbody>
  5839. </table>
  5840. <h3 id="external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth
  5841. </h3>
  5842. <p>
  5843. (<em>Appears on:</em>
  5844. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  5845. </p>
  5846. <p>
  5847. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  5848. method, with the role name and a token stored in a Kubernetes Secret resource or
  5849. a Kubernetes service account token retrieved via <code>TokenRequest</code>.</p>
  5850. </p>
  5851. <table>
  5852. <thead>
  5853. <tr>
  5854. <th>Field</th>
  5855. <th>Description</th>
  5856. </tr>
  5857. </thead>
  5858. <tbody>
  5859. <tr>
  5860. <td>
  5861. <code>path</code></br>
  5862. <em>
  5863. string
  5864. </em>
  5865. </td>
  5866. <td>
  5867. <p>Path where the JWT authentication backend is mounted
  5868. in Vault, e.g: &ldquo;jwt&rdquo;</p>
  5869. </td>
  5870. </tr>
  5871. <tr>
  5872. <td>
  5873. <code>role</code></br>
  5874. <em>
  5875. string
  5876. </em>
  5877. </td>
  5878. <td>
  5879. <em>(Optional)</em>
  5880. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  5881. authentication method</p>
  5882. </td>
  5883. </tr>
  5884. <tr>
  5885. <td>
  5886. <code>secretRef</code></br>
  5887. <em>
  5888. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5889. External Secrets meta/v1.SecretKeySelector
  5890. </a>
  5891. </em>
  5892. </td>
  5893. <td>
  5894. <em>(Optional)</em>
  5895. <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  5896. authenticate with Vault using the JWT/OIDC authentication method.</p>
  5897. </td>
  5898. </tr>
  5899. <tr>
  5900. <td>
  5901. <code>kubernetesServiceAccountToken</code></br>
  5902. <em>
  5903. <a href="#external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">
  5904. VaultKubernetesServiceAccountTokenAuth
  5905. </a>
  5906. </em>
  5907. </td>
  5908. <td>
  5909. <em>(Optional)</em>
  5910. <p>Optional ServiceAccountToken specifies the Kubernetes service account for which to request
  5911. a token for with the <code>TokenRequest</code> API.</p>
  5912. </td>
  5913. </tr>
  5914. </tbody>
  5915. </table>
  5916. <h3 id="external-secrets.io/v1beta1.VaultKVStoreVersion">VaultKVStoreVersion
  5917. (<code>string</code> alias)</p></h3>
  5918. <p>
  5919. (<em>Appears on:</em>
  5920. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  5921. </p>
  5922. <p>
  5923. </p>
  5924. <table>
  5925. <thead>
  5926. <tr>
  5927. <th>Value</th>
  5928. <th>Description</th>
  5929. </tr>
  5930. </thead>
  5931. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  5932. <td></td>
  5933. </tr><tr><td><p>&#34;v2&#34;</p></td>
  5934. <td></td>
  5935. </tr></tbody>
  5936. </table>
  5937. <h3 id="external-secrets.io/v1beta1.VaultKubernetesAuth">VaultKubernetesAuth
  5938. </h3>
  5939. <p>
  5940. (<em>Appears on:</em>
  5941. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  5942. </p>
  5943. <p>
  5944. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  5945. a Secret.</p>
  5946. </p>
  5947. <table>
  5948. <thead>
  5949. <tr>
  5950. <th>Field</th>
  5951. <th>Description</th>
  5952. </tr>
  5953. </thead>
  5954. <tbody>
  5955. <tr>
  5956. <td>
  5957. <code>mountPath</code></br>
  5958. <em>
  5959. string
  5960. </em>
  5961. </td>
  5962. <td>
  5963. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  5964. &ldquo;kubernetes&rdquo;</p>
  5965. </td>
  5966. </tr>
  5967. <tr>
  5968. <td>
  5969. <code>serviceAccountRef</code></br>
  5970. <em>
  5971. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  5972. External Secrets meta/v1.ServiceAccountSelector
  5973. </a>
  5974. </em>
  5975. </td>
  5976. <td>
  5977. <em>(Optional)</em>
  5978. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  5979. If the service account is specified, the service account secret token JWT will be used
  5980. for authenticating with Vault. If the service account selector is not supplied,
  5981. the secretRef will be used instead.</p>
  5982. </td>
  5983. </tr>
  5984. <tr>
  5985. <td>
  5986. <code>secretRef</code></br>
  5987. <em>
  5988. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5989. External Secrets meta/v1.SecretKeySelector
  5990. </a>
  5991. </em>
  5992. </td>
  5993. <td>
  5994. <em>(Optional)</em>
  5995. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  5996. for authenticating with Vault. If a name is specified without a key,
  5997. <code>token</code> is the default. If one is not specified, the one bound to
  5998. the controller will be used.</p>
  5999. </td>
  6000. </tr>
  6001. <tr>
  6002. <td>
  6003. <code>role</code></br>
  6004. <em>
  6005. string
  6006. </em>
  6007. </td>
  6008. <td>
  6009. <p>A required field containing the Vault Role to assume. A Role binds a
  6010. Kubernetes ServiceAccount with a set of Vault policies.</p>
  6011. </td>
  6012. </tr>
  6013. </tbody>
  6014. </table>
  6015. <h3 id="external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">VaultKubernetesServiceAccountTokenAuth
  6016. </h3>
  6017. <p>
  6018. (<em>Appears on:</em>
  6019. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth</a>)
  6020. </p>
  6021. <p>
  6022. <p>VaultKubernetesServiceAccountTokenAuth authenticates with Vault using a temporary
  6023. Kubernetes service account token retrieved by the <code>TokenRequest</code> API.</p>
  6024. </p>
  6025. <table>
  6026. <thead>
  6027. <tr>
  6028. <th>Field</th>
  6029. <th>Description</th>
  6030. </tr>
  6031. </thead>
  6032. <tbody>
  6033. <tr>
  6034. <td>
  6035. <code>serviceAccountRef</code></br>
  6036. <em>
  6037. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  6038. External Secrets meta/v1.ServiceAccountSelector
  6039. </a>
  6040. </em>
  6041. </td>
  6042. <td>
  6043. <p>Service account field containing the name of a kubernetes ServiceAccount.</p>
  6044. </td>
  6045. </tr>
  6046. <tr>
  6047. <td>
  6048. <code>audiences</code></br>
  6049. <em>
  6050. []string
  6051. </em>
  6052. </td>
  6053. <td>
  6054. <em>(Optional)</em>
  6055. <p>Optional audiences field that will be used to request a temporary Kubernetes service
  6056. account token for the service account referenced by <code>serviceAccountRef</code>.
  6057. Defaults to a single audience <code>vault</code> it not specified.
  6058. Deprecated: use serviceAccountRef.Audiences instead</p>
  6059. </td>
  6060. </tr>
  6061. <tr>
  6062. <td>
  6063. <code>expirationSeconds</code></br>
  6064. <em>
  6065. int64
  6066. </em>
  6067. </td>
  6068. <td>
  6069. <em>(Optional)</em>
  6070. <p>Optional expiration time in seconds that will be used to request a temporary
  6071. Kubernetes service account token for the service account referenced by
  6072. <code>serviceAccountRef</code>.
  6073. Deprecated: this will be removed in the future.
  6074. Defaults to 10 minutes.</p>
  6075. </td>
  6076. </tr>
  6077. </tbody>
  6078. </table>
  6079. <h3 id="external-secrets.io/v1beta1.VaultLdapAuth">VaultLdapAuth
  6080. </h3>
  6081. <p>
  6082. (<em>Appears on:</em>
  6083. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  6084. </p>
  6085. <p>
  6086. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  6087. with the username and password stored in a Kubernetes Secret resource.</p>
  6088. </p>
  6089. <table>
  6090. <thead>
  6091. <tr>
  6092. <th>Field</th>
  6093. <th>Description</th>
  6094. </tr>
  6095. </thead>
  6096. <tbody>
  6097. <tr>
  6098. <td>
  6099. <code>path</code></br>
  6100. <em>
  6101. string
  6102. </em>
  6103. </td>
  6104. <td>
  6105. <p>Path where the LDAP authentication backend is mounted
  6106. in Vault, e.g: &ldquo;ldap&rdquo;</p>
  6107. </td>
  6108. </tr>
  6109. <tr>
  6110. <td>
  6111. <code>username</code></br>
  6112. <em>
  6113. string
  6114. </em>
  6115. </td>
  6116. <td>
  6117. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  6118. authentication method</p>
  6119. </td>
  6120. </tr>
  6121. <tr>
  6122. <td>
  6123. <code>secretRef</code></br>
  6124. <em>
  6125. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6126. External Secrets meta/v1.SecretKeySelector
  6127. </a>
  6128. </em>
  6129. </td>
  6130. <td>
  6131. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  6132. user used to authenticate with Vault using the LDAP authentication
  6133. method</p>
  6134. </td>
  6135. </tr>
  6136. </tbody>
  6137. </table>
  6138. <h3 id="external-secrets.io/v1beta1.VaultProvider">VaultProvider
  6139. </h3>
  6140. <p>
  6141. (<em>Appears on:</em>
  6142. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6143. </p>
  6144. <p>
  6145. <p>Configures an store to sync secrets using a HashiCorp Vault
  6146. KV backend.</p>
  6147. </p>
  6148. <table>
  6149. <thead>
  6150. <tr>
  6151. <th>Field</th>
  6152. <th>Description</th>
  6153. </tr>
  6154. </thead>
  6155. <tbody>
  6156. <tr>
  6157. <td>
  6158. <code>auth</code></br>
  6159. <em>
  6160. <a href="#external-secrets.io/v1beta1.VaultAuth">
  6161. VaultAuth
  6162. </a>
  6163. </em>
  6164. </td>
  6165. <td>
  6166. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  6167. </td>
  6168. </tr>
  6169. <tr>
  6170. <td>
  6171. <code>server</code></br>
  6172. <em>
  6173. string
  6174. </em>
  6175. </td>
  6176. <td>
  6177. <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>
  6178. </td>
  6179. </tr>
  6180. <tr>
  6181. <td>
  6182. <code>path</code></br>
  6183. <em>
  6184. string
  6185. </em>
  6186. </td>
  6187. <td>
  6188. <em>(Optional)</em>
  6189. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  6190. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  6191. for fetching secrets from Vault is optional and will be appended
  6192. if not present in specified path.</p>
  6193. </td>
  6194. </tr>
  6195. <tr>
  6196. <td>
  6197. <code>version</code></br>
  6198. <em>
  6199. <a href="#external-secrets.io/v1beta1.VaultKVStoreVersion">
  6200. VaultKVStoreVersion
  6201. </a>
  6202. </em>
  6203. </td>
  6204. <td>
  6205. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  6206. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  6207. </td>
  6208. </tr>
  6209. <tr>
  6210. <td>
  6211. <code>namespace</code></br>
  6212. <em>
  6213. string
  6214. </em>
  6215. </td>
  6216. <td>
  6217. <em>(Optional)</em>
  6218. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  6219. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  6220. 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>
  6221. </td>
  6222. </tr>
  6223. <tr>
  6224. <td>
  6225. <code>caBundle</code></br>
  6226. <em>
  6227. []byte
  6228. </em>
  6229. </td>
  6230. <td>
  6231. <em>(Optional)</em>
  6232. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  6233. if the Server URL is using HTTPS protocol. This parameter is ignored for
  6234. plain HTTP protocol connection. If not set the system root certificates
  6235. are used to validate the TLS connection.</p>
  6236. </td>
  6237. </tr>
  6238. <tr>
  6239. <td>
  6240. <code>caProvider</code></br>
  6241. <em>
  6242. <a href="#external-secrets.io/v1beta1.CAProvider">
  6243. CAProvider
  6244. </a>
  6245. </em>
  6246. </td>
  6247. <td>
  6248. <em>(Optional)</em>
  6249. <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
  6250. </td>
  6251. </tr>
  6252. <tr>
  6253. <td>
  6254. <code>readYourWrites</code></br>
  6255. <em>
  6256. bool
  6257. </em>
  6258. </td>
  6259. <td>
  6260. <em>(Optional)</em>
  6261. <p>ReadYourWrites ensures isolated read-after-write semantics by
  6262. providing discovered cluster replication states in each request.
  6263. More information about eventual consistency in Vault can be found here
  6264. <a href="https://www.vaultproject.io/docs/enterprise/consistency">https://www.vaultproject.io/docs/enterprise/consistency</a></p>
  6265. </td>
  6266. </tr>
  6267. <tr>
  6268. <td>
  6269. <code>forwardInconsistent</code></br>
  6270. <em>
  6271. bool
  6272. </em>
  6273. </td>
  6274. <td>
  6275. <em>(Optional)</em>
  6276. <p>ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
  6277. leader instead of simply retrying within a loop. This can increase performance if
  6278. the option is enabled serverside.
  6279. <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>
  6280. </td>
  6281. </tr>
  6282. </tbody>
  6283. </table>
  6284. <h3 id="external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider
  6285. </h3>
  6286. <p>
  6287. (<em>Appears on:</em>
  6288. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  6289. </p>
  6290. <p>
  6291. <p>Defines a location to fetch the cert for the webhook provider from.</p>
  6292. </p>
  6293. <table>
  6294. <thead>
  6295. <tr>
  6296. <th>Field</th>
  6297. <th>Description</th>
  6298. </tr>
  6299. </thead>
  6300. <tbody>
  6301. <tr>
  6302. <td>
  6303. <code>type</code></br>
  6304. <em>
  6305. <a href="#external-secrets.io/v1beta1.WebhookCAProviderType">
  6306. WebhookCAProviderType
  6307. </a>
  6308. </em>
  6309. </td>
  6310. <td>
  6311. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  6312. </td>
  6313. </tr>
  6314. <tr>
  6315. <td>
  6316. <code>name</code></br>
  6317. <em>
  6318. string
  6319. </em>
  6320. </td>
  6321. <td>
  6322. <p>The name of the object located at the provider type.</p>
  6323. </td>
  6324. </tr>
  6325. <tr>
  6326. <td>
  6327. <code>key</code></br>
  6328. <em>
  6329. string
  6330. </em>
  6331. </td>
  6332. <td>
  6333. <p>The key the value inside of the provider type to use, only used with &ldquo;Secret&rdquo; type</p>
  6334. </td>
  6335. </tr>
  6336. <tr>
  6337. <td>
  6338. <code>namespace</code></br>
  6339. <em>
  6340. string
  6341. </em>
  6342. </td>
  6343. <td>
  6344. <em>(Optional)</em>
  6345. <p>The namespace the Provider type is in.</p>
  6346. </td>
  6347. </tr>
  6348. </tbody>
  6349. </table>
  6350. <h3 id="external-secrets.io/v1beta1.WebhookCAProviderType">WebhookCAProviderType
  6351. (<code>string</code> alias)</p></h3>
  6352. <p>
  6353. (<em>Appears on:</em>
  6354. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider</a>)
  6355. </p>
  6356. <p>
  6357. </p>
  6358. <table>
  6359. <thead>
  6360. <tr>
  6361. <th>Value</th>
  6362. <th>Description</th>
  6363. </tr>
  6364. </thead>
  6365. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  6366. <td></td>
  6367. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  6368. <td></td>
  6369. </tr></tbody>
  6370. </table>
  6371. <h3 id="external-secrets.io/v1beta1.WebhookProvider">WebhookProvider
  6372. </h3>
  6373. <p>
  6374. (<em>Appears on:</em>
  6375. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6376. </p>
  6377. <p>
  6378. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  6379. </p>
  6380. <table>
  6381. <thead>
  6382. <tr>
  6383. <th>Field</th>
  6384. <th>Description</th>
  6385. </tr>
  6386. </thead>
  6387. <tbody>
  6388. <tr>
  6389. <td>
  6390. <code>method</code></br>
  6391. <em>
  6392. string
  6393. </em>
  6394. </td>
  6395. <td>
  6396. <p>Webhook Method</p>
  6397. </td>
  6398. </tr>
  6399. <tr>
  6400. <td>
  6401. <code>url</code></br>
  6402. <em>
  6403. string
  6404. </em>
  6405. </td>
  6406. <td>
  6407. <p>Webhook url to call</p>
  6408. </td>
  6409. </tr>
  6410. <tr>
  6411. <td>
  6412. <code>headers</code></br>
  6413. <em>
  6414. map[string]string
  6415. </em>
  6416. </td>
  6417. <td>
  6418. <em>(Optional)</em>
  6419. <p>Headers</p>
  6420. </td>
  6421. </tr>
  6422. <tr>
  6423. <td>
  6424. <code>body</code></br>
  6425. <em>
  6426. string
  6427. </em>
  6428. </td>
  6429. <td>
  6430. <em>(Optional)</em>
  6431. <p>Body</p>
  6432. </td>
  6433. </tr>
  6434. <tr>
  6435. <td>
  6436. <code>timeout</code></br>
  6437. <em>
  6438. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  6439. Kubernetes meta/v1.Duration
  6440. </a>
  6441. </em>
  6442. </td>
  6443. <td>
  6444. <em>(Optional)</em>
  6445. <p>Timeout</p>
  6446. </td>
  6447. </tr>
  6448. <tr>
  6449. <td>
  6450. <code>result</code></br>
  6451. <em>
  6452. <a href="#external-secrets.io/v1beta1.WebhookResult">
  6453. WebhookResult
  6454. </a>
  6455. </em>
  6456. </td>
  6457. <td>
  6458. <p>Result formatting</p>
  6459. </td>
  6460. </tr>
  6461. <tr>
  6462. <td>
  6463. <code>secrets</code></br>
  6464. <em>
  6465. <a href="#external-secrets.io/v1beta1.WebhookSecret">
  6466. []WebhookSecret
  6467. </a>
  6468. </em>
  6469. </td>
  6470. <td>
  6471. <em>(Optional)</em>
  6472. <p>Secrets to fill in templates
  6473. These secrets will be passed to the templating function as key value pairs under the given name</p>
  6474. </td>
  6475. </tr>
  6476. <tr>
  6477. <td>
  6478. <code>caBundle</code></br>
  6479. <em>
  6480. []byte
  6481. </em>
  6482. </td>
  6483. <td>
  6484. <em>(Optional)</em>
  6485. <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
  6486. if the Server URL is using HTTPS protocol. This parameter is ignored for
  6487. plain HTTP protocol connection. If not set the system root certificates
  6488. are used to validate the TLS connection.</p>
  6489. </td>
  6490. </tr>
  6491. <tr>
  6492. <td>
  6493. <code>caProvider</code></br>
  6494. <em>
  6495. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">
  6496. WebhookCAProvider
  6497. </a>
  6498. </em>
  6499. </td>
  6500. <td>
  6501. <em>(Optional)</em>
  6502. <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
  6503. </td>
  6504. </tr>
  6505. </tbody>
  6506. </table>
  6507. <h3 id="external-secrets.io/v1beta1.WebhookResult">WebhookResult
  6508. </h3>
  6509. <p>
  6510. (<em>Appears on:</em>
  6511. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  6512. </p>
  6513. <p>
  6514. </p>
  6515. <table>
  6516. <thead>
  6517. <tr>
  6518. <th>Field</th>
  6519. <th>Description</th>
  6520. </tr>
  6521. </thead>
  6522. <tbody>
  6523. <tr>
  6524. <td>
  6525. <code>jsonPath</code></br>
  6526. <em>
  6527. string
  6528. </em>
  6529. </td>
  6530. <td>
  6531. <em>(Optional)</em>
  6532. <p>Json path of return value</p>
  6533. </td>
  6534. </tr>
  6535. </tbody>
  6536. </table>
  6537. <h3 id="external-secrets.io/v1beta1.WebhookSecret">WebhookSecret
  6538. </h3>
  6539. <p>
  6540. (<em>Appears on:</em>
  6541. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  6542. </p>
  6543. <p>
  6544. </p>
  6545. <table>
  6546. <thead>
  6547. <tr>
  6548. <th>Field</th>
  6549. <th>Description</th>
  6550. </tr>
  6551. </thead>
  6552. <tbody>
  6553. <tr>
  6554. <td>
  6555. <code>name</code></br>
  6556. <em>
  6557. string
  6558. </em>
  6559. </td>
  6560. <td>
  6561. <p>Name of this secret in templates</p>
  6562. </td>
  6563. </tr>
  6564. <tr>
  6565. <td>
  6566. <code>secretRef</code></br>
  6567. <em>
  6568. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6569. External Secrets meta/v1.SecretKeySelector
  6570. </a>
  6571. </em>
  6572. </td>
  6573. <td>
  6574. <p>Secret ref to fill in credentials</p>
  6575. </td>
  6576. </tr>
  6577. </tbody>
  6578. </table>
  6579. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerAuth">YandexCertificateManagerAuth
  6580. </h3>
  6581. <p>
  6582. (<em>Appears on:</em>
  6583. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  6584. </p>
  6585. <p>
  6586. </p>
  6587. <table>
  6588. <thead>
  6589. <tr>
  6590. <th>Field</th>
  6591. <th>Description</th>
  6592. </tr>
  6593. </thead>
  6594. <tbody>
  6595. <tr>
  6596. <td>
  6597. <code>authorizedKeySecretRef</code></br>
  6598. <em>
  6599. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6600. External Secrets meta/v1.SecretKeySelector
  6601. </a>
  6602. </em>
  6603. </td>
  6604. <td>
  6605. <em>(Optional)</em>
  6606. <p>The authorized key used for authentication</p>
  6607. </td>
  6608. </tr>
  6609. </tbody>
  6610. </table>
  6611. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">YandexCertificateManagerCAProvider
  6612. </h3>
  6613. <p>
  6614. (<em>Appears on:</em>
  6615. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  6616. </p>
  6617. <p>
  6618. </p>
  6619. <table>
  6620. <thead>
  6621. <tr>
  6622. <th>Field</th>
  6623. <th>Description</th>
  6624. </tr>
  6625. </thead>
  6626. <tbody>
  6627. <tr>
  6628. <td>
  6629. <code>certSecretRef</code></br>
  6630. <em>
  6631. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6632. External Secrets meta/v1.SecretKeySelector
  6633. </a>
  6634. </em>
  6635. </td>
  6636. <td>
  6637. </td>
  6638. </tr>
  6639. </tbody>
  6640. </table>
  6641. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider
  6642. </h3>
  6643. <p>
  6644. (<em>Appears on:</em>
  6645. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6646. </p>
  6647. <p>
  6648. <p>YandexCertificateManagerProvider Configures a store to sync secrets using the Yandex Certificate Manager provider.</p>
  6649. </p>
  6650. <table>
  6651. <thead>
  6652. <tr>
  6653. <th>Field</th>
  6654. <th>Description</th>
  6655. </tr>
  6656. </thead>
  6657. <tbody>
  6658. <tr>
  6659. <td>
  6660. <code>apiEndpoint</code></br>
  6661. <em>
  6662. string
  6663. </em>
  6664. </td>
  6665. <td>
  6666. <em>(Optional)</em>
  6667. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  6668. </td>
  6669. </tr>
  6670. <tr>
  6671. <td>
  6672. <code>auth</code></br>
  6673. <em>
  6674. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerAuth">
  6675. YandexCertificateManagerAuth
  6676. </a>
  6677. </em>
  6678. </td>
  6679. <td>
  6680. <p>Auth defines the information necessary to authenticate against Yandex Certificate Manager</p>
  6681. </td>
  6682. </tr>
  6683. <tr>
  6684. <td>
  6685. <code>caProvider</code></br>
  6686. <em>
  6687. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">
  6688. YandexCertificateManagerCAProvider
  6689. </a>
  6690. </em>
  6691. </td>
  6692. <td>
  6693. <em>(Optional)</em>
  6694. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  6695. </td>
  6696. </tr>
  6697. </tbody>
  6698. </table>
  6699. <h3 id="external-secrets.io/v1beta1.YandexLockboxAuth">YandexLockboxAuth
  6700. </h3>
  6701. <p>
  6702. (<em>Appears on:</em>
  6703. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  6704. </p>
  6705. <p>
  6706. </p>
  6707. <table>
  6708. <thead>
  6709. <tr>
  6710. <th>Field</th>
  6711. <th>Description</th>
  6712. </tr>
  6713. </thead>
  6714. <tbody>
  6715. <tr>
  6716. <td>
  6717. <code>authorizedKeySecretRef</code></br>
  6718. <em>
  6719. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6720. External Secrets meta/v1.SecretKeySelector
  6721. </a>
  6722. </em>
  6723. </td>
  6724. <td>
  6725. <em>(Optional)</em>
  6726. <p>The authorized key used for authentication</p>
  6727. </td>
  6728. </tr>
  6729. </tbody>
  6730. </table>
  6731. <h3 id="external-secrets.io/v1beta1.YandexLockboxCAProvider">YandexLockboxCAProvider
  6732. </h3>
  6733. <p>
  6734. (<em>Appears on:</em>
  6735. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  6736. </p>
  6737. <p>
  6738. </p>
  6739. <table>
  6740. <thead>
  6741. <tr>
  6742. <th>Field</th>
  6743. <th>Description</th>
  6744. </tr>
  6745. </thead>
  6746. <tbody>
  6747. <tr>
  6748. <td>
  6749. <code>certSecretRef</code></br>
  6750. <em>
  6751. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6752. External Secrets meta/v1.SecretKeySelector
  6753. </a>
  6754. </em>
  6755. </td>
  6756. <td>
  6757. </td>
  6758. </tr>
  6759. </tbody>
  6760. </table>
  6761. <h3 id="external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider
  6762. </h3>
  6763. <p>
  6764. (<em>Appears on:</em>
  6765. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6766. </p>
  6767. <p>
  6768. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
  6769. </p>
  6770. <table>
  6771. <thead>
  6772. <tr>
  6773. <th>Field</th>
  6774. <th>Description</th>
  6775. </tr>
  6776. </thead>
  6777. <tbody>
  6778. <tr>
  6779. <td>
  6780. <code>apiEndpoint</code></br>
  6781. <em>
  6782. string
  6783. </em>
  6784. </td>
  6785. <td>
  6786. <em>(Optional)</em>
  6787. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  6788. </td>
  6789. </tr>
  6790. <tr>
  6791. <td>
  6792. <code>auth</code></br>
  6793. <em>
  6794. <a href="#external-secrets.io/v1beta1.YandexLockboxAuth">
  6795. YandexLockboxAuth
  6796. </a>
  6797. </em>
  6798. </td>
  6799. <td>
  6800. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
  6801. </td>
  6802. </tr>
  6803. <tr>
  6804. <td>
  6805. <code>caProvider</code></br>
  6806. <em>
  6807. <a href="#external-secrets.io/v1beta1.YandexLockboxCAProvider">
  6808. YandexLockboxCAProvider
  6809. </a>
  6810. </em>
  6811. </td>
  6812. <td>
  6813. <em>(Optional)</em>
  6814. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  6815. </td>
  6816. </tr>
  6817. </tbody>
  6818. </table>
  6819. <hr/>
  6820. <p><em>
  6821. Generated with <code>gen-crd-api-reference-docs</code>.
  6822. </em></p>
  6823. </article>
  6824. </div>
  6825. </div>
  6826. </main>
  6827. <footer class="md-footer">
  6828. <nav class="md-footer__inner md-grid" aria-label="Footer">
  6829. <a href="../generator/fake/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Fake" rel="prev">
  6830. <div class="md-footer__button md-icon">
  6831. <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>
  6832. </div>
  6833. <div class="md-footer__title">
  6834. <div class="md-ellipsis">
  6835. <span class="md-footer__direction">
  6836. Previous
  6837. </span>
  6838. Fake
  6839. </div>
  6840. </div>
  6841. </a>
  6842. <a href="../controller-options/" class="md-footer__link md-footer__link--next" aria-label="Next: Controller Options" rel="next">
  6843. <div class="md-footer__title">
  6844. <div class="md-ellipsis">
  6845. <span class="md-footer__direction">
  6846. Next
  6847. </span>
  6848. Controller Options
  6849. </div>
  6850. </div>
  6851. <div class="md-footer__button md-icon">
  6852. <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>
  6853. </div>
  6854. </a>
  6855. </nav>
  6856. <div class="md-footer-meta md-typeset">
  6857. <div class="md-footer-meta__inner md-grid">
  6858. <div class="md-copyright">
  6859. <div class="md-copyright__highlight">
  6860. &copy; 2022 The external-secrets Authors.<br/>
  6861. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  6862. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  6863. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  6864. </div>
  6865. Made with
  6866. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  6867. Material for MkDocs
  6868. </a>
  6869. </div>
  6870. </div>
  6871. </div>
  6872. </footer>
  6873. </div>
  6874. <div class="md-dialog" data-md-component="dialog">
  6875. <div class="md-dialog__inner md-typeset"></div>
  6876. </div>
  6877. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "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>
  6878. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  6879. </body>
  6880. </html>