index.html 148 KB

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