index.html 167 KB

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