index.html 147 KB

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