index.html 234 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029
  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/uuid/">
  7. <link rel="next" href="../controller-options/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.45">
  10. <title>API specification - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.0253249f.min.css">
  12. <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
  13. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  14. <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">
  15. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  16. <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>
  17. <script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-QP38TD8K7V",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  18. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  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. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  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 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></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. <form class="md-header__option" data-md-component="palette">
  62. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
  63. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  64. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  65. </label>
  66. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  67. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  68. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  69. </label>
  70. </form>
  71. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  72. <label class="md-header__button md-icon" for="__search">
  73. <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.52 6.52 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 5"/></svg>
  74. </label>
  75. <div class="md-search" data-md-component="search" role="dialog">
  76. <label class="md-search__overlay" for="__search"></label>
  77. <div class="md-search__inner" role="search">
  78. <form class="md-search__form" name="search">
  79. <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>
  80. <label class="md-search__icon md-icon" for="__search">
  81. <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.52 6.52 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 5"/></svg>
  82. <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 11z"/></svg>
  83. </label>
  84. <nav class="md-search__options" aria-label="Search">
  85. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  86. <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 12z"/></svg>
  87. </button>
  88. </nav>
  89. </form>
  90. <div class="md-search__output">
  91. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  92. <div class="md-search-result" data-md-component="search-result">
  93. <div class="md-search-result__meta">
  94. Initializing search
  95. </div>
  96. <ol class="md-search-result__list" role="presentation"></ol>
  97. </div>
  98. </div>
  99. </div>
  100. </div>
  101. </div>
  102. <div class="md-header__source">
  103. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  104. <div class="md-source__icon md-icon">
  105. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.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 2024 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.81"/></svg>
  106. </div>
  107. <div class="md-source__repository">
  108. External Secrets Operator
  109. </div>
  110. </a>
  111. </div>
  112. </nav>
  113. </header>
  114. <div class="md-container" data-md-component="container">
  115. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  116. <div class="md-grid">
  117. <ul class="md-tabs__list">
  118. <li class="md-tabs__item">
  119. <a href="../.." class="md-tabs__link">
  120. Introduction
  121. </a>
  122. </li>
  123. <li class="md-tabs__item md-tabs__item--active">
  124. <a href="../components/" class="md-tabs__link">
  125. API
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="../../guides/introduction/" class="md-tabs__link">
  130. Guides
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  135. Provider
  136. </a>
  137. </li>
  138. <li class="md-tabs__item">
  139. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  140. Examples
  141. </a>
  142. </li>
  143. <li class="md-tabs__item">
  144. <a href="../../contributing/devguide/" class="md-tabs__link">
  145. Community
  146. </a>
  147. </li>
  148. </ul>
  149. </div>
  150. </nav>
  151. <main class="md-main" data-md-component="main">
  152. <div class="md-main__inner md-grid">
  153. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  154. <div class="md-sidebar__scrollwrap">
  155. <div class="md-sidebar__inner">
  156. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  157. <label class="md-nav__title" for="__drawer">
  158. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  159. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  160. </a>
  161. External Secrets Operator
  162. </label>
  163. <div class="md-nav__source">
  164. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  165. <div class="md-source__icon md-icon">
  166. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.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 2024 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.81"/></svg>
  167. </div>
  168. <div class="md-source__repository">
  169. External Secrets Operator
  170. </div>
  171. </a>
  172. </div>
  173. <ul class="md-nav__list" data-md-scrollfix>
  174. <li class="md-nav__item md-nav__item--nested">
  175. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  176. <div class="md-nav__link md-nav__container">
  177. <a href="../.." class="md-nav__link ">
  178. <span class="md-ellipsis">
  179. Introduction
  180. </span>
  181. </a>
  182. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  183. <span class="md-nav__icon md-icon"></span>
  184. </label>
  185. </div>
  186. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  187. <label class="md-nav__title" for="__nav_1">
  188. <span class="md-nav__icon md-icon"></span>
  189. Introduction
  190. </label>
  191. <ul class="md-nav__list" data-md-scrollfix>
  192. <li class="md-nav__item">
  193. <a href="../../introduction/overview/" class="md-nav__link">
  194. <span class="md-ellipsis">
  195. Overview
  196. </span>
  197. </a>
  198. </li>
  199. <li class="md-nav__item">
  200. <a href="../../introduction/getting-started/" class="md-nav__link">
  201. <span class="md-ellipsis">
  202. Getting started
  203. </span>
  204. </a>
  205. </li>
  206. <li class="md-nav__item">
  207. <a href="../../introduction/faq/" class="md-nav__link">
  208. <span class="md-ellipsis">
  209. FAQ
  210. </span>
  211. </a>
  212. </li>
  213. <li class="md-nav__item">
  214. <a href="../../introduction/stability-support/" class="md-nav__link">
  215. <span class="md-ellipsis">
  216. Stability and Support
  217. </span>
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  222. <span class="md-ellipsis">
  223. Deprecation Policy
  224. </span>
  225. </a>
  226. </li>
  227. </ul>
  228. </nav>
  229. </li>
  230. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  231. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  232. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  233. <span class="md-ellipsis">
  234. API
  235. </span>
  236. <span class="md-nav__icon md-icon"></span>
  237. </label>
  238. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  239. <label class="md-nav__title" for="__nav_2">
  240. <span class="md-nav__icon md-icon"></span>
  241. API
  242. </label>
  243. <ul class="md-nav__list" data-md-scrollfix>
  244. <li class="md-nav__item">
  245. <a href="../components/" class="md-nav__link">
  246. <span class="md-ellipsis">
  247. Components
  248. </span>
  249. </a>
  250. </li>
  251. <li class="md-nav__item md-nav__item--nested">
  252. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  253. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  254. <span class="md-ellipsis">
  255. Core Resources
  256. </span>
  257. <span class="md-nav__icon md-icon"></span>
  258. </label>
  259. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  260. <label class="md-nav__title" for="__nav_2_2">
  261. <span class="md-nav__icon md-icon"></span>
  262. Core Resources
  263. </label>
  264. <ul class="md-nav__list" data-md-scrollfix>
  265. <li class="md-nav__item">
  266. <a href="../externalsecret/" class="md-nav__link">
  267. <span class="md-ellipsis">
  268. ExternalSecret
  269. </span>
  270. </a>
  271. </li>
  272. <li class="md-nav__item">
  273. <a href="../secretstore/" class="md-nav__link">
  274. <span class="md-ellipsis">
  275. SecretStore
  276. </span>
  277. </a>
  278. </li>
  279. <li class="md-nav__item">
  280. <a href="../clustersecretstore/" class="md-nav__link">
  281. <span class="md-ellipsis">
  282. ClusterSecretStore
  283. </span>
  284. </a>
  285. </li>
  286. <li class="md-nav__item">
  287. <a href="../clusterexternalsecret/" class="md-nav__link">
  288. <span class="md-ellipsis">
  289. ClusterExternalSecret
  290. </span>
  291. </a>
  292. </li>
  293. <li class="md-nav__item">
  294. <a href="../pushsecret/" class="md-nav__link">
  295. <span class="md-ellipsis">
  296. PushSecret
  297. </span>
  298. </a>
  299. </li>
  300. </ul>
  301. </nav>
  302. </li>
  303. <li class="md-nav__item md-nav__item--nested">
  304. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  305. <div class="md-nav__link md-nav__container">
  306. <a href="../generator/" class="md-nav__link ">
  307. <span class="md-ellipsis">
  308. Generators
  309. </span>
  310. </a>
  311. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  312. <span class="md-nav__icon md-icon"></span>
  313. </label>
  314. </div>
  315. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  316. <label class="md-nav__title" for="__nav_2_3">
  317. <span class="md-nav__icon md-icon"></span>
  318. Generators
  319. </label>
  320. <ul class="md-nav__list" data-md-scrollfix>
  321. <li class="md-nav__item">
  322. <a href="../generator/acr/" class="md-nav__link">
  323. <span class="md-ellipsis">
  324. Azure Container Registry
  325. </span>
  326. </a>
  327. </li>
  328. <li class="md-nav__item">
  329. <a href="../generator/ecr/" class="md-nav__link">
  330. <span class="md-ellipsis">
  331. AWS Elastic Container Registry
  332. </span>
  333. </a>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="../generator/sts/" class="md-nav__link">
  337. <span class="md-ellipsis">
  338. AWS STS Session Token
  339. </span>
  340. </a>
  341. </li>
  342. <li class="md-nav__item">
  343. <a href="../generator/cluster/" class="md-nav__link">
  344. <span class="md-ellipsis">
  345. Cluster Generator
  346. </span>
  347. </a>
  348. </li>
  349. <li class="md-nav__item">
  350. <a href="../generator/gcr/" class="md-nav__link">
  351. <span class="md-ellipsis">
  352. Google Container Registry
  353. </span>
  354. </a>
  355. </li>
  356. <li class="md-nav__item">
  357. <a href="../generator/vault/" class="md-nav__link">
  358. <span class="md-ellipsis">
  359. Vault Dynamic Secret
  360. </span>
  361. </a>
  362. </li>
  363. <li class="md-nav__item">
  364. <a href="../generator/password/" class="md-nav__link">
  365. <span class="md-ellipsis">
  366. Password
  367. </span>
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../generator/fake/" class="md-nav__link">
  372. <span class="md-ellipsis">
  373. Fake
  374. </span>
  375. </a>
  376. </li>
  377. <li class="md-nav__item">
  378. <a href="../generator/webhook/" class="md-nav__link">
  379. <span class="md-ellipsis">
  380. Webhook
  381. </span>
  382. </a>
  383. </li>
  384. <li class="md-nav__item">
  385. <a href="../generator/github/" class="md-nav__link">
  386. <span class="md-ellipsis">
  387. Github
  388. </span>
  389. </a>
  390. </li>
  391. <li class="md-nav__item">
  392. <a href="../generator/uuid/" class="md-nav__link">
  393. <span class="md-ellipsis">
  394. UUID
  395. </span>
  396. </a>
  397. </li>
  398. </ul>
  399. </nav>
  400. </li>
  401. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  402. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" checked>
  403. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  404. <span class="md-ellipsis">
  405. Reference Docs
  406. </span>
  407. <span class="md-nav__icon md-icon"></span>
  408. </label>
  409. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="true">
  410. <label class="md-nav__title" for="__nav_2_4">
  411. <span class="md-nav__icon md-icon"></span>
  412. Reference Docs
  413. </label>
  414. <ul class="md-nav__list" data-md-scrollfix>
  415. <li class="md-nav__item md-nav__item--active">
  416. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  417. <a href="./" class="md-nav__link md-nav__link--active">
  418. <span class="md-ellipsis">
  419. API specification
  420. </span>
  421. </a>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../controller-options/" class="md-nav__link">
  425. <span class="md-ellipsis">
  426. Controller Options
  427. </span>
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="../metrics/" class="md-nav__link">
  432. <span class="md-ellipsis">
  433. Metrics
  434. </span>
  435. </a>
  436. </li>
  437. </ul>
  438. </nav>
  439. </li>
  440. </ul>
  441. </nav>
  442. </li>
  443. <li class="md-nav__item md-nav__item--nested">
  444. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  445. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  446. <span class="md-ellipsis">
  447. Guides
  448. </span>
  449. <span class="md-nav__icon md-icon"></span>
  450. </label>
  451. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  452. <label class="md-nav__title" for="__nav_3">
  453. <span class="md-nav__icon md-icon"></span>
  454. Guides
  455. </label>
  456. <ul class="md-nav__list" data-md-scrollfix>
  457. <li class="md-nav__item">
  458. <a href="../../guides/introduction/" class="md-nav__link">
  459. <span class="md-ellipsis">
  460. Introduction
  461. </span>
  462. </a>
  463. </li>
  464. <li class="md-nav__item md-nav__item--nested">
  465. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  466. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  467. <span class="md-ellipsis">
  468. External Secrets
  469. </span>
  470. <span class="md-nav__icon md-icon"></span>
  471. </label>
  472. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  473. <label class="md-nav__title" for="__nav_3_2">
  474. <span class="md-nav__icon md-icon"></span>
  475. External Secrets
  476. </label>
  477. <ul class="md-nav__list" data-md-scrollfix>
  478. <li class="md-nav__item">
  479. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  480. <span class="md-ellipsis">
  481. Extract structured data
  482. </span>
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="../../guides/getallsecrets/" class="md-nav__link">
  487. <span class="md-ellipsis">
  488. Find Secrets by Name or Metadata
  489. </span>
  490. </a>
  491. </li>
  492. <li class="md-nav__item">
  493. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  494. <span class="md-ellipsis">
  495. Rewriting Keys
  496. </span>
  497. </a>
  498. </li>
  499. <li class="md-nav__item md-nav__item--nested">
  500. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  501. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  502. <span class="md-ellipsis">
  503. Advanced Templating
  504. </span>
  505. <span class="md-nav__icon md-icon"></span>
  506. </label>
  507. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  508. <label class="md-nav__title" for="__nav_3_2_4">
  509. <span class="md-nav__icon md-icon"></span>
  510. Advanced Templating
  511. </label>
  512. <ul class="md-nav__list" data-md-scrollfix>
  513. <li class="md-nav__item">
  514. <a href="../../guides/templating/" class="md-nav__link">
  515. <span class="md-ellipsis">
  516. v2
  517. </span>
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../../guides/templating-v1/" class="md-nav__link">
  522. <span class="md-ellipsis">
  523. v1
  524. </span>
  525. </a>
  526. </li>
  527. </ul>
  528. </nav>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  532. <span class="md-ellipsis">
  533. Kubernetes Secret Types
  534. </span>
  535. </a>
  536. </li>
  537. <li class="md-nav__item">
  538. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  539. <span class="md-ellipsis">
  540. Lifecycle: ownership & deletion
  541. </span>
  542. </a>
  543. </li>
  544. <li class="md-nav__item">
  545. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  546. <span class="md-ellipsis">
  547. Decoding Strategies
  548. </span>
  549. </a>
  550. </li>
  551. <li class="md-nav__item">
  552. <a href="../../guides/controller-class/" class="md-nav__link">
  553. <span class="md-ellipsis">
  554. Controller Classes
  555. </span>
  556. </a>
  557. </li>
  558. </ul>
  559. </nav>
  560. </li>
  561. <li class="md-nav__item">
  562. <a href="../../guides/generator/" class="md-nav__link">
  563. <span class="md-ellipsis">
  564. Generators
  565. </span>
  566. </a>
  567. </li>
  568. <li class="md-nav__item">
  569. <a href="../../guides/pushsecrets/" class="md-nav__link">
  570. <span class="md-ellipsis">
  571. Push Secrets
  572. </span>
  573. </a>
  574. </li>
  575. <li class="md-nav__item md-nav__item--nested">
  576. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  577. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  578. <span class="md-ellipsis">
  579. Operations
  580. </span>
  581. <span class="md-nav__icon md-icon"></span>
  582. </label>
  583. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  584. <label class="md-nav__title" for="__nav_3_5">
  585. <span class="md-nav__icon md-icon"></span>
  586. Operations
  587. </label>
  588. <ul class="md-nav__list" data-md-scrollfix>
  589. <li class="md-nav__item">
  590. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  591. <span class="md-ellipsis">
  592. Multi Tenancy
  593. </span>
  594. </a>
  595. </li>
  596. <li class="md-nav__item">
  597. <a href="../../guides/security-best-practices/" class="md-nav__link">
  598. <span class="md-ellipsis">
  599. Security Best Practices
  600. </span>
  601. </a>
  602. </li>
  603. <li class="md-nav__item">
  604. <a href="../../guides/threat-model/" class="md-nav__link">
  605. <span class="md-ellipsis">
  606. Threat Model
  607. </span>
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="../../guides/v1beta1/" class="md-nav__link">
  612. <span class="md-ellipsis">
  613. Upgrading to v1beta1
  614. </span>
  615. </a>
  616. </li>
  617. <li class="md-nav__item">
  618. <a href="../../guides/using-latest-image/" class="md-nav__link">
  619. <span class="md-ellipsis">
  620. Using Latest Image
  621. </span>
  622. </a>
  623. </li>
  624. <li class="md-nav__item">
  625. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  626. <span class="md-ellipsis">
  627. Disable Cluster Features
  628. </span>
  629. </a>
  630. </li>
  631. </ul>
  632. </nav>
  633. </li>
  634. </ul>
  635. </nav>
  636. </li>
  637. <li class="md-nav__item md-nav__item--nested">
  638. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  639. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  640. <span class="md-ellipsis">
  641. Provider
  642. </span>
  643. <span class="md-nav__icon md-icon"></span>
  644. </label>
  645. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  646. <label class="md-nav__title" for="__nav_4">
  647. <span class="md-nav__icon md-icon"></span>
  648. Provider
  649. </label>
  650. <ul class="md-nav__list" data-md-scrollfix>
  651. <li class="md-nav__item">
  652. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  653. <span class="md-ellipsis">
  654. AWS Secrets Manager
  655. </span>
  656. </a>
  657. </li>
  658. <li class="md-nav__item">
  659. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  660. <span class="md-ellipsis">
  661. AWS Parameter Store
  662. </span>
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  667. <span class="md-ellipsis">
  668. Azure Key Vault
  669. </span>
  670. </a>
  671. </li>
  672. <li class="md-nav__item">
  673. <a href="../../provider/beyondtrust/" class="md-nav__link">
  674. <span class="md-ellipsis">
  675. BeyondTrust
  676. </span>
  677. </a>
  678. </li>
  679. <li class="md-nav__item">
  680. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  681. <span class="md-ellipsis">
  682. Bitwarden Secrets Manager
  683. </span>
  684. </a>
  685. </li>
  686. <li class="md-nav__item">
  687. <a href="../../provider/chef/" class="md-nav__link">
  688. <span class="md-ellipsis">
  689. Chef
  690. </span>
  691. </a>
  692. </li>
  693. <li class="md-nav__item">
  694. <a href="../../provider/conjur/" class="md-nav__link">
  695. <span class="md-ellipsis">
  696. CyberArk Conjur
  697. </span>
  698. </a>
  699. </li>
  700. <li class="md-nav__item">
  701. <a href="../../provider/device42/" class="md-nav__link">
  702. <span class="md-ellipsis">
  703. Device42
  704. </span>
  705. </a>
  706. </li>
  707. <li class="md-nav__item">
  708. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  709. <span class="md-ellipsis">
  710. Google Cloud Secret Manager
  711. </span>
  712. </a>
  713. </li>
  714. <li class="md-nav__item">
  715. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  716. <span class="md-ellipsis">
  717. HashiCorp Vault
  718. </span>
  719. </a>
  720. </li>
  721. <li class="md-nav__item">
  722. <a href="../../provider/kubernetes/" class="md-nav__link">
  723. <span class="md-ellipsis">
  724. Kubernetes
  725. </span>
  726. </a>
  727. </li>
  728. <li class="md-nav__item">
  729. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  730. <span class="md-ellipsis">
  731. IBM Secrets Manager
  732. </span>
  733. </a>
  734. </li>
  735. <li class="md-nav__item">
  736. <a href="../../provider/akeyless/" class="md-nav__link">
  737. <span class="md-ellipsis">
  738. Akeyless
  739. </span>
  740. </a>
  741. </li>
  742. <li class="md-nav__item">
  743. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  744. <span class="md-ellipsis">
  745. Yandex Certificate Manager
  746. </span>
  747. </a>
  748. </li>
  749. <li class="md-nav__item">
  750. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  751. <span class="md-ellipsis">
  752. Yandex Lockbox
  753. </span>
  754. </a>
  755. </li>
  756. <li class="md-nav__item">
  757. <a href="../../provider/alibaba/" class="md-nav__link">
  758. <span class="md-ellipsis">
  759. Alibaba Cloud
  760. </span>
  761. </a>
  762. </li>
  763. <li class="md-nav__item">
  764. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  765. <span class="md-ellipsis">
  766. GitLab Variables
  767. </span>
  768. </a>
  769. </li>
  770. <li class="md-nav__item">
  771. <a href="../../provider/oracle-vault/" class="md-nav__link">
  772. <span class="md-ellipsis">
  773. Oracle Vault
  774. </span>
  775. </a>
  776. </li>
  777. <li class="md-nav__item">
  778. <a href="../../provider/1password-automation/" class="md-nav__link">
  779. <span class="md-ellipsis">
  780. 1Password Secrets Automation
  781. </span>
  782. </a>
  783. </li>
  784. <li class="md-nav__item">
  785. <a href="../../provider/webhook/" class="md-nav__link">
  786. <span class="md-ellipsis">
  787. Webhook
  788. </span>
  789. </a>
  790. </li>
  791. <li class="md-nav__item">
  792. <a href="../../provider/fake/" class="md-nav__link">
  793. <span class="md-ellipsis">
  794. Fake
  795. </span>
  796. </a>
  797. </li>
  798. <li class="md-nav__item">
  799. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  800. <span class="md-ellipsis">
  801. senhasegura DevOps Secrets Management (DSM)
  802. </span>
  803. </a>
  804. </li>
  805. <li class="md-nav__item">
  806. <a href="../../provider/doppler/" class="md-nav__link">
  807. <span class="md-ellipsis">
  808. Doppler
  809. </span>
  810. </a>
  811. </li>
  812. <li class="md-nav__item">
  813. <a href="../../provider/keeper-security/" class="md-nav__link">
  814. <span class="md-ellipsis">
  815. Keeper Security
  816. </span>
  817. </a>
  818. </li>
  819. <li class="md-nav__item">
  820. <a href="../../provider/cloak/" class="md-nav__link">
  821. <span class="md-ellipsis">
  822. Cloak End 2 End Encrypted Secrets
  823. </span>
  824. </a>
  825. </li>
  826. <li class="md-nav__item">
  827. <a href="../../provider/scaleway/" class="md-nav__link">
  828. <span class="md-ellipsis">
  829. Scaleway
  830. </span>
  831. </a>
  832. </li>
  833. <li class="md-nav__item">
  834. <a href="../../provider/delinea/" class="md-nav__link">
  835. <span class="md-ellipsis">
  836. Delinea
  837. </span>
  838. </a>
  839. </li>
  840. <li class="md-nav__item">
  841. <a href="../../provider/secretserver/" class="md-nav__link">
  842. <span class="md-ellipsis">
  843. Secret Server
  844. </span>
  845. </a>
  846. </li>
  847. <li class="md-nav__item">
  848. <a href="../../provider/passbolt/" class="md-nav__link">
  849. <span class="md-ellipsis">
  850. Passbolt
  851. </span>
  852. </a>
  853. </li>
  854. <li class="md-nav__item">
  855. <a href="../../provider/pulumi/" class="md-nav__link">
  856. <span class="md-ellipsis">
  857. Pulumi ESC
  858. </span>
  859. </a>
  860. </li>
  861. <li class="md-nav__item">
  862. <a href="../../provider/onboardbase/" class="md-nav__link">
  863. <span class="md-ellipsis">
  864. Onboardbase
  865. </span>
  866. </a>
  867. </li>
  868. <li class="md-nav__item">
  869. <a href="../../provider-passworddepot/" class="md-nav__link">
  870. <span class="md-ellipsis">
  871. Password Depot
  872. </span>
  873. </a>
  874. </li>
  875. <li class="md-nav__item">
  876. <a href="../../provider/fortanix/" class="md-nav__link">
  877. <span class="md-ellipsis">
  878. Fortanix
  879. </span>
  880. </a>
  881. </li>
  882. <li class="md-nav__item">
  883. <a href="../../provider/infisical/" class="md-nav__link">
  884. <span class="md-ellipsis">
  885. Infisical
  886. </span>
  887. </a>
  888. </li>
  889. <li class="md-nav__item">
  890. <a href="../../provider/previder/" class="md-nav__link">
  891. <span class="md-ellipsis">
  892. Previder
  893. </span>
  894. </a>
  895. </li>
  896. </ul>
  897. </nav>
  898. </li>
  899. <li class="md-nav__item md-nav__item--nested">
  900. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  901. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  902. <span class="md-ellipsis">
  903. Examples
  904. </span>
  905. <span class="md-nav__icon md-icon"></span>
  906. </label>
  907. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  908. <label class="md-nav__title" for="__nav_5">
  909. <span class="md-nav__icon md-icon"></span>
  910. Examples
  911. </label>
  912. <ul class="md-nav__list" data-md-scrollfix>
  913. <li class="md-nav__item">
  914. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  915. <span class="md-ellipsis">
  916. FluxCD
  917. </span>
  918. </a>
  919. </li>
  920. <li class="md-nav__item">
  921. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  922. <span class="md-ellipsis">
  923. Anchore Engine
  924. </span>
  925. </a>
  926. </li>
  927. <li class="md-nav__item">
  928. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  929. <span class="md-ellipsis">
  930. Jenkins
  931. </span>
  932. </a>
  933. </li>
  934. <li class="md-nav__item">
  935. <a href="../../examples/bitwarden/" class="md-nav__link">
  936. <span class="md-ellipsis">
  937. BitWarden
  938. </span>
  939. </a>
  940. </li>
  941. </ul>
  942. </nav>
  943. </li>
  944. <li class="md-nav__item md-nav__item--nested">
  945. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  946. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  947. <span class="md-ellipsis">
  948. Community
  949. </span>
  950. <span class="md-nav__icon md-icon"></span>
  951. </label>
  952. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  953. <label class="md-nav__title" for="__nav_6">
  954. <span class="md-nav__icon md-icon"></span>
  955. Community
  956. </label>
  957. <ul class="md-nav__list" data-md-scrollfix>
  958. <li class="md-nav__item md-nav__item--nested">
  959. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  960. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  961. <span class="md-ellipsis">
  962. Contributing
  963. </span>
  964. <span class="md-nav__icon md-icon"></span>
  965. </label>
  966. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  967. <label class="md-nav__title" for="__nav_6_1">
  968. <span class="md-nav__icon md-icon"></span>
  969. Contributing
  970. </label>
  971. <ul class="md-nav__list" data-md-scrollfix>
  972. <li class="md-nav__item">
  973. <a href="../../contributing/devguide/" class="md-nav__link">
  974. <span class="md-ellipsis">
  975. Developer guide
  976. </span>
  977. </a>
  978. </li>
  979. <li class="md-nav__item">
  980. <a href="../../contributing/process/" class="md-nav__link">
  981. <span class="md-ellipsis">
  982. Contributing Process
  983. </span>
  984. </a>
  985. </li>
  986. <li class="md-nav__item">
  987. <a href="../../contributing/release/" class="md-nav__link">
  988. <span class="md-ellipsis">
  989. Release Process
  990. </span>
  991. </a>
  992. </li>
  993. <li class="md-nav__item">
  994. <a href="../../contributing/coc/" class="md-nav__link">
  995. <span class="md-ellipsis">
  996. Code of Conduct
  997. </span>
  998. </a>
  999. </li>
  1000. <li class="md-nav__item">
  1001. <a href="../../contributing/roadmap/" class="md-nav__link">
  1002. <span class="md-ellipsis">
  1003. Roadmap
  1004. </span>
  1005. </a>
  1006. </li>
  1007. </ul>
  1008. </nav>
  1009. </li>
  1010. <li class="md-nav__item md-nav__item--nested">
  1011. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1012. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1013. <span class="md-ellipsis">
  1014. External Resources
  1015. </span>
  1016. <span class="md-nav__icon md-icon"></span>
  1017. </label>
  1018. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1019. <label class="md-nav__title" for="__nav_6_2">
  1020. <span class="md-nav__icon md-icon"></span>
  1021. External Resources
  1022. </label>
  1023. <ul class="md-nav__list" data-md-scrollfix>
  1024. <li class="md-nav__item">
  1025. <a href="../../eso-talks/" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. Talks
  1028. </span>
  1029. </a>
  1030. </li>
  1031. <li class="md-nav__item">
  1032. <a href="../../eso-demos/" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Demos
  1035. </span>
  1036. </a>
  1037. </li>
  1038. <li class="md-nav__item">
  1039. <a href="../../eso-blogs/" class="md-nav__link">
  1040. <span class="md-ellipsis">
  1041. Blogs
  1042. </span>
  1043. </a>
  1044. </li>
  1045. <li class="md-nav__item">
  1046. <a href="../../eso-tools/" class="md-nav__link">
  1047. <span class="md-ellipsis">
  1048. Tools
  1049. </span>
  1050. </a>
  1051. </li>
  1052. </ul>
  1053. </nav>
  1054. </li>
  1055. </ul>
  1056. </nav>
  1057. </li>
  1058. </ul>
  1059. </nav>
  1060. </div>
  1061. </div>
  1062. </div>
  1063. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1064. <div class="md-sidebar__scrollwrap">
  1065. <div class="md-sidebar__inner">
  1066. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1067. </nav>
  1068. </div>
  1069. </div>
  1070. </div>
  1071. <div class="md-content" data-md-component="content">
  1072. <article class="md-content__inner md-typeset">
  1073. <h1>API specification</h1>
  1074. <p>Packages:</p>
  1075. <ul>
  1076. <li>
  1077. <a href="#external-secrets.io%2fv1beta1">external-secrets.io/v1beta1</a>
  1078. </li>
  1079. </ul>
  1080. <h2 id="external-secrets.io/v1beta1">external-secrets.io/v1beta1</h2>
  1081. <p>
  1082. <p>Package v1beta1 contains resources for external-secrets</p>
  1083. </p>
  1084. <p>Resource Types:</p>
  1085. <ul></ul>
  1086. <h3 id="external-secrets.io/v1beta1.AWSAuth">AWSAuth
  1087. </h3>
  1088. <p>
  1089. (<em>Appears on:</em>
  1090. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  1091. </p>
  1092. <p>
  1093. <p>AWSAuth tells the controller how to do authentication with aws.
  1094. Only one of secretRef or jwt can be specified.
  1095. if none is specified the controller will load credentials using the aws sdk defaults.</p>
  1096. </p>
  1097. <table>
  1098. <thead>
  1099. <tr>
  1100. <th>Field</th>
  1101. <th>Description</th>
  1102. </tr>
  1103. </thead>
  1104. <tbody>
  1105. <tr>
  1106. <td>
  1107. <code>secretRef</code></br>
  1108. <em>
  1109. <a href="#external-secrets.io/v1beta1.AWSAuthSecretRef">
  1110. AWSAuthSecretRef
  1111. </a>
  1112. </em>
  1113. </td>
  1114. <td>
  1115. <em>(Optional)</em>
  1116. </td>
  1117. </tr>
  1118. <tr>
  1119. <td>
  1120. <code>jwt</code></br>
  1121. <em>
  1122. <a href="#external-secrets.io/v1beta1.AWSJWTAuth">
  1123. AWSJWTAuth
  1124. </a>
  1125. </em>
  1126. </td>
  1127. <td>
  1128. <em>(Optional)</em>
  1129. </td>
  1130. </tr>
  1131. </tbody>
  1132. </table>
  1133. <h3 id="external-secrets.io/v1beta1.AWSAuthSecretRef">AWSAuthSecretRef
  1134. </h3>
  1135. <p>
  1136. (<em>Appears on:</em>
  1137. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  1138. </p>
  1139. <p>
  1140. <p>AWSAuthSecretRef holds secret references for AWS credentials
  1141. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  1142. </p>
  1143. <table>
  1144. <thead>
  1145. <tr>
  1146. <th>Field</th>
  1147. <th>Description</th>
  1148. </tr>
  1149. </thead>
  1150. <tbody>
  1151. <tr>
  1152. <td>
  1153. <code>accessKeyIDSecretRef</code></br>
  1154. <em>
  1155. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1156. External Secrets meta/v1.SecretKeySelector
  1157. </a>
  1158. </em>
  1159. </td>
  1160. <td>
  1161. <p>The AccessKeyID is used for authentication</p>
  1162. </td>
  1163. </tr>
  1164. <tr>
  1165. <td>
  1166. <code>secretAccessKeySecretRef</code></br>
  1167. <em>
  1168. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1169. External Secrets meta/v1.SecretKeySelector
  1170. </a>
  1171. </em>
  1172. </td>
  1173. <td>
  1174. <p>The SecretAccessKey is used for authentication</p>
  1175. </td>
  1176. </tr>
  1177. <tr>
  1178. <td>
  1179. <code>sessionTokenSecretRef</code></br>
  1180. <em>
  1181. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1182. External Secrets meta/v1.SecretKeySelector
  1183. </a>
  1184. </em>
  1185. </td>
  1186. <td>
  1187. <p>The SessionToken used for authentication
  1188. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  1189. 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>
  1190. </td>
  1191. </tr>
  1192. </tbody>
  1193. </table>
  1194. <h3 id="external-secrets.io/v1beta1.AWSJWTAuth">AWSJWTAuth
  1195. </h3>
  1196. <p>
  1197. (<em>Appears on:</em>
  1198. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  1199. </p>
  1200. <p>
  1201. <p>Authenticate against AWS using service account tokens.</p>
  1202. </p>
  1203. <table>
  1204. <thead>
  1205. <tr>
  1206. <th>Field</th>
  1207. <th>Description</th>
  1208. </tr>
  1209. </thead>
  1210. <tbody>
  1211. <tr>
  1212. <td>
  1213. <code>serviceAccountRef</code></br>
  1214. <em>
  1215. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  1216. External Secrets meta/v1.ServiceAccountSelector
  1217. </a>
  1218. </em>
  1219. </td>
  1220. <td>
  1221. </td>
  1222. </tr>
  1223. </tbody>
  1224. </table>
  1225. <h3 id="external-secrets.io/v1beta1.AWSProvider">AWSProvider
  1226. </h3>
  1227. <p>
  1228. (<em>Appears on:</em>
  1229. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1230. </p>
  1231. <p>
  1232. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  1233. </p>
  1234. <table>
  1235. <thead>
  1236. <tr>
  1237. <th>Field</th>
  1238. <th>Description</th>
  1239. </tr>
  1240. </thead>
  1241. <tbody>
  1242. <tr>
  1243. <td>
  1244. <code>service</code></br>
  1245. <em>
  1246. <a href="#external-secrets.io/v1beta1.AWSServiceType">
  1247. AWSServiceType
  1248. </a>
  1249. </em>
  1250. </td>
  1251. <td>
  1252. <p>Service defines which service should be used to fetch the secrets</p>
  1253. </td>
  1254. </tr>
  1255. <tr>
  1256. <td>
  1257. <code>auth</code></br>
  1258. <em>
  1259. <a href="#external-secrets.io/v1beta1.AWSAuth">
  1260. AWSAuth
  1261. </a>
  1262. </em>
  1263. </td>
  1264. <td>
  1265. <em>(Optional)</em>
  1266. <p>Auth defines the information necessary to authenticate against AWS
  1267. if not set aws sdk will infer credentials from your environment
  1268. 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>
  1269. </td>
  1270. </tr>
  1271. <tr>
  1272. <td>
  1273. <code>role</code></br>
  1274. <em>
  1275. string
  1276. </em>
  1277. </td>
  1278. <td>
  1279. <em>(Optional)</em>
  1280. <p>Role is a Role ARN which the provider will assume</p>
  1281. </td>
  1282. </tr>
  1283. <tr>
  1284. <td>
  1285. <code>region</code></br>
  1286. <em>
  1287. string
  1288. </em>
  1289. </td>
  1290. <td>
  1291. <p>AWS Region to be used for the provider</p>
  1292. </td>
  1293. </tr>
  1294. <tr>
  1295. <td>
  1296. <code>additionalRoles</code></br>
  1297. <em>
  1298. []string
  1299. </em>
  1300. </td>
  1301. <td>
  1302. <em>(Optional)</em>
  1303. <p>AdditionalRoles is a chained list of Role ARNs which the provider will sequentially assume before assuming the Role</p>
  1304. </td>
  1305. </tr>
  1306. <tr>
  1307. <td>
  1308. <code>externalID</code></br>
  1309. <em>
  1310. string
  1311. </em>
  1312. </td>
  1313. <td>
  1314. <p>AWS External ID set on assumed IAM roles</p>
  1315. </td>
  1316. </tr>
  1317. <tr>
  1318. <td>
  1319. <code>sessionTags</code></br>
  1320. <em>
  1321. <a href="#external-secrets.io/v1beta1.*github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1.Tag">
  1322. []*github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1.Tag
  1323. </a>
  1324. </em>
  1325. </td>
  1326. <td>
  1327. <em>(Optional)</em>
  1328. <p>AWS STS assume role session tags</p>
  1329. </td>
  1330. </tr>
  1331. <tr>
  1332. <td>
  1333. <code>secretsManager</code></br>
  1334. <em>
  1335. <a href="#external-secrets.io/v1beta1.SecretsManager">
  1336. SecretsManager
  1337. </a>
  1338. </em>
  1339. </td>
  1340. <td>
  1341. <em>(Optional)</em>
  1342. <p>SecretsManager defines how the provider behaves when interacting with AWS SecretsManager</p>
  1343. </td>
  1344. </tr>
  1345. <tr>
  1346. <td>
  1347. <code>transitiveTagKeys</code></br>
  1348. <em>
  1349. []*string
  1350. </em>
  1351. </td>
  1352. <td>
  1353. <em>(Optional)</em>
  1354. <p>AWS STS assume role transitive session tags. Required when multiple rules are used with the provider</p>
  1355. </td>
  1356. </tr>
  1357. <tr>
  1358. <td>
  1359. <code>prefix</code></br>
  1360. <em>
  1361. string
  1362. </em>
  1363. </td>
  1364. <td>
  1365. <em>(Optional)</em>
  1366. <p>Prefix adds a prefix to all retrieved values.</p>
  1367. </td>
  1368. </tr>
  1369. </tbody>
  1370. </table>
  1371. <h3 id="external-secrets.io/v1beta1.AWSServiceType">AWSServiceType
  1372. (<code>string</code> alias)</p></h3>
  1373. <p>
  1374. (<em>Appears on:</em>
  1375. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  1376. </p>
  1377. <p>
  1378. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  1379. </p>
  1380. <table>
  1381. <thead>
  1382. <tr>
  1383. <th>Value</th>
  1384. <th>Description</th>
  1385. </tr>
  1386. </thead>
  1387. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  1388. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore service.
  1389. 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>
  1390. </td>
  1391. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  1392. <td><p>AWSServiceSecretsManager is the AWS SecretsManager service.
  1393. 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>
  1394. </td>
  1395. </tr></tbody>
  1396. </table>
  1397. <h3 id="external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth
  1398. </h3>
  1399. <p>
  1400. (<em>Appears on:</em>
  1401. <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>)
  1402. </p>
  1403. <p>
  1404. </p>
  1405. <table>
  1406. <thead>
  1407. <tr>
  1408. <th>Field</th>
  1409. <th>Description</th>
  1410. </tr>
  1411. </thead>
  1412. <tbody>
  1413. <tr>
  1414. <td>
  1415. <code>secretRef</code></br>
  1416. <em>
  1417. <a href="#external-secrets.io/v1beta1.AkeylessAuthSecretRef">
  1418. AkeylessAuthSecretRef
  1419. </a>
  1420. </em>
  1421. </td>
  1422. <td>
  1423. <em>(Optional)</em>
  1424. <p>Reference to a Secret that contains the details
  1425. to authenticate with Akeyless.</p>
  1426. </td>
  1427. </tr>
  1428. <tr>
  1429. <td>
  1430. <code>kubernetesAuth</code></br>
  1431. <em>
  1432. <a href="#external-secrets.io/v1beta1.AkeylessKubernetesAuth">
  1433. AkeylessKubernetesAuth
  1434. </a>
  1435. </em>
  1436. </td>
  1437. <td>
  1438. <em>(Optional)</em>
  1439. <p>Kubernetes authenticates with Akeyless by passing the ServiceAccount
  1440. token stored in the named Secret resource.</p>
  1441. </td>
  1442. </tr>
  1443. </tbody>
  1444. </table>
  1445. <h3 id="external-secrets.io/v1beta1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
  1446. </h3>
  1447. <p>
  1448. (<em>Appears on:</em>
  1449. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  1450. </p>
  1451. <p>
  1452. <p>AkeylessAuthSecretRef
  1453. AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
  1454. </p>
  1455. <table>
  1456. <thead>
  1457. <tr>
  1458. <th>Field</th>
  1459. <th>Description</th>
  1460. </tr>
  1461. </thead>
  1462. <tbody>
  1463. <tr>
  1464. <td>
  1465. <code>accessID</code></br>
  1466. <em>
  1467. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1468. External Secrets meta/v1.SecretKeySelector
  1469. </a>
  1470. </em>
  1471. </td>
  1472. <td>
  1473. <p>The SecretAccessID is used for authentication</p>
  1474. </td>
  1475. </tr>
  1476. <tr>
  1477. <td>
  1478. <code>accessType</code></br>
  1479. <em>
  1480. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1481. External Secrets meta/v1.SecretKeySelector
  1482. </a>
  1483. </em>
  1484. </td>
  1485. <td>
  1486. </td>
  1487. </tr>
  1488. <tr>
  1489. <td>
  1490. <code>accessTypeParam</code></br>
  1491. <em>
  1492. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1493. External Secrets meta/v1.SecretKeySelector
  1494. </a>
  1495. </em>
  1496. </td>
  1497. <td>
  1498. </td>
  1499. </tr>
  1500. </tbody>
  1501. </table>
  1502. <h3 id="external-secrets.io/v1beta1.AkeylessKubernetesAuth">AkeylessKubernetesAuth
  1503. </h3>
  1504. <p>
  1505. (<em>Appears on:</em>
  1506. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  1507. </p>
  1508. <p>
  1509. <p>Authenticate with Kubernetes ServiceAccount token stored.</p>
  1510. </p>
  1511. <table>
  1512. <thead>
  1513. <tr>
  1514. <th>Field</th>
  1515. <th>Description</th>
  1516. </tr>
  1517. </thead>
  1518. <tbody>
  1519. <tr>
  1520. <td>
  1521. <code>accessID</code></br>
  1522. <em>
  1523. string
  1524. </em>
  1525. </td>
  1526. <td>
  1527. <p>the Akeyless Kubernetes auth-method access-id</p>
  1528. </td>
  1529. </tr>
  1530. <tr>
  1531. <td>
  1532. <code>k8sConfName</code></br>
  1533. <em>
  1534. string
  1535. </em>
  1536. </td>
  1537. <td>
  1538. <p>Kubernetes-auth configuration name in Akeyless-Gateway</p>
  1539. </td>
  1540. </tr>
  1541. <tr>
  1542. <td>
  1543. <code>serviceAccountRef</code></br>
  1544. <em>
  1545. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  1546. External Secrets meta/v1.ServiceAccountSelector
  1547. </a>
  1548. </em>
  1549. </td>
  1550. <td>
  1551. <em>(Optional)</em>
  1552. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  1553. If the service account is specified, the service account secret token JWT will be used
  1554. for authenticating with Akeyless. If the service account selector is not supplied,
  1555. the secretRef will be used instead.</p>
  1556. </td>
  1557. </tr>
  1558. <tr>
  1559. <td>
  1560. <code>secretRef</code></br>
  1561. <em>
  1562. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1563. External Secrets meta/v1.SecretKeySelector
  1564. </a>
  1565. </em>
  1566. </td>
  1567. <td>
  1568. <em>(Optional)</em>
  1569. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  1570. for authenticating with Akeyless. If a name is specified without a key,
  1571. <code>token</code> is the default. If one is not specified, the one bound to
  1572. the controller will be used.</p>
  1573. </td>
  1574. </tr>
  1575. </tbody>
  1576. </table>
  1577. <h3 id="external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider
  1578. </h3>
  1579. <p>
  1580. (<em>Appears on:</em>
  1581. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1582. </p>
  1583. <p>
  1584. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  1585. </p>
  1586. <table>
  1587. <thead>
  1588. <tr>
  1589. <th>Field</th>
  1590. <th>Description</th>
  1591. </tr>
  1592. </thead>
  1593. <tbody>
  1594. <tr>
  1595. <td>
  1596. <code>akeylessGWApiURL</code></br>
  1597. <em>
  1598. string
  1599. </em>
  1600. </td>
  1601. <td>
  1602. <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
  1603. </td>
  1604. </tr>
  1605. <tr>
  1606. <td>
  1607. <code>authSecretRef</code></br>
  1608. <em>
  1609. <a href="#external-secrets.io/v1beta1.AkeylessAuth">
  1610. AkeylessAuth
  1611. </a>
  1612. </em>
  1613. </td>
  1614. <td>
  1615. <p>Auth configures how the operator authenticates with Akeyless.</p>
  1616. </td>
  1617. </tr>
  1618. <tr>
  1619. <td>
  1620. <code>caBundle</code></br>
  1621. <em>
  1622. []byte
  1623. </em>
  1624. </td>
  1625. <td>
  1626. <em>(Optional)</em>
  1627. <p>PEM/base64 encoded CA bundle used to validate Akeyless Gateway certificate. Only used
  1628. if the AkeylessGWApiURL URL is using HTTPS protocol. If not set the system root certificates
  1629. are used to validate the TLS connection.</p>
  1630. </td>
  1631. </tr>
  1632. <tr>
  1633. <td>
  1634. <code>caProvider</code></br>
  1635. <em>
  1636. <a href="#external-secrets.io/v1beta1.CAProvider">
  1637. CAProvider
  1638. </a>
  1639. </em>
  1640. </td>
  1641. <td>
  1642. <em>(Optional)</em>
  1643. <p>The provider for the CA bundle to use to validate Akeyless Gateway certificate.</p>
  1644. </td>
  1645. </tr>
  1646. </tbody>
  1647. </table>
  1648. <h3 id="external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth
  1649. </h3>
  1650. <p>
  1651. (<em>Appears on:</em>
  1652. <a href="#external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider</a>)
  1653. </p>
  1654. <p>
  1655. <p>AlibabaAuth contains a secretRef for credentials.</p>
  1656. </p>
  1657. <table>
  1658. <thead>
  1659. <tr>
  1660. <th>Field</th>
  1661. <th>Description</th>
  1662. </tr>
  1663. </thead>
  1664. <tbody>
  1665. <tr>
  1666. <td>
  1667. <code>secretRef</code></br>
  1668. <em>
  1669. <a href="#external-secrets.io/v1beta1.AlibabaAuthSecretRef">
  1670. AlibabaAuthSecretRef
  1671. </a>
  1672. </em>
  1673. </td>
  1674. <td>
  1675. <em>(Optional)</em>
  1676. </td>
  1677. </tr>
  1678. <tr>
  1679. <td>
  1680. <code>rrsa</code></br>
  1681. <em>
  1682. <a href="#external-secrets.io/v1beta1.AlibabaRRSAAuth">
  1683. AlibabaRRSAAuth
  1684. </a>
  1685. </em>
  1686. </td>
  1687. <td>
  1688. <em>(Optional)</em>
  1689. </td>
  1690. </tr>
  1691. </tbody>
  1692. </table>
  1693. <h3 id="external-secrets.io/v1beta1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
  1694. </h3>
  1695. <p>
  1696. (<em>Appears on:</em>
  1697. <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
  1698. </p>
  1699. <p>
  1700. <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
  1701. </p>
  1702. <table>
  1703. <thead>
  1704. <tr>
  1705. <th>Field</th>
  1706. <th>Description</th>
  1707. </tr>
  1708. </thead>
  1709. <tbody>
  1710. <tr>
  1711. <td>
  1712. <code>accessKeyIDSecretRef</code></br>
  1713. <em>
  1714. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1715. External Secrets meta/v1.SecretKeySelector
  1716. </a>
  1717. </em>
  1718. </td>
  1719. <td>
  1720. <p>The AccessKeyID is used for authentication</p>
  1721. </td>
  1722. </tr>
  1723. <tr>
  1724. <td>
  1725. <code>accessKeySecretSecretRef</code></br>
  1726. <em>
  1727. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1728. External Secrets meta/v1.SecretKeySelector
  1729. </a>
  1730. </em>
  1731. </td>
  1732. <td>
  1733. <p>The AccessKeySecret is used for authentication</p>
  1734. </td>
  1735. </tr>
  1736. </tbody>
  1737. </table>
  1738. <h3 id="external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider
  1739. </h3>
  1740. <p>
  1741. (<em>Appears on:</em>
  1742. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1743. </p>
  1744. <p>
  1745. <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
  1746. </p>
  1747. <table>
  1748. <thead>
  1749. <tr>
  1750. <th>Field</th>
  1751. <th>Description</th>
  1752. </tr>
  1753. </thead>
  1754. <tbody>
  1755. <tr>
  1756. <td>
  1757. <code>auth</code></br>
  1758. <em>
  1759. <a href="#external-secrets.io/v1beta1.AlibabaAuth">
  1760. AlibabaAuth
  1761. </a>
  1762. </em>
  1763. </td>
  1764. <td>
  1765. </td>
  1766. </tr>
  1767. <tr>
  1768. <td>
  1769. <code>regionID</code></br>
  1770. <em>
  1771. string
  1772. </em>
  1773. </td>
  1774. <td>
  1775. <p>Alibaba Region to be used for the provider</p>
  1776. </td>
  1777. </tr>
  1778. </tbody>
  1779. </table>
  1780. <h3 id="external-secrets.io/v1beta1.AlibabaRRSAAuth">AlibabaRRSAAuth
  1781. </h3>
  1782. <p>
  1783. (<em>Appears on:</em>
  1784. <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
  1785. </p>
  1786. <p>
  1787. <p>Authenticate against Alibaba using RRSA.</p>
  1788. </p>
  1789. <table>
  1790. <thead>
  1791. <tr>
  1792. <th>Field</th>
  1793. <th>Description</th>
  1794. </tr>
  1795. </thead>
  1796. <tbody>
  1797. <tr>
  1798. <td>
  1799. <code>oidcProviderArn</code></br>
  1800. <em>
  1801. string
  1802. </em>
  1803. </td>
  1804. <td>
  1805. </td>
  1806. </tr>
  1807. <tr>
  1808. <td>
  1809. <code>oidcTokenFilePath</code></br>
  1810. <em>
  1811. string
  1812. </em>
  1813. </td>
  1814. <td>
  1815. </td>
  1816. </tr>
  1817. <tr>
  1818. <td>
  1819. <code>roleArn</code></br>
  1820. <em>
  1821. string
  1822. </em>
  1823. </td>
  1824. <td>
  1825. </td>
  1826. </tr>
  1827. <tr>
  1828. <td>
  1829. <code>sessionName</code></br>
  1830. <em>
  1831. string
  1832. </em>
  1833. </td>
  1834. <td>
  1835. </td>
  1836. </tr>
  1837. </tbody>
  1838. </table>
  1839. <h3 id="external-secrets.io/v1beta1.AzureAuthType">AzureAuthType
  1840. (<code>string</code> alias)</p></h3>
  1841. <p>
  1842. (<em>Appears on:</em>
  1843. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1844. </p>
  1845. <p>
  1846. <p>AuthType describes how to authenticate to the Azure Keyvault
  1847. Only one of the following auth types may be specified.
  1848. If none of the following auth type is specified, the default one
  1849. is ServicePrincipal.</p>
  1850. </p>
  1851. <table>
  1852. <thead>
  1853. <tr>
  1854. <th>Value</th>
  1855. <th>Description</th>
  1856. </tr>
  1857. </thead>
  1858. <tbody><tr><td><p>&#34;ManagedIdentity&#34;</p></td>
  1859. <td><p>Using Managed Identity to authenticate. Used with aad-pod-identity installed in the cluster.</p>
  1860. </td>
  1861. </tr><tr><td><p>&#34;ServicePrincipal&#34;</p></td>
  1862. <td><p>Using service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.</p>
  1863. </td>
  1864. </tr><tr><td><p>&#34;WorkloadIdentity&#34;</p></td>
  1865. <td><p>Using Workload Identity service accounts to authenticate.</p>
  1866. </td>
  1867. </tr></tbody>
  1868. </table>
  1869. <h3 id="external-secrets.io/v1beta1.AzureEnvironmentType">AzureEnvironmentType
  1870. (<code>string</code> alias)</p></h3>
  1871. <p>
  1872. (<em>Appears on:</em>
  1873. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1874. </p>
  1875. <p>
  1876. <p>AzureEnvironmentType specifies the Azure cloud environment endpoints to use for
  1877. connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
  1878. 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>
  1879. PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
  1880. </p>
  1881. <table>
  1882. <thead>
  1883. <tr>
  1884. <th>Value</th>
  1885. <th>Description</th>
  1886. </tr>
  1887. </thead>
  1888. <tbody><tr><td><p>&#34;ChinaCloud&#34;</p></td>
  1889. <td></td>
  1890. </tr><tr><td><p>&#34;GermanCloud&#34;</p></td>
  1891. <td></td>
  1892. </tr><tr><td><p>&#34;PublicCloud&#34;</p></td>
  1893. <td></td>
  1894. </tr><tr><td><p>&#34;USGovernmentCloud&#34;</p></td>
  1895. <td></td>
  1896. </tr></tbody>
  1897. </table>
  1898. <h3 id="external-secrets.io/v1beta1.AzureKVAuth">AzureKVAuth
  1899. </h3>
  1900. <p>
  1901. (<em>Appears on:</em>
  1902. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1903. </p>
  1904. <p>
  1905. <p>Configuration used to authenticate with Azure.</p>
  1906. </p>
  1907. <table>
  1908. <thead>
  1909. <tr>
  1910. <th>Field</th>
  1911. <th>Description</th>
  1912. </tr>
  1913. </thead>
  1914. <tbody>
  1915. <tr>
  1916. <td>
  1917. <code>clientId</code></br>
  1918. <em>
  1919. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1920. External Secrets meta/v1.SecretKeySelector
  1921. </a>
  1922. </em>
  1923. </td>
  1924. <td>
  1925. <em>(Optional)</em>
  1926. <p>The Azure clientId of the service principle or managed identity used for authentication.</p>
  1927. </td>
  1928. </tr>
  1929. <tr>
  1930. <td>
  1931. <code>tenantId</code></br>
  1932. <em>
  1933. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1934. External Secrets meta/v1.SecretKeySelector
  1935. </a>
  1936. </em>
  1937. </td>
  1938. <td>
  1939. <em>(Optional)</em>
  1940. <p>The Azure tenantId of the managed identity used for authentication.</p>
  1941. </td>
  1942. </tr>
  1943. <tr>
  1944. <td>
  1945. <code>clientSecret</code></br>
  1946. <em>
  1947. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1948. External Secrets meta/v1.SecretKeySelector
  1949. </a>
  1950. </em>
  1951. </td>
  1952. <td>
  1953. <em>(Optional)</em>
  1954. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  1955. </td>
  1956. </tr>
  1957. <tr>
  1958. <td>
  1959. <code>clientCertificate</code></br>
  1960. <em>
  1961. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1962. External Secrets meta/v1.SecretKeySelector
  1963. </a>
  1964. </em>
  1965. </td>
  1966. <td>
  1967. <em>(Optional)</em>
  1968. <p>The Azure ClientCertificate of the service principle used for authentication.</p>
  1969. </td>
  1970. </tr>
  1971. </tbody>
  1972. </table>
  1973. <h3 id="external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider
  1974. </h3>
  1975. <p>
  1976. (<em>Appears on:</em>
  1977. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1978. </p>
  1979. <p>
  1980. <p>Configures an store to sync secrets using Azure KV.</p>
  1981. </p>
  1982. <table>
  1983. <thead>
  1984. <tr>
  1985. <th>Field</th>
  1986. <th>Description</th>
  1987. </tr>
  1988. </thead>
  1989. <tbody>
  1990. <tr>
  1991. <td>
  1992. <code>authType</code></br>
  1993. <em>
  1994. <a href="#external-secrets.io/v1beta1.AzureAuthType">
  1995. AzureAuthType
  1996. </a>
  1997. </em>
  1998. </td>
  1999. <td>
  2000. <em>(Optional)</em>
  2001. <p>Auth type defines how to authenticate to the keyvault service.
  2002. Valid values are:
  2003. - &ldquo;ServicePrincipal&rdquo; (default): Using a service principal (tenantId, clientId, clientSecret)
  2004. - &ldquo;ManagedIdentity&rdquo;: Using Managed Identity assigned to the pod (see aad-pod-identity)</p>
  2005. </td>
  2006. </tr>
  2007. <tr>
  2008. <td>
  2009. <code>vaultUrl</code></br>
  2010. <em>
  2011. string
  2012. </em>
  2013. </td>
  2014. <td>
  2015. <p>Vault Url from which the secrets to be fetched from.</p>
  2016. </td>
  2017. </tr>
  2018. <tr>
  2019. <td>
  2020. <code>tenantId</code></br>
  2021. <em>
  2022. string
  2023. </em>
  2024. </td>
  2025. <td>
  2026. <em>(Optional)</em>
  2027. <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type. Optional for WorkloadIdentity.</p>
  2028. </td>
  2029. </tr>
  2030. <tr>
  2031. <td>
  2032. <code>environmentType</code></br>
  2033. <em>
  2034. <a href="#external-secrets.io/v1beta1.AzureEnvironmentType">
  2035. AzureEnvironmentType
  2036. </a>
  2037. </em>
  2038. </td>
  2039. <td>
  2040. <p>EnvironmentType specifies the Azure cloud environment endpoints to use for
  2041. connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
  2042. 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>
  2043. PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
  2044. </td>
  2045. </tr>
  2046. <tr>
  2047. <td>
  2048. <code>authSecretRef</code></br>
  2049. <em>
  2050. <a href="#external-secrets.io/v1beta1.AzureKVAuth">
  2051. AzureKVAuth
  2052. </a>
  2053. </em>
  2054. </td>
  2055. <td>
  2056. <em>(Optional)</em>
  2057. <p>Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type. Optional for WorkloadIdentity.</p>
  2058. </td>
  2059. </tr>
  2060. <tr>
  2061. <td>
  2062. <code>serviceAccountRef</code></br>
  2063. <em>
  2064. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  2065. External Secrets meta/v1.ServiceAccountSelector
  2066. </a>
  2067. </em>
  2068. </td>
  2069. <td>
  2070. <em>(Optional)</em>
  2071. <p>ServiceAccountRef specified the service account
  2072. that should be used when authenticating with WorkloadIdentity.</p>
  2073. </td>
  2074. </tr>
  2075. <tr>
  2076. <td>
  2077. <code>identityId</code></br>
  2078. <em>
  2079. string
  2080. </em>
  2081. </td>
  2082. <td>
  2083. <em>(Optional)</em>
  2084. <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
  2085. </td>
  2086. </tr>
  2087. </tbody>
  2088. </table>
  2089. <h3 id="external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">BeyondTrustProviderSecretRef
  2090. </h3>
  2091. <p>
  2092. (<em>Appears on:</em>
  2093. <a href="#external-secrets.io/v1beta1.BeyondtrustAuth">BeyondtrustAuth</a>)
  2094. </p>
  2095. <p>
  2096. </p>
  2097. <table>
  2098. <thead>
  2099. <tr>
  2100. <th>Field</th>
  2101. <th>Description</th>
  2102. </tr>
  2103. </thead>
  2104. <tbody>
  2105. <tr>
  2106. <td>
  2107. <code>value</code></br>
  2108. <em>
  2109. string
  2110. </em>
  2111. </td>
  2112. <td>
  2113. <em>(Optional)</em>
  2114. <p>Value can be specified directly to set a value without using a secret.</p>
  2115. </td>
  2116. </tr>
  2117. <tr>
  2118. <td>
  2119. <code>secretRef</code></br>
  2120. <em>
  2121. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2122. External Secrets meta/v1.SecretKeySelector
  2123. </a>
  2124. </em>
  2125. </td>
  2126. <td>
  2127. <em>(Optional)</em>
  2128. <p>SecretRef references a key in a secret that will be used as value.</p>
  2129. </td>
  2130. </tr>
  2131. </tbody>
  2132. </table>
  2133. <h3 id="external-secrets.io/v1beta1.BeyondtrustAuth">BeyondtrustAuth
  2134. </h3>
  2135. <p>
  2136. (<em>Appears on:</em>
  2137. <a href="#external-secrets.io/v1beta1.BeyondtrustProvider">BeyondtrustProvider</a>)
  2138. </p>
  2139. <p>
  2140. <p>Configures a store to sync secrets using BeyondTrust Password Safe.</p>
  2141. </p>
  2142. <table>
  2143. <thead>
  2144. <tr>
  2145. <th>Field</th>
  2146. <th>Description</th>
  2147. </tr>
  2148. </thead>
  2149. <tbody>
  2150. <tr>
  2151. <td>
  2152. <code>apiKey</code></br>
  2153. <em>
  2154. <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
  2155. BeyondTrustProviderSecretRef
  2156. </a>
  2157. </em>
  2158. </td>
  2159. <td>
  2160. <p>APIKey If not provided then ClientID/ClientSecret become required.</p>
  2161. </td>
  2162. </tr>
  2163. <tr>
  2164. <td>
  2165. <code>clientId</code></br>
  2166. <em>
  2167. <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
  2168. BeyondTrustProviderSecretRef
  2169. </a>
  2170. </em>
  2171. </td>
  2172. <td>
  2173. <p>ClientID is the API OAuth Client ID.</p>
  2174. </td>
  2175. </tr>
  2176. <tr>
  2177. <td>
  2178. <code>clientSecret</code></br>
  2179. <em>
  2180. <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
  2181. BeyondTrustProviderSecretRef
  2182. </a>
  2183. </em>
  2184. </td>
  2185. <td>
  2186. <p>ClientSecret is the API OAuth Client Secret.</p>
  2187. </td>
  2188. </tr>
  2189. <tr>
  2190. <td>
  2191. <code>certificate</code></br>
  2192. <em>
  2193. <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
  2194. BeyondTrustProviderSecretRef
  2195. </a>
  2196. </em>
  2197. </td>
  2198. <td>
  2199. <p>Certificate (cert.pem) for use when authenticating with an OAuth client Id using a Client Certificate.</p>
  2200. </td>
  2201. </tr>
  2202. <tr>
  2203. <td>
  2204. <code>certificateKey</code></br>
  2205. <em>
  2206. <a href="#external-secrets.io/v1beta1.BeyondTrustProviderSecretRef">
  2207. BeyondTrustProviderSecretRef
  2208. </a>
  2209. </em>
  2210. </td>
  2211. <td>
  2212. <p>Certificate private key (key.pem). For use when authenticating with an OAuth client Id</p>
  2213. </td>
  2214. </tr>
  2215. </tbody>
  2216. </table>
  2217. <h3 id="external-secrets.io/v1beta1.BeyondtrustProvider">BeyondtrustProvider
  2218. </h3>
  2219. <p>
  2220. (<em>Appears on:</em>
  2221. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2222. </p>
  2223. <p>
  2224. </p>
  2225. <table>
  2226. <thead>
  2227. <tr>
  2228. <th>Field</th>
  2229. <th>Description</th>
  2230. </tr>
  2231. </thead>
  2232. <tbody>
  2233. <tr>
  2234. <td>
  2235. <code>auth</code></br>
  2236. <em>
  2237. <a href="#external-secrets.io/v1beta1.BeyondtrustAuth">
  2238. BeyondtrustAuth
  2239. </a>
  2240. </em>
  2241. </td>
  2242. <td>
  2243. <p>Auth configures how the operator authenticates with Beyondtrust.</p>
  2244. </td>
  2245. </tr>
  2246. <tr>
  2247. <td>
  2248. <code>server</code></br>
  2249. <em>
  2250. <a href="#external-secrets.io/v1beta1.BeyondtrustServer">
  2251. BeyondtrustServer
  2252. </a>
  2253. </em>
  2254. </td>
  2255. <td>
  2256. <p>Auth configures how API server works.</p>
  2257. </td>
  2258. </tr>
  2259. </tbody>
  2260. </table>
  2261. <h3 id="external-secrets.io/v1beta1.BeyondtrustServer">BeyondtrustServer
  2262. </h3>
  2263. <p>
  2264. (<em>Appears on:</em>
  2265. <a href="#external-secrets.io/v1beta1.BeyondtrustProvider">BeyondtrustProvider</a>)
  2266. </p>
  2267. <p>
  2268. <p>Configures a store to sync secrets using BeyondTrust Password Safe.</p>
  2269. </p>
  2270. <table>
  2271. <thead>
  2272. <tr>
  2273. <th>Field</th>
  2274. <th>Description</th>
  2275. </tr>
  2276. </thead>
  2277. <tbody>
  2278. <tr>
  2279. <td>
  2280. <code>apiUrl</code></br>
  2281. <em>
  2282. string
  2283. </em>
  2284. </td>
  2285. <td>
  2286. </td>
  2287. </tr>
  2288. <tr>
  2289. <td>
  2290. <code>retrievalType</code></br>
  2291. <em>
  2292. string
  2293. </em>
  2294. </td>
  2295. <td>
  2296. <p>The secret retrieval type. SECRET = Secrets Safe (credential, text, file). MANAGED_ACCOUNT = Password Safe account associated with a system.</p>
  2297. </td>
  2298. </tr>
  2299. <tr>
  2300. <td>
  2301. <code>separator</code></br>
  2302. <em>
  2303. string
  2304. </em>
  2305. </td>
  2306. <td>
  2307. <p>A character that separates the folder names.</p>
  2308. </td>
  2309. </tr>
  2310. <tr>
  2311. <td>
  2312. <code>verifyCA</code></br>
  2313. <em>
  2314. bool
  2315. </em>
  2316. </td>
  2317. <td>
  2318. </td>
  2319. </tr>
  2320. <tr>
  2321. <td>
  2322. <code>clientTimeOutSeconds</code></br>
  2323. <em>
  2324. int
  2325. </em>
  2326. </td>
  2327. <td>
  2328. <p>Timeout specifies a time limit for requests made by this Client. The timeout includes connection time, any redirects, and reading the response body. Defaults to 45 seconds.</p>
  2329. </td>
  2330. </tr>
  2331. </tbody>
  2332. </table>
  2333. <h3 id="external-secrets.io/v1beta1.BitwardenSecretsManagerAuth">BitwardenSecretsManagerAuth
  2334. </h3>
  2335. <p>
  2336. (<em>Appears on:</em>
  2337. <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerProvider">BitwardenSecretsManagerProvider</a>)
  2338. </p>
  2339. <p>
  2340. <p>BitwardenSecretsManagerAuth contains the ref to the secret that contains the machine account token.</p>
  2341. </p>
  2342. <table>
  2343. <thead>
  2344. <tr>
  2345. <th>Field</th>
  2346. <th>Description</th>
  2347. </tr>
  2348. </thead>
  2349. <tbody>
  2350. <tr>
  2351. <td>
  2352. <code>secretRef</code></br>
  2353. <em>
  2354. <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerSecretRef">
  2355. BitwardenSecretsManagerSecretRef
  2356. </a>
  2357. </em>
  2358. </td>
  2359. <td>
  2360. </td>
  2361. </tr>
  2362. </tbody>
  2363. </table>
  2364. <h3 id="external-secrets.io/v1beta1.BitwardenSecretsManagerProvider">BitwardenSecretsManagerProvider
  2365. </h3>
  2366. <p>
  2367. (<em>Appears on:</em>
  2368. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2369. </p>
  2370. <p>
  2371. <p>BitwardenSecretsManagerProvider configures a store to sync secrets with a Bitwarden Secrets Manager instance.</p>
  2372. </p>
  2373. <table>
  2374. <thead>
  2375. <tr>
  2376. <th>Field</th>
  2377. <th>Description</th>
  2378. </tr>
  2379. </thead>
  2380. <tbody>
  2381. <tr>
  2382. <td>
  2383. <code>apiURL</code></br>
  2384. <em>
  2385. string
  2386. </em>
  2387. </td>
  2388. <td>
  2389. </td>
  2390. </tr>
  2391. <tr>
  2392. <td>
  2393. <code>identityURL</code></br>
  2394. <em>
  2395. string
  2396. </em>
  2397. </td>
  2398. <td>
  2399. </td>
  2400. </tr>
  2401. <tr>
  2402. <td>
  2403. <code>bitwardenServerSDKURL</code></br>
  2404. <em>
  2405. string
  2406. </em>
  2407. </td>
  2408. <td>
  2409. </td>
  2410. </tr>
  2411. <tr>
  2412. <td>
  2413. <code>caBundle</code></br>
  2414. <em>
  2415. string
  2416. </em>
  2417. </td>
  2418. <td>
  2419. <em>(Optional)</em>
  2420. <p>Base64 encoded certificate for the bitwarden server sdk. The sdk MUST run with HTTPS to make sure no MITM attack
  2421. can be performed.</p>
  2422. </td>
  2423. </tr>
  2424. <tr>
  2425. <td>
  2426. <code>caProvider</code></br>
  2427. <em>
  2428. <a href="#external-secrets.io/v1beta1.CAProvider">
  2429. CAProvider
  2430. </a>
  2431. </em>
  2432. </td>
  2433. <td>
  2434. <em>(Optional)</em>
  2435. <p>see: <a href="https://external-secrets.io/latest/spec/#external-secrets.io/v1alpha1.CAProvider">https://external-secrets.io/latest/spec/#external-secrets.io/v1alpha1.CAProvider</a></p>
  2436. </td>
  2437. </tr>
  2438. <tr>
  2439. <td>
  2440. <code>organizationID</code></br>
  2441. <em>
  2442. string
  2443. </em>
  2444. </td>
  2445. <td>
  2446. <p>OrganizationID determines which organization this secret store manages.</p>
  2447. </td>
  2448. </tr>
  2449. <tr>
  2450. <td>
  2451. <code>projectID</code></br>
  2452. <em>
  2453. string
  2454. </em>
  2455. </td>
  2456. <td>
  2457. <p>ProjectID determines which project this secret store manages.</p>
  2458. </td>
  2459. </tr>
  2460. <tr>
  2461. <td>
  2462. <code>auth</code></br>
  2463. <em>
  2464. <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerAuth">
  2465. BitwardenSecretsManagerAuth
  2466. </a>
  2467. </em>
  2468. </td>
  2469. <td>
  2470. <p>Auth configures how secret-manager authenticates with a bitwarden machine account instance.
  2471. Make sure that the token being used has permissions on the given secret.</p>
  2472. </td>
  2473. </tr>
  2474. </tbody>
  2475. </table>
  2476. <h3 id="external-secrets.io/v1beta1.BitwardenSecretsManagerSecretRef">BitwardenSecretsManagerSecretRef
  2477. </h3>
  2478. <p>
  2479. (<em>Appears on:</em>
  2480. <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerAuth">BitwardenSecretsManagerAuth</a>)
  2481. </p>
  2482. <p>
  2483. <p>BitwardenSecretsManagerSecretRef contains the credential ref to the bitwarden instance.</p>
  2484. </p>
  2485. <table>
  2486. <thead>
  2487. <tr>
  2488. <th>Field</th>
  2489. <th>Description</th>
  2490. </tr>
  2491. </thead>
  2492. <tbody>
  2493. <tr>
  2494. <td>
  2495. <code>credentials</code></br>
  2496. <em>
  2497. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2498. External Secrets meta/v1.SecretKeySelector
  2499. </a>
  2500. </em>
  2501. </td>
  2502. <td>
  2503. <p>AccessToken used for the bitwarden instance.</p>
  2504. </td>
  2505. </tr>
  2506. </tbody>
  2507. </table>
  2508. <h3 id="external-secrets.io/v1beta1.CAProvider">CAProvider
  2509. </h3>
  2510. <p>
  2511. (<em>Appears on:</em>
  2512. <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>,
  2513. <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerProvider">BitwardenSecretsManagerProvider</a>,
  2514. <a href="#external-secrets.io/v1beta1.ConjurProvider">ConjurProvider</a>,
  2515. <a href="#external-secrets.io/v1beta1.KubernetesServer">KubernetesServer</a>,
  2516. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  2517. </p>
  2518. <p>
  2519. <p>Used to provide custom certificate authority (CA) certificates
  2520. for a secret store. The CAProvider points to a Secret or ConfigMap resource
  2521. that contains a PEM-encoded certificate.</p>
  2522. </p>
  2523. <table>
  2524. <thead>
  2525. <tr>
  2526. <th>Field</th>
  2527. <th>Description</th>
  2528. </tr>
  2529. </thead>
  2530. <tbody>
  2531. <tr>
  2532. <td>
  2533. <code>type</code></br>
  2534. <em>
  2535. <a href="#external-secrets.io/v1beta1.CAProviderType">
  2536. CAProviderType
  2537. </a>
  2538. </em>
  2539. </td>
  2540. <td>
  2541. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  2542. </td>
  2543. </tr>
  2544. <tr>
  2545. <td>
  2546. <code>name</code></br>
  2547. <em>
  2548. string
  2549. </em>
  2550. </td>
  2551. <td>
  2552. <p>The name of the object located at the provider type.</p>
  2553. </td>
  2554. </tr>
  2555. <tr>
  2556. <td>
  2557. <code>key</code></br>
  2558. <em>
  2559. string
  2560. </em>
  2561. </td>
  2562. <td>
  2563. <p>The key where the CA certificate can be found in the Secret or ConfigMap.</p>
  2564. </td>
  2565. </tr>
  2566. <tr>
  2567. <td>
  2568. <code>namespace</code></br>
  2569. <em>
  2570. string
  2571. </em>
  2572. </td>
  2573. <td>
  2574. <em>(Optional)</em>
  2575. <p>The namespace the Provider type is in.
  2576. Can only be defined when used in a ClusterSecretStore.</p>
  2577. </td>
  2578. </tr>
  2579. </tbody>
  2580. </table>
  2581. <h3 id="external-secrets.io/v1beta1.CAProviderType">CAProviderType
  2582. (<code>string</code> alias)</p></h3>
  2583. <p>
  2584. (<em>Appears on:</em>
  2585. <a href="#external-secrets.io/v1beta1.CAProvider">CAProvider</a>)
  2586. </p>
  2587. <p>
  2588. </p>
  2589. <table>
  2590. <thead>
  2591. <tr>
  2592. <th>Value</th>
  2593. <th>Description</th>
  2594. </tr>
  2595. </thead>
  2596. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  2597. <td></td>
  2598. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  2599. <td></td>
  2600. </tr></tbody>
  2601. </table>
  2602. <h3 id="external-secrets.io/v1beta1.CertAuth">CertAuth
  2603. </h3>
  2604. <p>
  2605. (<em>Appears on:</em>
  2606. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  2607. </p>
  2608. <p>
  2609. </p>
  2610. <table>
  2611. <thead>
  2612. <tr>
  2613. <th>Field</th>
  2614. <th>Description</th>
  2615. </tr>
  2616. </thead>
  2617. <tbody>
  2618. <tr>
  2619. <td>
  2620. <code>clientCert</code></br>
  2621. <em>
  2622. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2623. External Secrets meta/v1.SecretKeySelector
  2624. </a>
  2625. </em>
  2626. </td>
  2627. <td>
  2628. </td>
  2629. </tr>
  2630. <tr>
  2631. <td>
  2632. <code>clientKey</code></br>
  2633. <em>
  2634. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2635. External Secrets meta/v1.SecretKeySelector
  2636. </a>
  2637. </em>
  2638. </td>
  2639. <td>
  2640. </td>
  2641. </tr>
  2642. </tbody>
  2643. </table>
  2644. <h3 id="external-secrets.io/v1beta1.ChefAuth">ChefAuth
  2645. </h3>
  2646. <p>
  2647. (<em>Appears on:</em>
  2648. <a href="#external-secrets.io/v1beta1.ChefProvider">ChefProvider</a>)
  2649. </p>
  2650. <p>
  2651. <p>ChefAuth contains a secretRef for credentials.</p>
  2652. </p>
  2653. <table>
  2654. <thead>
  2655. <tr>
  2656. <th>Field</th>
  2657. <th>Description</th>
  2658. </tr>
  2659. </thead>
  2660. <tbody>
  2661. <tr>
  2662. <td>
  2663. <code>secretRef</code></br>
  2664. <em>
  2665. <a href="#external-secrets.io/v1beta1.ChefAuthSecretRef">
  2666. ChefAuthSecretRef
  2667. </a>
  2668. </em>
  2669. </td>
  2670. <td>
  2671. </td>
  2672. </tr>
  2673. </tbody>
  2674. </table>
  2675. <h3 id="external-secrets.io/v1beta1.ChefAuthSecretRef">ChefAuthSecretRef
  2676. </h3>
  2677. <p>
  2678. (<em>Appears on:</em>
  2679. <a href="#external-secrets.io/v1beta1.ChefAuth">ChefAuth</a>)
  2680. </p>
  2681. <p>
  2682. <p>ChefAuthSecretRef holds secret references for chef server login credentials.</p>
  2683. </p>
  2684. <table>
  2685. <thead>
  2686. <tr>
  2687. <th>Field</th>
  2688. <th>Description</th>
  2689. </tr>
  2690. </thead>
  2691. <tbody>
  2692. <tr>
  2693. <td>
  2694. <code>privateKeySecretRef</code></br>
  2695. <em>
  2696. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2697. External Secrets meta/v1.SecretKeySelector
  2698. </a>
  2699. </em>
  2700. </td>
  2701. <td>
  2702. <p>SecretKey is the Signing Key in PEM format, used for authentication.</p>
  2703. </td>
  2704. </tr>
  2705. </tbody>
  2706. </table>
  2707. <h3 id="external-secrets.io/v1beta1.ChefProvider">ChefProvider
  2708. </h3>
  2709. <p>
  2710. (<em>Appears on:</em>
  2711. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2712. </p>
  2713. <p>
  2714. <p>ChefProvider configures a store to sync secrets using basic chef server connection credentials.</p>
  2715. </p>
  2716. <table>
  2717. <thead>
  2718. <tr>
  2719. <th>Field</th>
  2720. <th>Description</th>
  2721. </tr>
  2722. </thead>
  2723. <tbody>
  2724. <tr>
  2725. <td>
  2726. <code>auth</code></br>
  2727. <em>
  2728. <a href="#external-secrets.io/v1beta1.ChefAuth">
  2729. ChefAuth
  2730. </a>
  2731. </em>
  2732. </td>
  2733. <td>
  2734. <p>Auth defines the information necessary to authenticate against chef Server</p>
  2735. </td>
  2736. </tr>
  2737. <tr>
  2738. <td>
  2739. <code>username</code></br>
  2740. <em>
  2741. string
  2742. </em>
  2743. </td>
  2744. <td>
  2745. <p>UserName should be the user ID on the chef server</p>
  2746. </td>
  2747. </tr>
  2748. <tr>
  2749. <td>
  2750. <code>serverUrl</code></br>
  2751. <em>
  2752. string
  2753. </em>
  2754. </td>
  2755. <td>
  2756. <p>ServerURL is the chef server URL used to connect to. If using orgs you should include your org in the url and terminate the url with a &ldquo;/&rdquo;</p>
  2757. </td>
  2758. </tr>
  2759. </tbody>
  2760. </table>
  2761. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret
  2762. </h3>
  2763. <p>
  2764. <p>ClusterExternalSecret is the Schema for the clusterexternalsecrets API.</p>
  2765. </p>
  2766. <table>
  2767. <thead>
  2768. <tr>
  2769. <th>Field</th>
  2770. <th>Description</th>
  2771. </tr>
  2772. </thead>
  2773. <tbody>
  2774. <tr>
  2775. <td>
  2776. <code>metadata</code></br>
  2777. <em>
  2778. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  2779. Kubernetes meta/v1.ObjectMeta
  2780. </a>
  2781. </em>
  2782. </td>
  2783. <td>
  2784. Refer to the Kubernetes API documentation for the fields of the
  2785. <code>metadata</code> field.
  2786. </td>
  2787. </tr>
  2788. <tr>
  2789. <td>
  2790. <code>spec</code></br>
  2791. <em>
  2792. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">
  2793. ClusterExternalSecretSpec
  2794. </a>
  2795. </em>
  2796. </td>
  2797. <td>
  2798. <br/>
  2799. <br/>
  2800. <table>
  2801. <tr>
  2802. <td>
  2803. <code>externalSecretSpec</code></br>
  2804. <em>
  2805. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  2806. ExternalSecretSpec
  2807. </a>
  2808. </em>
  2809. </td>
  2810. <td>
  2811. <p>The spec for the ExternalSecrets to be created</p>
  2812. </td>
  2813. </tr>
  2814. <tr>
  2815. <td>
  2816. <code>externalSecretName</code></br>
  2817. <em>
  2818. string
  2819. </em>
  2820. </td>
  2821. <td>
  2822. <em>(Optional)</em>
  2823. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  2824. </td>
  2825. </tr>
  2826. <tr>
  2827. <td>
  2828. <code>externalSecretMetadata</code></br>
  2829. <em>
  2830. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadata">
  2831. ExternalSecretMetadata
  2832. </a>
  2833. </em>
  2834. </td>
  2835. <td>
  2836. <em>(Optional)</em>
  2837. <p>The metadata of the external secrets to be created</p>
  2838. </td>
  2839. </tr>
  2840. <tr>
  2841. <td>
  2842. <code>namespaceSelector</code></br>
  2843. <em>
  2844. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  2845. Kubernetes meta/v1.LabelSelector
  2846. </a>
  2847. </em>
  2848. </td>
  2849. <td>
  2850. <em>(Optional)</em>
  2851. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.
  2852. Deprecated: Use NamespaceSelectors instead.</p>
  2853. </td>
  2854. </tr>
  2855. <tr>
  2856. <td>
  2857. <code>namespaceSelectors</code></br>
  2858. <em>
  2859. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#*k8s.io/apimachinery/pkg/apis/meta/v1.labelselector--">
  2860. []*k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector
  2861. </a>
  2862. </em>
  2863. </td>
  2864. <td>
  2865. <em>(Optional)</em>
  2866. <p>A list of labels to select by to find the Namespaces to create the ExternalSecrets in. The selectors are ORed.</p>
  2867. </td>
  2868. </tr>
  2869. <tr>
  2870. <td>
  2871. <code>namespaces</code></br>
  2872. <em>
  2873. []string
  2874. </em>
  2875. </td>
  2876. <td>
  2877. <em>(Optional)</em>
  2878. <p>Choose namespaces by name. This field is ORed with anything that NamespaceSelectors ends up choosing.</p>
  2879. </td>
  2880. </tr>
  2881. <tr>
  2882. <td>
  2883. <code>refreshTime</code></br>
  2884. <em>
  2885. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  2886. Kubernetes meta/v1.Duration
  2887. </a>
  2888. </em>
  2889. </td>
  2890. <td>
  2891. <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
  2892. </td>
  2893. </tr>
  2894. </table>
  2895. </td>
  2896. </tr>
  2897. <tr>
  2898. <td>
  2899. <code>status</code></br>
  2900. <em>
  2901. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">
  2902. ClusterExternalSecretStatus
  2903. </a>
  2904. </em>
  2905. </td>
  2906. <td>
  2907. </td>
  2908. </tr>
  2909. </tbody>
  2910. </table>
  2911. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretConditionType">ClusterExternalSecretConditionType
  2912. (<code>string</code> alias)</p></h3>
  2913. <p>
  2914. (<em>Appears on:</em>
  2915. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition</a>)
  2916. </p>
  2917. <p>
  2918. </p>
  2919. <table>
  2920. <thead>
  2921. <tr>
  2922. <th>Value</th>
  2923. <th>Description</th>
  2924. </tr>
  2925. </thead>
  2926. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  2927. <td></td>
  2928. </tr></tbody>
  2929. </table>
  2930. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">ClusterExternalSecretNamespaceFailure
  2931. </h3>
  2932. <p>
  2933. (<em>Appears on:</em>
  2934. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  2935. </p>
  2936. <p>
  2937. <p>ClusterExternalSecretNamespaceFailure represents a failed namespace deployment and it&rsquo;s reason.</p>
  2938. </p>
  2939. <table>
  2940. <thead>
  2941. <tr>
  2942. <th>Field</th>
  2943. <th>Description</th>
  2944. </tr>
  2945. </thead>
  2946. <tbody>
  2947. <tr>
  2948. <td>
  2949. <code>namespace</code></br>
  2950. <em>
  2951. string
  2952. </em>
  2953. </td>
  2954. <td>
  2955. <p>Namespace is the namespace that failed when trying to apply an ExternalSecret</p>
  2956. </td>
  2957. </tr>
  2958. <tr>
  2959. <td>
  2960. <code>reason</code></br>
  2961. <em>
  2962. string
  2963. </em>
  2964. </td>
  2965. <td>
  2966. <em>(Optional)</em>
  2967. <p>Reason is why the ExternalSecret failed to apply to the namespace</p>
  2968. </td>
  2969. </tr>
  2970. </tbody>
  2971. </table>
  2972. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec
  2973. </h3>
  2974. <p>
  2975. (<em>Appears on:</em>
  2976. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  2977. </p>
  2978. <p>
  2979. <p>ClusterExternalSecretSpec defines the desired state of ClusterExternalSecret.</p>
  2980. </p>
  2981. <table>
  2982. <thead>
  2983. <tr>
  2984. <th>Field</th>
  2985. <th>Description</th>
  2986. </tr>
  2987. </thead>
  2988. <tbody>
  2989. <tr>
  2990. <td>
  2991. <code>externalSecretSpec</code></br>
  2992. <em>
  2993. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  2994. ExternalSecretSpec
  2995. </a>
  2996. </em>
  2997. </td>
  2998. <td>
  2999. <p>The spec for the ExternalSecrets to be created</p>
  3000. </td>
  3001. </tr>
  3002. <tr>
  3003. <td>
  3004. <code>externalSecretName</code></br>
  3005. <em>
  3006. string
  3007. </em>
  3008. </td>
  3009. <td>
  3010. <em>(Optional)</em>
  3011. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  3012. </td>
  3013. </tr>
  3014. <tr>
  3015. <td>
  3016. <code>externalSecretMetadata</code></br>
  3017. <em>
  3018. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadata">
  3019. ExternalSecretMetadata
  3020. </a>
  3021. </em>
  3022. </td>
  3023. <td>
  3024. <em>(Optional)</em>
  3025. <p>The metadata of the external secrets to be created</p>
  3026. </td>
  3027. </tr>
  3028. <tr>
  3029. <td>
  3030. <code>namespaceSelector</code></br>
  3031. <em>
  3032. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  3033. Kubernetes meta/v1.LabelSelector
  3034. </a>
  3035. </em>
  3036. </td>
  3037. <td>
  3038. <em>(Optional)</em>
  3039. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.
  3040. Deprecated: Use NamespaceSelectors instead.</p>
  3041. </td>
  3042. </tr>
  3043. <tr>
  3044. <td>
  3045. <code>namespaceSelectors</code></br>
  3046. <em>
  3047. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#*k8s.io/apimachinery/pkg/apis/meta/v1.labelselector--">
  3048. []*k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector
  3049. </a>
  3050. </em>
  3051. </td>
  3052. <td>
  3053. <em>(Optional)</em>
  3054. <p>A list of labels to select by to find the Namespaces to create the ExternalSecrets in. The selectors are ORed.</p>
  3055. </td>
  3056. </tr>
  3057. <tr>
  3058. <td>
  3059. <code>namespaces</code></br>
  3060. <em>
  3061. []string
  3062. </em>
  3063. </td>
  3064. <td>
  3065. <em>(Optional)</em>
  3066. <p>Choose namespaces by name. This field is ORed with anything that NamespaceSelectors ends up choosing.</p>
  3067. </td>
  3068. </tr>
  3069. <tr>
  3070. <td>
  3071. <code>refreshTime</code></br>
  3072. <em>
  3073. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  3074. Kubernetes meta/v1.Duration
  3075. </a>
  3076. </em>
  3077. </td>
  3078. <td>
  3079. <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
  3080. </td>
  3081. </tr>
  3082. </tbody>
  3083. </table>
  3084. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus
  3085. </h3>
  3086. <p>
  3087. (<em>Appears on:</em>
  3088. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  3089. </p>
  3090. <p>
  3091. <p>ClusterExternalSecretStatus defines the observed state of ClusterExternalSecret.</p>
  3092. </p>
  3093. <table>
  3094. <thead>
  3095. <tr>
  3096. <th>Field</th>
  3097. <th>Description</th>
  3098. </tr>
  3099. </thead>
  3100. <tbody>
  3101. <tr>
  3102. <td>
  3103. <code>externalSecretName</code></br>
  3104. <em>
  3105. string
  3106. </em>
  3107. </td>
  3108. <td>
  3109. <p>ExternalSecretName is the name of the ExternalSecrets created by the ClusterExternalSecret</p>
  3110. </td>
  3111. </tr>
  3112. <tr>
  3113. <td>
  3114. <code>failedNamespaces</code></br>
  3115. <em>
  3116. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">
  3117. []ClusterExternalSecretNamespaceFailure
  3118. </a>
  3119. </em>
  3120. </td>
  3121. <td>
  3122. <em>(Optional)</em>
  3123. <p>Failed namespaces are the namespaces that failed to apply an ExternalSecret</p>
  3124. </td>
  3125. </tr>
  3126. <tr>
  3127. <td>
  3128. <code>provisionedNamespaces</code></br>
  3129. <em>
  3130. []string
  3131. </em>
  3132. </td>
  3133. <td>
  3134. <em>(Optional)</em>
  3135. <p>ProvisionedNamespaces are the namespaces where the ClusterExternalSecret has secrets</p>
  3136. </td>
  3137. </tr>
  3138. <tr>
  3139. <td>
  3140. <code>conditions</code></br>
  3141. <em>
  3142. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">
  3143. []ClusterExternalSecretStatusCondition
  3144. </a>
  3145. </em>
  3146. </td>
  3147. <td>
  3148. <em>(Optional)</em>
  3149. </td>
  3150. </tr>
  3151. </tbody>
  3152. </table>
  3153. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition
  3154. </h3>
  3155. <p>
  3156. (<em>Appears on:</em>
  3157. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  3158. </p>
  3159. <p>
  3160. </p>
  3161. <table>
  3162. <thead>
  3163. <tr>
  3164. <th>Field</th>
  3165. <th>Description</th>
  3166. </tr>
  3167. </thead>
  3168. <tbody>
  3169. <tr>
  3170. <td>
  3171. <code>type</code></br>
  3172. <em>
  3173. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretConditionType">
  3174. ClusterExternalSecretConditionType
  3175. </a>
  3176. </em>
  3177. </td>
  3178. <td>
  3179. </td>
  3180. </tr>
  3181. <tr>
  3182. <td>
  3183. <code>status</code></br>
  3184. <em>
  3185. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  3186. Kubernetes core/v1.ConditionStatus
  3187. </a>
  3188. </em>
  3189. </td>
  3190. <td>
  3191. </td>
  3192. </tr>
  3193. <tr>
  3194. <td>
  3195. <code>message</code></br>
  3196. <em>
  3197. string
  3198. </em>
  3199. </td>
  3200. <td>
  3201. <em>(Optional)</em>
  3202. </td>
  3203. </tr>
  3204. </tbody>
  3205. </table>
  3206. <h3 id="external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore
  3207. </h3>
  3208. <p>
  3209. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  3210. </p>
  3211. <table>
  3212. <thead>
  3213. <tr>
  3214. <th>Field</th>
  3215. <th>Description</th>
  3216. </tr>
  3217. </thead>
  3218. <tbody>
  3219. <tr>
  3220. <td>
  3221. <code>metadata</code></br>
  3222. <em>
  3223. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  3224. Kubernetes meta/v1.ObjectMeta
  3225. </a>
  3226. </em>
  3227. </td>
  3228. <td>
  3229. Refer to the Kubernetes API documentation for the fields of the
  3230. <code>metadata</code> field.
  3231. </td>
  3232. </tr>
  3233. <tr>
  3234. <td>
  3235. <code>spec</code></br>
  3236. <em>
  3237. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  3238. SecretStoreSpec
  3239. </a>
  3240. </em>
  3241. </td>
  3242. <td>
  3243. <br/>
  3244. <br/>
  3245. <table>
  3246. <tr>
  3247. <td>
  3248. <code>controller</code></br>
  3249. <em>
  3250. string
  3251. </em>
  3252. </td>
  3253. <td>
  3254. <em>(Optional)</em>
  3255. <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
  3256. The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
  3257. </td>
  3258. </tr>
  3259. <tr>
  3260. <td>
  3261. <code>provider</code></br>
  3262. <em>
  3263. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  3264. SecretStoreProvider
  3265. </a>
  3266. </em>
  3267. </td>
  3268. <td>
  3269. <p>Used to configure the provider. Only one provider may be set</p>
  3270. </td>
  3271. </tr>
  3272. <tr>
  3273. <td>
  3274. <code>retrySettings</code></br>
  3275. <em>
  3276. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  3277. SecretStoreRetrySettings
  3278. </a>
  3279. </em>
  3280. </td>
  3281. <td>
  3282. <em>(Optional)</em>
  3283. <p>Used to configure http retries if failed</p>
  3284. </td>
  3285. </tr>
  3286. <tr>
  3287. <td>
  3288. <code>refreshInterval</code></br>
  3289. <em>
  3290. int
  3291. </em>
  3292. </td>
  3293. <td>
  3294. <em>(Optional)</em>
  3295. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  3296. </td>
  3297. </tr>
  3298. <tr>
  3299. <td>
  3300. <code>conditions</code></br>
  3301. <em>
  3302. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  3303. []ClusterSecretStoreCondition
  3304. </a>
  3305. </em>
  3306. </td>
  3307. <td>
  3308. <em>(Optional)</em>
  3309. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  3310. </td>
  3311. </tr>
  3312. </table>
  3313. </td>
  3314. </tr>
  3315. <tr>
  3316. <td>
  3317. <code>status</code></br>
  3318. <em>
  3319. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  3320. SecretStoreStatus
  3321. </a>
  3322. </em>
  3323. </td>
  3324. <td>
  3325. </td>
  3326. </tr>
  3327. </tbody>
  3328. </table>
  3329. <h3 id="external-secrets.io/v1beta1.ClusterSecretStoreCondition">ClusterSecretStoreCondition
  3330. </h3>
  3331. <p>
  3332. (<em>Appears on:</em>
  3333. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  3334. </p>
  3335. <p>
  3336. <p>ClusterSecretStoreCondition describes a condition by which to choose namespaces to process ExternalSecrets in
  3337. for a ClusterSecretStore instance.</p>
  3338. </p>
  3339. <table>
  3340. <thead>
  3341. <tr>
  3342. <th>Field</th>
  3343. <th>Description</th>
  3344. </tr>
  3345. </thead>
  3346. <tbody>
  3347. <tr>
  3348. <td>
  3349. <code>namespaceSelector</code></br>
  3350. <em>
  3351. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  3352. Kubernetes meta/v1.LabelSelector
  3353. </a>
  3354. </em>
  3355. </td>
  3356. <td>
  3357. <em>(Optional)</em>
  3358. <p>Choose namespace using a labelSelector</p>
  3359. </td>
  3360. </tr>
  3361. <tr>
  3362. <td>
  3363. <code>namespaces</code></br>
  3364. <em>
  3365. []string
  3366. </em>
  3367. </td>
  3368. <td>
  3369. <em>(Optional)</em>
  3370. <p>Choose namespaces by name</p>
  3371. </td>
  3372. </tr>
  3373. <tr>
  3374. <td>
  3375. <code>namespaceRegexes</code></br>
  3376. <em>
  3377. []string
  3378. </em>
  3379. </td>
  3380. <td>
  3381. <em>(Optional)</em>
  3382. <p>Choose namespaces by using regex matching</p>
  3383. </td>
  3384. </tr>
  3385. </tbody>
  3386. </table>
  3387. <h3 id="external-secrets.io/v1beta1.ConjurAPIKey">ConjurAPIKey
  3388. </h3>
  3389. <p>
  3390. (<em>Appears on:</em>
  3391. <a href="#external-secrets.io/v1beta1.ConjurAuth">ConjurAuth</a>)
  3392. </p>
  3393. <p>
  3394. </p>
  3395. <table>
  3396. <thead>
  3397. <tr>
  3398. <th>Field</th>
  3399. <th>Description</th>
  3400. </tr>
  3401. </thead>
  3402. <tbody>
  3403. <tr>
  3404. <td>
  3405. <code>account</code></br>
  3406. <em>
  3407. string
  3408. </em>
  3409. </td>
  3410. <td>
  3411. </td>
  3412. </tr>
  3413. <tr>
  3414. <td>
  3415. <code>userRef</code></br>
  3416. <em>
  3417. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3418. External Secrets meta/v1.SecretKeySelector
  3419. </a>
  3420. </em>
  3421. </td>
  3422. <td>
  3423. </td>
  3424. </tr>
  3425. <tr>
  3426. <td>
  3427. <code>apiKeyRef</code></br>
  3428. <em>
  3429. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3430. External Secrets meta/v1.SecretKeySelector
  3431. </a>
  3432. </em>
  3433. </td>
  3434. <td>
  3435. </td>
  3436. </tr>
  3437. </tbody>
  3438. </table>
  3439. <h3 id="external-secrets.io/v1beta1.ConjurAuth">ConjurAuth
  3440. </h3>
  3441. <p>
  3442. (<em>Appears on:</em>
  3443. <a href="#external-secrets.io/v1beta1.ConjurProvider">ConjurProvider</a>)
  3444. </p>
  3445. <p>
  3446. </p>
  3447. <table>
  3448. <thead>
  3449. <tr>
  3450. <th>Field</th>
  3451. <th>Description</th>
  3452. </tr>
  3453. </thead>
  3454. <tbody>
  3455. <tr>
  3456. <td>
  3457. <code>apikey</code></br>
  3458. <em>
  3459. <a href="#external-secrets.io/v1beta1.ConjurAPIKey">
  3460. ConjurAPIKey
  3461. </a>
  3462. </em>
  3463. </td>
  3464. <td>
  3465. <em>(Optional)</em>
  3466. </td>
  3467. </tr>
  3468. <tr>
  3469. <td>
  3470. <code>jwt</code></br>
  3471. <em>
  3472. <a href="#external-secrets.io/v1beta1.ConjurJWT">
  3473. ConjurJWT
  3474. </a>
  3475. </em>
  3476. </td>
  3477. <td>
  3478. <em>(Optional)</em>
  3479. </td>
  3480. </tr>
  3481. </tbody>
  3482. </table>
  3483. <h3 id="external-secrets.io/v1beta1.ConjurJWT">ConjurJWT
  3484. </h3>
  3485. <p>
  3486. (<em>Appears on:</em>
  3487. <a href="#external-secrets.io/v1beta1.ConjurAuth">ConjurAuth</a>)
  3488. </p>
  3489. <p>
  3490. </p>
  3491. <table>
  3492. <thead>
  3493. <tr>
  3494. <th>Field</th>
  3495. <th>Description</th>
  3496. </tr>
  3497. </thead>
  3498. <tbody>
  3499. <tr>
  3500. <td>
  3501. <code>account</code></br>
  3502. <em>
  3503. string
  3504. </em>
  3505. </td>
  3506. <td>
  3507. </td>
  3508. </tr>
  3509. <tr>
  3510. <td>
  3511. <code>serviceID</code></br>
  3512. <em>
  3513. string
  3514. </em>
  3515. </td>
  3516. <td>
  3517. <p>The conjur authn jwt webservice id</p>
  3518. </td>
  3519. </tr>
  3520. <tr>
  3521. <td>
  3522. <code>hostId</code></br>
  3523. <em>
  3524. string
  3525. </em>
  3526. </td>
  3527. <td>
  3528. <em>(Optional)</em>
  3529. <p>Optional HostID for JWT authentication. This may be used depending
  3530. on how the Conjur JWT authenticator policy is configured.</p>
  3531. </td>
  3532. </tr>
  3533. <tr>
  3534. <td>
  3535. <code>secretRef</code></br>
  3536. <em>
  3537. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3538. External Secrets meta/v1.SecretKeySelector
  3539. </a>
  3540. </em>
  3541. </td>
  3542. <td>
  3543. <em>(Optional)</em>
  3544. <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  3545. authenticate with Conjur using the JWT authentication method.</p>
  3546. </td>
  3547. </tr>
  3548. <tr>
  3549. <td>
  3550. <code>serviceAccountRef</code></br>
  3551. <em>
  3552. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  3553. External Secrets meta/v1.ServiceAccountSelector
  3554. </a>
  3555. </em>
  3556. </td>
  3557. <td>
  3558. <em>(Optional)</em>
  3559. <p>Optional ServiceAccountRef specifies the Kubernetes service account for which to request
  3560. a token for with the <code>TokenRequest</code> API.</p>
  3561. </td>
  3562. </tr>
  3563. </tbody>
  3564. </table>
  3565. <h3 id="external-secrets.io/v1beta1.ConjurProvider">ConjurProvider
  3566. </h3>
  3567. <p>
  3568. (<em>Appears on:</em>
  3569. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3570. </p>
  3571. <p>
  3572. </p>
  3573. <table>
  3574. <thead>
  3575. <tr>
  3576. <th>Field</th>
  3577. <th>Description</th>
  3578. </tr>
  3579. </thead>
  3580. <tbody>
  3581. <tr>
  3582. <td>
  3583. <code>url</code></br>
  3584. <em>
  3585. string
  3586. </em>
  3587. </td>
  3588. <td>
  3589. </td>
  3590. </tr>
  3591. <tr>
  3592. <td>
  3593. <code>caBundle</code></br>
  3594. <em>
  3595. string
  3596. </em>
  3597. </td>
  3598. <td>
  3599. <em>(Optional)</em>
  3600. </td>
  3601. </tr>
  3602. <tr>
  3603. <td>
  3604. <code>caProvider</code></br>
  3605. <em>
  3606. <a href="#external-secrets.io/v1beta1.CAProvider">
  3607. CAProvider
  3608. </a>
  3609. </em>
  3610. </td>
  3611. <td>
  3612. <em>(Optional)</em>
  3613. </td>
  3614. </tr>
  3615. <tr>
  3616. <td>
  3617. <code>auth</code></br>
  3618. <em>
  3619. <a href="#external-secrets.io/v1beta1.ConjurAuth">
  3620. ConjurAuth
  3621. </a>
  3622. </em>
  3623. </td>
  3624. <td>
  3625. </td>
  3626. </tr>
  3627. </tbody>
  3628. </table>
  3629. <h3 id="external-secrets.io/v1beta1.DelineaProvider">DelineaProvider
  3630. </h3>
  3631. <p>
  3632. (<em>Appears on:</em>
  3633. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3634. </p>
  3635. <p>
  3636. <p>See <a href="https://github.com/DelineaXPM/dsv-sdk-go/blob/main/vault/vault.go">https://github.com/DelineaXPM/dsv-sdk-go/blob/main/vault/vault.go</a>.</p>
  3637. </p>
  3638. <table>
  3639. <thead>
  3640. <tr>
  3641. <th>Field</th>
  3642. <th>Description</th>
  3643. </tr>
  3644. </thead>
  3645. <tbody>
  3646. <tr>
  3647. <td>
  3648. <code>clientId</code></br>
  3649. <em>
  3650. <a href="#external-secrets.io/v1beta1.DelineaProviderSecretRef">
  3651. DelineaProviderSecretRef
  3652. </a>
  3653. </em>
  3654. </td>
  3655. <td>
  3656. <p>ClientID is the non-secret part of the credential.</p>
  3657. </td>
  3658. </tr>
  3659. <tr>
  3660. <td>
  3661. <code>clientSecret</code></br>
  3662. <em>
  3663. <a href="#external-secrets.io/v1beta1.DelineaProviderSecretRef">
  3664. DelineaProviderSecretRef
  3665. </a>
  3666. </em>
  3667. </td>
  3668. <td>
  3669. <p>ClientSecret is the secret part of the credential.</p>
  3670. </td>
  3671. </tr>
  3672. <tr>
  3673. <td>
  3674. <code>tenant</code></br>
  3675. <em>
  3676. string
  3677. </em>
  3678. </td>
  3679. <td>
  3680. <p>Tenant is the chosen hostname / site name.</p>
  3681. </td>
  3682. </tr>
  3683. <tr>
  3684. <td>
  3685. <code>urlTemplate</code></br>
  3686. <em>
  3687. string
  3688. </em>
  3689. </td>
  3690. <td>
  3691. <em>(Optional)</em>
  3692. <p>URLTemplate
  3693. If unset, defaults to &ldquo;https://%s.secretsvaultcloud.%s/v1/%s%s&rdquo;.</p>
  3694. </td>
  3695. </tr>
  3696. <tr>
  3697. <td>
  3698. <code>tld</code></br>
  3699. <em>
  3700. string
  3701. </em>
  3702. </td>
  3703. <td>
  3704. <em>(Optional)</em>
  3705. <p>TLD is based on the server location that was chosen during provisioning.
  3706. If unset, defaults to &ldquo;com&rdquo;.</p>
  3707. </td>
  3708. </tr>
  3709. </tbody>
  3710. </table>
  3711. <h3 id="external-secrets.io/v1beta1.DelineaProviderSecretRef">DelineaProviderSecretRef
  3712. </h3>
  3713. <p>
  3714. (<em>Appears on:</em>
  3715. <a href="#external-secrets.io/v1beta1.DelineaProvider">DelineaProvider</a>)
  3716. </p>
  3717. <p>
  3718. </p>
  3719. <table>
  3720. <thead>
  3721. <tr>
  3722. <th>Field</th>
  3723. <th>Description</th>
  3724. </tr>
  3725. </thead>
  3726. <tbody>
  3727. <tr>
  3728. <td>
  3729. <code>value</code></br>
  3730. <em>
  3731. string
  3732. </em>
  3733. </td>
  3734. <td>
  3735. <em>(Optional)</em>
  3736. <p>Value can be specified directly to set a value without using a secret.</p>
  3737. </td>
  3738. </tr>
  3739. <tr>
  3740. <td>
  3741. <code>secretRef</code></br>
  3742. <em>
  3743. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3744. External Secrets meta/v1.SecretKeySelector
  3745. </a>
  3746. </em>
  3747. </td>
  3748. <td>
  3749. <em>(Optional)</em>
  3750. <p>SecretRef references a key in a secret that will be used as value.</p>
  3751. </td>
  3752. </tr>
  3753. </tbody>
  3754. </table>
  3755. <h3 id="external-secrets.io/v1beta1.Device42Auth">Device42Auth
  3756. </h3>
  3757. <p>
  3758. (<em>Appears on:</em>
  3759. <a href="#external-secrets.io/v1beta1.Device42Provider">Device42Provider</a>)
  3760. </p>
  3761. <p>
  3762. </p>
  3763. <table>
  3764. <thead>
  3765. <tr>
  3766. <th>Field</th>
  3767. <th>Description</th>
  3768. </tr>
  3769. </thead>
  3770. <tbody>
  3771. <tr>
  3772. <td>
  3773. <code>secretRef</code></br>
  3774. <em>
  3775. <a href="#external-secrets.io/v1beta1.Device42SecretRef">
  3776. Device42SecretRef
  3777. </a>
  3778. </em>
  3779. </td>
  3780. <td>
  3781. </td>
  3782. </tr>
  3783. </tbody>
  3784. </table>
  3785. <h3 id="external-secrets.io/v1beta1.Device42Provider">Device42Provider
  3786. </h3>
  3787. <p>
  3788. (<em>Appears on:</em>
  3789. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3790. </p>
  3791. <p>
  3792. <p>Device42Provider configures a store to sync secrets with a Device42 instance.</p>
  3793. </p>
  3794. <table>
  3795. <thead>
  3796. <tr>
  3797. <th>Field</th>
  3798. <th>Description</th>
  3799. </tr>
  3800. </thead>
  3801. <tbody>
  3802. <tr>
  3803. <td>
  3804. <code>host</code></br>
  3805. <em>
  3806. string
  3807. </em>
  3808. </td>
  3809. <td>
  3810. <p>URL configures the Device42 instance URL.</p>
  3811. </td>
  3812. </tr>
  3813. <tr>
  3814. <td>
  3815. <code>auth</code></br>
  3816. <em>
  3817. <a href="#external-secrets.io/v1beta1.Device42Auth">
  3818. Device42Auth
  3819. </a>
  3820. </em>
  3821. </td>
  3822. <td>
  3823. <p>Auth configures how secret-manager authenticates with a Device42 instance.</p>
  3824. </td>
  3825. </tr>
  3826. </tbody>
  3827. </table>
  3828. <h3 id="external-secrets.io/v1beta1.Device42SecretRef">Device42SecretRef
  3829. </h3>
  3830. <p>
  3831. (<em>Appears on:</em>
  3832. <a href="#external-secrets.io/v1beta1.Device42Auth">Device42Auth</a>)
  3833. </p>
  3834. <p>
  3835. </p>
  3836. <table>
  3837. <thead>
  3838. <tr>
  3839. <th>Field</th>
  3840. <th>Description</th>
  3841. </tr>
  3842. </thead>
  3843. <tbody>
  3844. <tr>
  3845. <td>
  3846. <code>credentials</code></br>
  3847. <em>
  3848. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3849. External Secrets meta/v1.SecretKeySelector
  3850. </a>
  3851. </em>
  3852. </td>
  3853. <td>
  3854. <em>(Optional)</em>
  3855. <p>Username / Password is used for authentication.</p>
  3856. </td>
  3857. </tr>
  3858. </tbody>
  3859. </table>
  3860. <h3 id="external-secrets.io/v1beta1.DopplerAuth">DopplerAuth
  3861. </h3>
  3862. <p>
  3863. (<em>Appears on:</em>
  3864. <a href="#external-secrets.io/v1beta1.DopplerProvider">DopplerProvider</a>)
  3865. </p>
  3866. <p>
  3867. </p>
  3868. <table>
  3869. <thead>
  3870. <tr>
  3871. <th>Field</th>
  3872. <th>Description</th>
  3873. </tr>
  3874. </thead>
  3875. <tbody>
  3876. <tr>
  3877. <td>
  3878. <code>secretRef</code></br>
  3879. <em>
  3880. <a href="#external-secrets.io/v1beta1.DopplerAuthSecretRef">
  3881. DopplerAuthSecretRef
  3882. </a>
  3883. </em>
  3884. </td>
  3885. <td>
  3886. </td>
  3887. </tr>
  3888. </tbody>
  3889. </table>
  3890. <h3 id="external-secrets.io/v1beta1.DopplerAuthSecretRef">DopplerAuthSecretRef
  3891. </h3>
  3892. <p>
  3893. (<em>Appears on:</em>
  3894. <a href="#external-secrets.io/v1beta1.DopplerAuth">DopplerAuth</a>)
  3895. </p>
  3896. <p>
  3897. </p>
  3898. <table>
  3899. <thead>
  3900. <tr>
  3901. <th>Field</th>
  3902. <th>Description</th>
  3903. </tr>
  3904. </thead>
  3905. <tbody>
  3906. <tr>
  3907. <td>
  3908. <code>dopplerToken</code></br>
  3909. <em>
  3910. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3911. External Secrets meta/v1.SecretKeySelector
  3912. </a>
  3913. </em>
  3914. </td>
  3915. <td>
  3916. <p>The DopplerToken is used for authentication.
  3917. See <a href="https://docs.doppler.com/reference/api#authentication">https://docs.doppler.com/reference/api#authentication</a> for auth token types.
  3918. The Key attribute defaults to dopplerToken if not specified.</p>
  3919. </td>
  3920. </tr>
  3921. </tbody>
  3922. </table>
  3923. <h3 id="external-secrets.io/v1beta1.DopplerProvider">DopplerProvider
  3924. </h3>
  3925. <p>
  3926. (<em>Appears on:</em>
  3927. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3928. </p>
  3929. <p>
  3930. <p>DopplerProvider configures a store to sync secrets using the Doppler provider.
  3931. Project and Config are required if not using a Service Token.</p>
  3932. </p>
  3933. <table>
  3934. <thead>
  3935. <tr>
  3936. <th>Field</th>
  3937. <th>Description</th>
  3938. </tr>
  3939. </thead>
  3940. <tbody>
  3941. <tr>
  3942. <td>
  3943. <code>auth</code></br>
  3944. <em>
  3945. <a href="#external-secrets.io/v1beta1.DopplerAuth">
  3946. DopplerAuth
  3947. </a>
  3948. </em>
  3949. </td>
  3950. <td>
  3951. <p>Auth configures how the Operator authenticates with the Doppler API</p>
  3952. </td>
  3953. </tr>
  3954. <tr>
  3955. <td>
  3956. <code>project</code></br>
  3957. <em>
  3958. string
  3959. </em>
  3960. </td>
  3961. <td>
  3962. <em>(Optional)</em>
  3963. <p>Doppler project (required if not using a Service Token)</p>
  3964. </td>
  3965. </tr>
  3966. <tr>
  3967. <td>
  3968. <code>config</code></br>
  3969. <em>
  3970. string
  3971. </em>
  3972. </td>
  3973. <td>
  3974. <em>(Optional)</em>
  3975. <p>Doppler config (required if not using a Service Token)</p>
  3976. </td>
  3977. </tr>
  3978. <tr>
  3979. <td>
  3980. <code>nameTransformer</code></br>
  3981. <em>
  3982. string
  3983. </em>
  3984. </td>
  3985. <td>
  3986. <em>(Optional)</em>
  3987. <p>Environment variable compatible name transforms that change secret names to a different format</p>
  3988. </td>
  3989. </tr>
  3990. <tr>
  3991. <td>
  3992. <code>format</code></br>
  3993. <em>
  3994. string
  3995. </em>
  3996. </td>
  3997. <td>
  3998. <em>(Optional)</em>
  3999. <p>Format enables the downloading of secrets as a file (string)</p>
  4000. </td>
  4001. </tr>
  4002. </tbody>
  4003. </table>
  4004. <h3 id="external-secrets.io/v1beta1.ExternalSecret">ExternalSecret
  4005. </h3>
  4006. <p>
  4007. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  4008. </p>
  4009. <table>
  4010. <thead>
  4011. <tr>
  4012. <th>Field</th>
  4013. <th>Description</th>
  4014. </tr>
  4015. </thead>
  4016. <tbody>
  4017. <tr>
  4018. <td>
  4019. <code>metadata</code></br>
  4020. <em>
  4021. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  4022. Kubernetes meta/v1.ObjectMeta
  4023. </a>
  4024. </em>
  4025. </td>
  4026. <td>
  4027. Refer to the Kubernetes API documentation for the fields of the
  4028. <code>metadata</code> field.
  4029. </td>
  4030. </tr>
  4031. <tr>
  4032. <td>
  4033. <code>spec</code></br>
  4034. <em>
  4035. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  4036. ExternalSecretSpec
  4037. </a>
  4038. </em>
  4039. </td>
  4040. <td>
  4041. <br/>
  4042. <br/>
  4043. <table>
  4044. <tr>
  4045. <td>
  4046. <code>secretStoreRef</code></br>
  4047. <em>
  4048. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  4049. SecretStoreRef
  4050. </a>
  4051. </em>
  4052. </td>
  4053. <td>
  4054. <em>(Optional)</em>
  4055. </td>
  4056. </tr>
  4057. <tr>
  4058. <td>
  4059. <code>target</code></br>
  4060. <em>
  4061. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  4062. ExternalSecretTarget
  4063. </a>
  4064. </em>
  4065. </td>
  4066. <td>
  4067. <em>(Optional)</em>
  4068. </td>
  4069. </tr>
  4070. <tr>
  4071. <td>
  4072. <code>refreshInterval</code></br>
  4073. <em>
  4074. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  4075. Kubernetes meta/v1.Duration
  4076. </a>
  4077. </em>
  4078. </td>
  4079. <td>
  4080. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider,
  4081. specified as Golang Duration strings.
  4082. 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;
  4083. Example values: &ldquo;1h&rdquo;, &ldquo;2h30m&rdquo;, &ldquo;5d&rdquo;, &ldquo;10s&rdquo;
  4084. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  4085. </td>
  4086. </tr>
  4087. <tr>
  4088. <td>
  4089. <code>data</code></br>
  4090. <em>
  4091. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  4092. []ExternalSecretData
  4093. </a>
  4094. </em>
  4095. </td>
  4096. <td>
  4097. <em>(Optional)</em>
  4098. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  4099. </td>
  4100. </tr>
  4101. <tr>
  4102. <td>
  4103. <code>dataFrom</code></br>
  4104. <em>
  4105. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  4106. []ExternalSecretDataFromRemoteRef
  4107. </a>
  4108. </em>
  4109. </td>
  4110. <td>
  4111. <em>(Optional)</em>
  4112. <p>DataFrom is used to fetch all properties from a specific Provider data
  4113. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  4114. </td>
  4115. </tr>
  4116. </table>
  4117. </td>
  4118. </tr>
  4119. <tr>
  4120. <td>
  4121. <code>status</code></br>
  4122. <em>
  4123. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">
  4124. ExternalSecretStatus
  4125. </a>
  4126. </em>
  4127. </td>
  4128. <td>
  4129. </td>
  4130. </tr>
  4131. </tbody>
  4132. </table>
  4133. <h3 id="external-secrets.io/v1beta1.ExternalSecretConditionType">ExternalSecretConditionType
  4134. (<code>string</code> alias)</p></h3>
  4135. <p>
  4136. (<em>Appears on:</em>
  4137. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  4138. </p>
  4139. <p>
  4140. </p>
  4141. <table>
  4142. <thead>
  4143. <tr>
  4144. <th>Value</th>
  4145. <th>Description</th>
  4146. </tr>
  4147. </thead>
  4148. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
  4149. <td></td>
  4150. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  4151. <td></td>
  4152. </tr></tbody>
  4153. </table>
  4154. <h3 id="external-secrets.io/v1beta1.ExternalSecretConversionStrategy">ExternalSecretConversionStrategy
  4155. (<code>string</code> alias)</p></h3>
  4156. <p>
  4157. (<em>Appears on:</em>
  4158. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  4159. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  4160. </p>
  4161. <p>
  4162. </p>
  4163. <table>
  4164. <thead>
  4165. <tr>
  4166. <th>Value</th>
  4167. <th>Description</th>
  4168. </tr>
  4169. </thead>
  4170. <tbody><tr><td><p>&#34;Default&#34;</p></td>
  4171. <td></td>
  4172. </tr><tr><td><p>&#34;Unicode&#34;</p></td>
  4173. <td></td>
  4174. </tr></tbody>
  4175. </table>
  4176. <h3 id="external-secrets.io/v1beta1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  4177. (<code>string</code> alias)</p></h3>
  4178. <p>
  4179. (<em>Appears on:</em>
  4180. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  4181. </p>
  4182. <p>
  4183. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  4184. </p>
  4185. <table>
  4186. <thead>
  4187. <tr>
  4188. <th>Value</th>
  4189. <th>Description</th>
  4190. </tr>
  4191. </thead>
  4192. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  4193. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  4194. </td>
  4195. </tr><tr><td><p>&#34;None&#34;</p></td>
  4196. <td><p>None does not create a Secret (future use with injector).</p>
  4197. </td>
  4198. </tr><tr><td><p>&#34;Orphan&#34;</p></td>
  4199. <td><p>Orphan creates the Secret and does not set the ownerReference.
  4200. I.e. it will be orphaned after the deletion of the ExternalSecret.</p>
  4201. </td>
  4202. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  4203. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  4204. </td>
  4205. </tr></tbody>
  4206. </table>
  4207. <h3 id="external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData
  4208. </h3>
  4209. <p>
  4210. (<em>Appears on:</em>
  4211. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  4212. </p>
  4213. <p>
  4214. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  4215. </p>
  4216. <table>
  4217. <thead>
  4218. <tr>
  4219. <th>Field</th>
  4220. <th>Description</th>
  4221. </tr>
  4222. </thead>
  4223. <tbody>
  4224. <tr>
  4225. <td>
  4226. <code>secretKey</code></br>
  4227. <em>
  4228. string
  4229. </em>
  4230. </td>
  4231. <td>
  4232. <p>SecretKey defines the key in which the controller stores
  4233. the value. This is the key in the Kind=Secret</p>
  4234. </td>
  4235. </tr>
  4236. <tr>
  4237. <td>
  4238. <code>remoteRef</code></br>
  4239. <em>
  4240. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  4241. ExternalSecretDataRemoteRef
  4242. </a>
  4243. </em>
  4244. </td>
  4245. <td>
  4246. <p>RemoteRef points to the remote secret and defines
  4247. which secret (version/property/..) to fetch.</p>
  4248. </td>
  4249. </tr>
  4250. <tr>
  4251. <td>
  4252. <code>sourceRef</code></br>
  4253. <em>
  4254. <a href="#external-secrets.io/v1beta1.StoreSourceRef">
  4255. StoreSourceRef
  4256. </a>
  4257. </em>
  4258. </td>
  4259. <td>
  4260. <p>SourceRef allows you to override the source
  4261. from which the value will pulled from.</p>
  4262. </td>
  4263. </tr>
  4264. </tbody>
  4265. </table>
  4266. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef
  4267. </h3>
  4268. <p>
  4269. (<em>Appears on:</em>
  4270. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  4271. </p>
  4272. <p>
  4273. </p>
  4274. <table>
  4275. <thead>
  4276. <tr>
  4277. <th>Field</th>
  4278. <th>Description</th>
  4279. </tr>
  4280. </thead>
  4281. <tbody>
  4282. <tr>
  4283. <td>
  4284. <code>extract</code></br>
  4285. <em>
  4286. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  4287. ExternalSecretDataRemoteRef
  4288. </a>
  4289. </em>
  4290. </td>
  4291. <td>
  4292. <em>(Optional)</em>
  4293. <p>Used to extract multiple key/value pairs from one secret
  4294. Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
  4295. </td>
  4296. </tr>
  4297. <tr>
  4298. <td>
  4299. <code>find</code></br>
  4300. <em>
  4301. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">
  4302. ExternalSecretFind
  4303. </a>
  4304. </em>
  4305. </td>
  4306. <td>
  4307. <em>(Optional)</em>
  4308. <p>Used to find secrets based on tags or regular expressions
  4309. Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
  4310. </td>
  4311. </tr>
  4312. <tr>
  4313. <td>
  4314. <code>rewrite</code></br>
  4315. <em>
  4316. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">
  4317. []ExternalSecretRewrite
  4318. </a>
  4319. </em>
  4320. </td>
  4321. <td>
  4322. <em>(Optional)</em>
  4323. <p>Used to rewrite secret Keys after getting them from the secret Provider
  4324. Multiple Rewrite operations can be provided. They are applied in a layered order (first to last)</p>
  4325. </td>
  4326. </tr>
  4327. <tr>
  4328. <td>
  4329. <code>sourceRef</code></br>
  4330. <em>
  4331. <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">
  4332. StoreGeneratorSourceRef
  4333. </a>
  4334. </em>
  4335. </td>
  4336. <td>
  4337. <p>SourceRef points to a store or generator
  4338. which contains secret values ready to use.
  4339. Use this in combination with Extract or Find pull values out of
  4340. a specific SecretStore.
  4341. When sourceRef points to a generator Extract or Find is not supported.
  4342. The generator returns a static map of values</p>
  4343. </td>
  4344. </tr>
  4345. </tbody>
  4346. </table>
  4347. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  4348. </h3>
  4349. <p>
  4350. (<em>Appears on:</em>
  4351. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>,
  4352. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  4353. </p>
  4354. <p>
  4355. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  4356. </p>
  4357. <table>
  4358. <thead>
  4359. <tr>
  4360. <th>Field</th>
  4361. <th>Description</th>
  4362. </tr>
  4363. </thead>
  4364. <tbody>
  4365. <tr>
  4366. <td>
  4367. <code>key</code></br>
  4368. <em>
  4369. string
  4370. </em>
  4371. </td>
  4372. <td>
  4373. <p>Key is the key used in the Provider, mandatory</p>
  4374. </td>
  4375. </tr>
  4376. <tr>
  4377. <td>
  4378. <code>metadataPolicy</code></br>
  4379. <em>
  4380. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">
  4381. ExternalSecretMetadataPolicy
  4382. </a>
  4383. </em>
  4384. </td>
  4385. <td>
  4386. <em>(Optional)</em>
  4387. <p>Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None</p>
  4388. </td>
  4389. </tr>
  4390. <tr>
  4391. <td>
  4392. <code>property</code></br>
  4393. <em>
  4394. string
  4395. </em>
  4396. </td>
  4397. <td>
  4398. <em>(Optional)</em>
  4399. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  4400. </td>
  4401. </tr>
  4402. <tr>
  4403. <td>
  4404. <code>version</code></br>
  4405. <em>
  4406. string
  4407. </em>
  4408. </td>
  4409. <td>
  4410. <em>(Optional)</em>
  4411. <p>Used to select a specific version of the Provider value, if supported</p>
  4412. </td>
  4413. </tr>
  4414. <tr>
  4415. <td>
  4416. <code>conversionStrategy</code></br>
  4417. <em>
  4418. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  4419. ExternalSecretConversionStrategy
  4420. </a>
  4421. </em>
  4422. </td>
  4423. <td>
  4424. <em>(Optional)</em>
  4425. <p>Used to define a conversion Strategy</p>
  4426. </td>
  4427. </tr>
  4428. <tr>
  4429. <td>
  4430. <code>decodingStrategy</code></br>
  4431. <em>
  4432. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  4433. ExternalSecretDecodingStrategy
  4434. </a>
  4435. </em>
  4436. </td>
  4437. <td>
  4438. <em>(Optional)</em>
  4439. <p>Used to define a decoding Strategy</p>
  4440. </td>
  4441. </tr>
  4442. </tbody>
  4443. </table>
  4444. <h3 id="external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">ExternalSecretDecodingStrategy
  4445. (<code>string</code> alias)</p></h3>
  4446. <p>
  4447. (<em>Appears on:</em>
  4448. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  4449. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  4450. </p>
  4451. <p>
  4452. </p>
  4453. <table>
  4454. <thead>
  4455. <tr>
  4456. <th>Value</th>
  4457. <th>Description</th>
  4458. </tr>
  4459. </thead>
  4460. <tbody><tr><td><p>&#34;Auto&#34;</p></td>
  4461. <td></td>
  4462. </tr><tr><td><p>&#34;Base64&#34;</p></td>
  4463. <td></td>
  4464. </tr><tr><td><p>&#34;Base64URL&#34;</p></td>
  4465. <td></td>
  4466. </tr><tr><td><p>&#34;None&#34;</p></td>
  4467. <td></td>
  4468. </tr></tbody>
  4469. </table>
  4470. <h3 id="external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">ExternalSecretDeletionPolicy
  4471. (<code>string</code> alias)</p></h3>
  4472. <p>
  4473. (<em>Appears on:</em>
  4474. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  4475. </p>
  4476. <p>
  4477. <p>ExternalSecretDeletionPolicy defines rules on how to delete the resulting Secret.</p>
  4478. </p>
  4479. <table>
  4480. <thead>
  4481. <tr>
  4482. <th>Value</th>
  4483. <th>Description</th>
  4484. </tr>
  4485. </thead>
  4486. <tbody><tr><td><p>&#34;Delete&#34;</p></td>
  4487. <td><p>Delete deletes the secret if all provider secrets are deleted.
  4488. If a secret gets deleted on the provider side and is not accessible
  4489. anymore this is not considered an error and the ExternalSecret
  4490. does not go into SecretSyncedError status.</p>
  4491. </td>
  4492. </tr><tr><td><p>&#34;Merge&#34;</p></td>
  4493. <td><p>Merge removes keys in the secret, but not the secret itself.
  4494. If a secret gets deleted on the provider side and is not accessible
  4495. anymore this is not considered an error and the ExternalSecret
  4496. does not go into SecretSyncedError status.</p>
  4497. </td>
  4498. </tr><tr><td><p>&#34;Retain&#34;</p></td>
  4499. <td><p>Retain will retain the secret if all provider secrets have been deleted.
  4500. If a provider secret does not exist the ExternalSecret gets into the
  4501. SecretSyncedError status.</p>
  4502. </td>
  4503. </tr></tbody>
  4504. </table>
  4505. <h3 id="external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind
  4506. </h3>
  4507. <p>
  4508. (<em>Appears on:</em>
  4509. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  4510. </p>
  4511. <p>
  4512. </p>
  4513. <table>
  4514. <thead>
  4515. <tr>
  4516. <th>Field</th>
  4517. <th>Description</th>
  4518. </tr>
  4519. </thead>
  4520. <tbody>
  4521. <tr>
  4522. <td>
  4523. <code>path</code></br>
  4524. <em>
  4525. string
  4526. </em>
  4527. </td>
  4528. <td>
  4529. <em>(Optional)</em>
  4530. <p>A root path to start the find operations.</p>
  4531. </td>
  4532. </tr>
  4533. <tr>
  4534. <td>
  4535. <code>name</code></br>
  4536. <em>
  4537. <a href="#external-secrets.io/v1beta1.FindName">
  4538. FindName
  4539. </a>
  4540. </em>
  4541. </td>
  4542. <td>
  4543. <em>(Optional)</em>
  4544. <p>Finds secrets based on the name.</p>
  4545. </td>
  4546. </tr>
  4547. <tr>
  4548. <td>
  4549. <code>tags</code></br>
  4550. <em>
  4551. map[string]string
  4552. </em>
  4553. </td>
  4554. <td>
  4555. <em>(Optional)</em>
  4556. <p>Find secrets based on tags.</p>
  4557. </td>
  4558. </tr>
  4559. <tr>
  4560. <td>
  4561. <code>conversionStrategy</code></br>
  4562. <em>
  4563. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  4564. ExternalSecretConversionStrategy
  4565. </a>
  4566. </em>
  4567. </td>
  4568. <td>
  4569. <em>(Optional)</em>
  4570. <p>Used to define a conversion Strategy</p>
  4571. </td>
  4572. </tr>
  4573. <tr>
  4574. <td>
  4575. <code>decodingStrategy</code></br>
  4576. <em>
  4577. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  4578. ExternalSecretDecodingStrategy
  4579. </a>
  4580. </em>
  4581. </td>
  4582. <td>
  4583. <em>(Optional)</em>
  4584. <p>Used to define a decoding Strategy</p>
  4585. </td>
  4586. </tr>
  4587. </tbody>
  4588. </table>
  4589. <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadata">ExternalSecretMetadata
  4590. </h3>
  4591. <p>
  4592. (<em>Appears on:</em>
  4593. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>)
  4594. </p>
  4595. <p>
  4596. <p>ExternalSecretMetadata defines metadata fields for the ExternalSecret generated by the ClusterExternalSecret.</p>
  4597. </p>
  4598. <table>
  4599. <thead>
  4600. <tr>
  4601. <th>Field</th>
  4602. <th>Description</th>
  4603. </tr>
  4604. </thead>
  4605. <tbody>
  4606. <tr>
  4607. <td>
  4608. <code>annotations</code></br>
  4609. <em>
  4610. map[string]string
  4611. </em>
  4612. </td>
  4613. <td>
  4614. <em>(Optional)</em>
  4615. </td>
  4616. </tr>
  4617. <tr>
  4618. <td>
  4619. <code>labels</code></br>
  4620. <em>
  4621. map[string]string
  4622. </em>
  4623. </td>
  4624. <td>
  4625. <em>(Optional)</em>
  4626. </td>
  4627. </tr>
  4628. </tbody>
  4629. </table>
  4630. <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">ExternalSecretMetadataPolicy
  4631. (<code>string</code> alias)</p></h3>
  4632. <p>
  4633. (<em>Appears on:</em>
  4634. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>)
  4635. </p>
  4636. <p>
  4637. </p>
  4638. <table>
  4639. <thead>
  4640. <tr>
  4641. <th>Value</th>
  4642. <th>Description</th>
  4643. </tr>
  4644. </thead>
  4645. <tbody><tr><td><p>&#34;Fetch&#34;</p></td>
  4646. <td></td>
  4647. </tr><tr><td><p>&#34;None&#34;</p></td>
  4648. <td></td>
  4649. </tr></tbody>
  4650. </table>
  4651. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite
  4652. </h3>
  4653. <p>
  4654. (<em>Appears on:</em>
  4655. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  4656. </p>
  4657. <p>
  4658. </p>
  4659. <table>
  4660. <thead>
  4661. <tr>
  4662. <th>Field</th>
  4663. <th>Description</th>
  4664. </tr>
  4665. </thead>
  4666. <tbody>
  4667. <tr>
  4668. <td>
  4669. <code>regexp</code></br>
  4670. <em>
  4671. <a href="#external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">
  4672. ExternalSecretRewriteRegexp
  4673. </a>
  4674. </em>
  4675. </td>
  4676. <td>
  4677. <em>(Optional)</em>
  4678. <p>Used to rewrite with regular expressions.
  4679. The resulting key will be the output of a regexp.ReplaceAll operation.</p>
  4680. </td>
  4681. </tr>
  4682. <tr>
  4683. <td>
  4684. <code>transform</code></br>
  4685. <em>
  4686. <a href="#external-secrets.io/v1beta1.ExternalSecretRewriteTransform">
  4687. ExternalSecretRewriteTransform
  4688. </a>
  4689. </em>
  4690. </td>
  4691. <td>
  4692. <em>(Optional)</em>
  4693. <p>Used to apply string transformation on the secrets.
  4694. The resulting key will be the output of the template applied by the operation.</p>
  4695. </td>
  4696. </tr>
  4697. </tbody>
  4698. </table>
  4699. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">ExternalSecretRewriteRegexp
  4700. </h3>
  4701. <p>
  4702. (<em>Appears on:</em>
  4703. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
  4704. </p>
  4705. <p>
  4706. </p>
  4707. <table>
  4708. <thead>
  4709. <tr>
  4710. <th>Field</th>
  4711. <th>Description</th>
  4712. </tr>
  4713. </thead>
  4714. <tbody>
  4715. <tr>
  4716. <td>
  4717. <code>source</code></br>
  4718. <em>
  4719. string
  4720. </em>
  4721. </td>
  4722. <td>
  4723. <p>Used to define the regular expression of a re.Compiler.</p>
  4724. </td>
  4725. </tr>
  4726. <tr>
  4727. <td>
  4728. <code>target</code></br>
  4729. <em>
  4730. string
  4731. </em>
  4732. </td>
  4733. <td>
  4734. <p>Used to define the target pattern of a ReplaceAll operation.</p>
  4735. </td>
  4736. </tr>
  4737. </tbody>
  4738. </table>
  4739. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewriteTransform">ExternalSecretRewriteTransform
  4740. </h3>
  4741. <p>
  4742. (<em>Appears on:</em>
  4743. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
  4744. </p>
  4745. <p>
  4746. </p>
  4747. <table>
  4748. <thead>
  4749. <tr>
  4750. <th>Field</th>
  4751. <th>Description</th>
  4752. </tr>
  4753. </thead>
  4754. <tbody>
  4755. <tr>
  4756. <td>
  4757. <code>template</code></br>
  4758. <em>
  4759. string
  4760. </em>
  4761. </td>
  4762. <td>
  4763. <p>Used to define the template to apply on the secret name.
  4764. <code>.value</code> will specify the secret name in the template.</p>
  4765. </td>
  4766. </tr>
  4767. </tbody>
  4768. </table>
  4769. <h3 id="external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec
  4770. </h3>
  4771. <p>
  4772. (<em>Appears on:</em>
  4773. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>,
  4774. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  4775. </p>
  4776. <p>
  4777. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  4778. </p>
  4779. <table>
  4780. <thead>
  4781. <tr>
  4782. <th>Field</th>
  4783. <th>Description</th>
  4784. </tr>
  4785. </thead>
  4786. <tbody>
  4787. <tr>
  4788. <td>
  4789. <code>secretStoreRef</code></br>
  4790. <em>
  4791. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  4792. SecretStoreRef
  4793. </a>
  4794. </em>
  4795. </td>
  4796. <td>
  4797. <em>(Optional)</em>
  4798. </td>
  4799. </tr>
  4800. <tr>
  4801. <td>
  4802. <code>target</code></br>
  4803. <em>
  4804. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  4805. ExternalSecretTarget
  4806. </a>
  4807. </em>
  4808. </td>
  4809. <td>
  4810. <em>(Optional)</em>
  4811. </td>
  4812. </tr>
  4813. <tr>
  4814. <td>
  4815. <code>refreshInterval</code></br>
  4816. <em>
  4817. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  4818. Kubernetes meta/v1.Duration
  4819. </a>
  4820. </em>
  4821. </td>
  4822. <td>
  4823. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider,
  4824. specified as Golang Duration strings.
  4825. 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;
  4826. Example values: &ldquo;1h&rdquo;, &ldquo;2h30m&rdquo;, &ldquo;5d&rdquo;, &ldquo;10s&rdquo;
  4827. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  4828. </td>
  4829. </tr>
  4830. <tr>
  4831. <td>
  4832. <code>data</code></br>
  4833. <em>
  4834. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  4835. []ExternalSecretData
  4836. </a>
  4837. </em>
  4838. </td>
  4839. <td>
  4840. <em>(Optional)</em>
  4841. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  4842. </td>
  4843. </tr>
  4844. <tr>
  4845. <td>
  4846. <code>dataFrom</code></br>
  4847. <em>
  4848. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  4849. []ExternalSecretDataFromRemoteRef
  4850. </a>
  4851. </em>
  4852. </td>
  4853. <td>
  4854. <em>(Optional)</em>
  4855. <p>DataFrom is used to fetch all properties from a specific Provider data
  4856. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  4857. </td>
  4858. </tr>
  4859. </tbody>
  4860. </table>
  4861. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus
  4862. </h3>
  4863. <p>
  4864. (<em>Appears on:</em>
  4865. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  4866. </p>
  4867. <p>
  4868. </p>
  4869. <table>
  4870. <thead>
  4871. <tr>
  4872. <th>Field</th>
  4873. <th>Description</th>
  4874. </tr>
  4875. </thead>
  4876. <tbody>
  4877. <tr>
  4878. <td>
  4879. <code>refreshTime</code></br>
  4880. <em>
  4881. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  4882. Kubernetes meta/v1.Time
  4883. </a>
  4884. </em>
  4885. </td>
  4886. <td>
  4887. <p>refreshTime is the time and date the external secret was fetched and
  4888. the target secret updated</p>
  4889. </td>
  4890. </tr>
  4891. <tr>
  4892. <td>
  4893. <code>syncedResourceVersion</code></br>
  4894. <em>
  4895. string
  4896. </em>
  4897. </td>
  4898. <td>
  4899. <p>SyncedResourceVersion keeps track of the last synced version</p>
  4900. </td>
  4901. </tr>
  4902. <tr>
  4903. <td>
  4904. <code>conditions</code></br>
  4905. <em>
  4906. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">
  4907. []ExternalSecretStatusCondition
  4908. </a>
  4909. </em>
  4910. </td>
  4911. <td>
  4912. <em>(Optional)</em>
  4913. </td>
  4914. </tr>
  4915. <tr>
  4916. <td>
  4917. <code>binding</code></br>
  4918. <em>
  4919. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#localobjectreference-v1-core">
  4920. Kubernetes core/v1.LocalObjectReference
  4921. </a>
  4922. </em>
  4923. </td>
  4924. <td>
  4925. <p>Binding represents a servicebinding.io Provisioned Service reference to the secret</p>
  4926. </td>
  4927. </tr>
  4928. </tbody>
  4929. </table>
  4930. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  4931. </h3>
  4932. <p>
  4933. (<em>Appears on:</em>
  4934. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus</a>)
  4935. </p>
  4936. <p>
  4937. </p>
  4938. <table>
  4939. <thead>
  4940. <tr>
  4941. <th>Field</th>
  4942. <th>Description</th>
  4943. </tr>
  4944. </thead>
  4945. <tbody>
  4946. <tr>
  4947. <td>
  4948. <code>type</code></br>
  4949. <em>
  4950. <a href="#external-secrets.io/v1beta1.ExternalSecretConditionType">
  4951. ExternalSecretConditionType
  4952. </a>
  4953. </em>
  4954. </td>
  4955. <td>
  4956. </td>
  4957. </tr>
  4958. <tr>
  4959. <td>
  4960. <code>status</code></br>
  4961. <em>
  4962. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  4963. Kubernetes core/v1.ConditionStatus
  4964. </a>
  4965. </em>
  4966. </td>
  4967. <td>
  4968. </td>
  4969. </tr>
  4970. <tr>
  4971. <td>
  4972. <code>reason</code></br>
  4973. <em>
  4974. string
  4975. </em>
  4976. </td>
  4977. <td>
  4978. <em>(Optional)</em>
  4979. </td>
  4980. </tr>
  4981. <tr>
  4982. <td>
  4983. <code>message</code></br>
  4984. <em>
  4985. string
  4986. </em>
  4987. </td>
  4988. <td>
  4989. <em>(Optional)</em>
  4990. </td>
  4991. </tr>
  4992. <tr>
  4993. <td>
  4994. <code>lastTransitionTime</code></br>
  4995. <em>
  4996. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  4997. Kubernetes meta/v1.Time
  4998. </a>
  4999. </em>
  5000. </td>
  5001. <td>
  5002. <em>(Optional)</em>
  5003. </td>
  5004. </tr>
  5005. </tbody>
  5006. </table>
  5007. <h3 id="external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget
  5008. </h3>
  5009. <p>
  5010. (<em>Appears on:</em>
  5011. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  5012. </p>
  5013. <p>
  5014. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  5015. There can be only one target per ExternalSecret.</p>
  5016. </p>
  5017. <table>
  5018. <thead>
  5019. <tr>
  5020. <th>Field</th>
  5021. <th>Description</th>
  5022. </tr>
  5023. </thead>
  5024. <tbody>
  5025. <tr>
  5026. <td>
  5027. <code>name</code></br>
  5028. <em>
  5029. string
  5030. </em>
  5031. </td>
  5032. <td>
  5033. <em>(Optional)</em>
  5034. <p>Name defines the name of the Secret resource to be managed
  5035. This field is immutable
  5036. Defaults to the .metadata.name of the ExternalSecret resource</p>
  5037. </td>
  5038. </tr>
  5039. <tr>
  5040. <td>
  5041. <code>creationPolicy</code></br>
  5042. <em>
  5043. <a href="#external-secrets.io/v1beta1.ExternalSecretCreationPolicy">
  5044. ExternalSecretCreationPolicy
  5045. </a>
  5046. </em>
  5047. </td>
  5048. <td>
  5049. <em>(Optional)</em>
  5050. <p>CreationPolicy defines rules on how to create the resulting Secret
  5051. Defaults to &lsquo;Owner&rsquo;</p>
  5052. </td>
  5053. </tr>
  5054. <tr>
  5055. <td>
  5056. <code>deletionPolicy</code></br>
  5057. <em>
  5058. <a href="#external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">
  5059. ExternalSecretDeletionPolicy
  5060. </a>
  5061. </em>
  5062. </td>
  5063. <td>
  5064. <em>(Optional)</em>
  5065. <p>DeletionPolicy defines rules on how to delete the resulting Secret
  5066. Defaults to &lsquo;Retain&rsquo;</p>
  5067. </td>
  5068. </tr>
  5069. <tr>
  5070. <td>
  5071. <code>template</code></br>
  5072. <em>
  5073. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">
  5074. ExternalSecretTemplate
  5075. </a>
  5076. </em>
  5077. </td>
  5078. <td>
  5079. <em>(Optional)</em>
  5080. <p>Template defines a blueprint for the created Secret resource.</p>
  5081. </td>
  5082. </tr>
  5083. <tr>
  5084. <td>
  5085. <code>immutable</code></br>
  5086. <em>
  5087. bool
  5088. </em>
  5089. </td>
  5090. <td>
  5091. <em>(Optional)</em>
  5092. <p>Immutable defines if the final secret will be immutable</p>
  5093. </td>
  5094. </tr>
  5095. </tbody>
  5096. </table>
  5097. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate
  5098. </h3>
  5099. <p>
  5100. (<em>Appears on:</em>
  5101. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  5102. </p>
  5103. <p>
  5104. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  5105. 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>
  5106. </p>
  5107. <table>
  5108. <thead>
  5109. <tr>
  5110. <th>Field</th>
  5111. <th>Description</th>
  5112. </tr>
  5113. </thead>
  5114. <tbody>
  5115. <tr>
  5116. <td>
  5117. <code>type</code></br>
  5118. <em>
  5119. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secrettype-v1-core">
  5120. Kubernetes core/v1.SecretType
  5121. </a>
  5122. </em>
  5123. </td>
  5124. <td>
  5125. <em>(Optional)</em>
  5126. </td>
  5127. </tr>
  5128. <tr>
  5129. <td>
  5130. <code>engineVersion</code></br>
  5131. <em>
  5132. <a href="#external-secrets.io/v1beta1.TemplateEngineVersion">
  5133. TemplateEngineVersion
  5134. </a>
  5135. </em>
  5136. </td>
  5137. <td>
  5138. <p>EngineVersion specifies the template engine version
  5139. that should be used to compile/execute the
  5140. template specified in .data and .templateFrom[].</p>
  5141. </td>
  5142. </tr>
  5143. <tr>
  5144. <td>
  5145. <code>metadata</code></br>
  5146. <em>
  5147. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">
  5148. ExternalSecretTemplateMetadata
  5149. </a>
  5150. </em>
  5151. </td>
  5152. <td>
  5153. <em>(Optional)</em>
  5154. </td>
  5155. </tr>
  5156. <tr>
  5157. <td>
  5158. <code>mergePolicy</code></br>
  5159. <em>
  5160. <a href="#external-secrets.io/v1beta1.TemplateMergePolicy">
  5161. TemplateMergePolicy
  5162. </a>
  5163. </em>
  5164. </td>
  5165. <td>
  5166. </td>
  5167. </tr>
  5168. <tr>
  5169. <td>
  5170. <code>data</code></br>
  5171. <em>
  5172. map[string]string
  5173. </em>
  5174. </td>
  5175. <td>
  5176. <em>(Optional)</em>
  5177. </td>
  5178. </tr>
  5179. <tr>
  5180. <td>
  5181. <code>templateFrom</code></br>
  5182. <em>
  5183. <a href="#external-secrets.io/v1beta1.TemplateFrom">
  5184. []TemplateFrom
  5185. </a>
  5186. </em>
  5187. </td>
  5188. <td>
  5189. <em>(Optional)</em>
  5190. </td>
  5191. </tr>
  5192. </tbody>
  5193. </table>
  5194. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  5195. </h3>
  5196. <p>
  5197. (<em>Appears on:</em>
  5198. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  5199. </p>
  5200. <p>
  5201. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  5202. </p>
  5203. <table>
  5204. <thead>
  5205. <tr>
  5206. <th>Field</th>
  5207. <th>Description</th>
  5208. </tr>
  5209. </thead>
  5210. <tbody>
  5211. <tr>
  5212. <td>
  5213. <code>annotations</code></br>
  5214. <em>
  5215. map[string]string
  5216. </em>
  5217. </td>
  5218. <td>
  5219. <em>(Optional)</em>
  5220. </td>
  5221. </tr>
  5222. <tr>
  5223. <td>
  5224. <code>labels</code></br>
  5225. <em>
  5226. map[string]string
  5227. </em>
  5228. </td>
  5229. <td>
  5230. <em>(Optional)</em>
  5231. </td>
  5232. </tr>
  5233. </tbody>
  5234. </table>
  5235. <h3 id="external-secrets.io/v1beta1.ExternalSecretValidator">ExternalSecretValidator
  5236. </h3>
  5237. <p>
  5238. </p>
  5239. <h3 id="external-secrets.io/v1beta1.FakeProvider">FakeProvider
  5240. </h3>
  5241. <p>
  5242. (<em>Appears on:</em>
  5243. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5244. </p>
  5245. <p>
  5246. <p>FakeProvider configures a fake provider that returns static values.</p>
  5247. </p>
  5248. <table>
  5249. <thead>
  5250. <tr>
  5251. <th>Field</th>
  5252. <th>Description</th>
  5253. </tr>
  5254. </thead>
  5255. <tbody>
  5256. <tr>
  5257. <td>
  5258. <code>data</code></br>
  5259. <em>
  5260. <a href="#external-secrets.io/v1beta1.FakeProviderData">
  5261. []FakeProviderData
  5262. </a>
  5263. </em>
  5264. </td>
  5265. <td>
  5266. </td>
  5267. </tr>
  5268. </tbody>
  5269. </table>
  5270. <h3 id="external-secrets.io/v1beta1.FakeProviderData">FakeProviderData
  5271. </h3>
  5272. <p>
  5273. (<em>Appears on:</em>
  5274. <a href="#external-secrets.io/v1beta1.FakeProvider">FakeProvider</a>)
  5275. </p>
  5276. <p>
  5277. </p>
  5278. <table>
  5279. <thead>
  5280. <tr>
  5281. <th>Field</th>
  5282. <th>Description</th>
  5283. </tr>
  5284. </thead>
  5285. <tbody>
  5286. <tr>
  5287. <td>
  5288. <code>key</code></br>
  5289. <em>
  5290. string
  5291. </em>
  5292. </td>
  5293. <td>
  5294. </td>
  5295. </tr>
  5296. <tr>
  5297. <td>
  5298. <code>value</code></br>
  5299. <em>
  5300. string
  5301. </em>
  5302. </td>
  5303. <td>
  5304. </td>
  5305. </tr>
  5306. <tr>
  5307. <td>
  5308. <code>valueMap</code></br>
  5309. <em>
  5310. map[string]string
  5311. </em>
  5312. </td>
  5313. <td>
  5314. <p>Deprecated: ValueMap is deprecated and is intended to be removed in the future, use the <code>value</code> field instead.</p>
  5315. </td>
  5316. </tr>
  5317. <tr>
  5318. <td>
  5319. <code>version</code></br>
  5320. <em>
  5321. string
  5322. </em>
  5323. </td>
  5324. <td>
  5325. </td>
  5326. </tr>
  5327. </tbody>
  5328. </table>
  5329. <h3 id="external-secrets.io/v1beta1.FindName">FindName
  5330. </h3>
  5331. <p>
  5332. (<em>Appears on:</em>
  5333. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  5334. </p>
  5335. <p>
  5336. </p>
  5337. <table>
  5338. <thead>
  5339. <tr>
  5340. <th>Field</th>
  5341. <th>Description</th>
  5342. </tr>
  5343. </thead>
  5344. <tbody>
  5345. <tr>
  5346. <td>
  5347. <code>regexp</code></br>
  5348. <em>
  5349. string
  5350. </em>
  5351. </td>
  5352. <td>
  5353. <em>(Optional)</em>
  5354. <p>Finds secrets base</p>
  5355. </td>
  5356. </tr>
  5357. </tbody>
  5358. </table>
  5359. <h3 id="external-secrets.io/v1beta1.FortanixProvider">FortanixProvider
  5360. </h3>
  5361. <p>
  5362. (<em>Appears on:</em>
  5363. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5364. </p>
  5365. <p>
  5366. </p>
  5367. <table>
  5368. <thead>
  5369. <tr>
  5370. <th>Field</th>
  5371. <th>Description</th>
  5372. </tr>
  5373. </thead>
  5374. <tbody>
  5375. <tr>
  5376. <td>
  5377. <code>apiUrl</code></br>
  5378. <em>
  5379. string
  5380. </em>
  5381. </td>
  5382. <td>
  5383. <p>APIURL is the URL of SDKMS API. Defaults to <code>sdkms.fortanix.com</code>.</p>
  5384. </td>
  5385. </tr>
  5386. <tr>
  5387. <td>
  5388. <code>apiKey</code></br>
  5389. <em>
  5390. <a href="#external-secrets.io/v1beta1.FortanixProviderSecretRef">
  5391. FortanixProviderSecretRef
  5392. </a>
  5393. </em>
  5394. </td>
  5395. <td>
  5396. <p>APIKey is the API token to access SDKMS Applications.</p>
  5397. </td>
  5398. </tr>
  5399. </tbody>
  5400. </table>
  5401. <h3 id="external-secrets.io/v1beta1.FortanixProviderSecretRef">FortanixProviderSecretRef
  5402. </h3>
  5403. <p>
  5404. (<em>Appears on:</em>
  5405. <a href="#external-secrets.io/v1beta1.FortanixProvider">FortanixProvider</a>)
  5406. </p>
  5407. <p>
  5408. </p>
  5409. <table>
  5410. <thead>
  5411. <tr>
  5412. <th>Field</th>
  5413. <th>Description</th>
  5414. </tr>
  5415. </thead>
  5416. <tbody>
  5417. <tr>
  5418. <td>
  5419. <code>secretRef</code></br>
  5420. <em>
  5421. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5422. External Secrets meta/v1.SecretKeySelector
  5423. </a>
  5424. </em>
  5425. </td>
  5426. <td>
  5427. <p>SecretRef is a reference to a secret containing the SDKMS API Key.</p>
  5428. </td>
  5429. </tr>
  5430. </tbody>
  5431. </table>
  5432. <h3 id="external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth
  5433. </h3>
  5434. <p>
  5435. (<em>Appears on:</em>
  5436. <a href="#external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider</a>)
  5437. </p>
  5438. <p>
  5439. </p>
  5440. <table>
  5441. <thead>
  5442. <tr>
  5443. <th>Field</th>
  5444. <th>Description</th>
  5445. </tr>
  5446. </thead>
  5447. <tbody>
  5448. <tr>
  5449. <td>
  5450. <code>secretRef</code></br>
  5451. <em>
  5452. <a href="#external-secrets.io/v1beta1.GCPSMAuthSecretRef">
  5453. GCPSMAuthSecretRef
  5454. </a>
  5455. </em>
  5456. </td>
  5457. <td>
  5458. <em>(Optional)</em>
  5459. </td>
  5460. </tr>
  5461. <tr>
  5462. <td>
  5463. <code>workloadIdentity</code></br>
  5464. <em>
  5465. <a href="#external-secrets.io/v1beta1.GCPWorkloadIdentity">
  5466. GCPWorkloadIdentity
  5467. </a>
  5468. </em>
  5469. </td>
  5470. <td>
  5471. <em>(Optional)</em>
  5472. </td>
  5473. </tr>
  5474. </tbody>
  5475. </table>
  5476. <h3 id="external-secrets.io/v1beta1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  5477. </h3>
  5478. <p>
  5479. (<em>Appears on:</em>
  5480. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  5481. </p>
  5482. <p>
  5483. </p>
  5484. <table>
  5485. <thead>
  5486. <tr>
  5487. <th>Field</th>
  5488. <th>Description</th>
  5489. </tr>
  5490. </thead>
  5491. <tbody>
  5492. <tr>
  5493. <td>
  5494. <code>secretAccessKeySecretRef</code></br>
  5495. <em>
  5496. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5497. External Secrets meta/v1.SecretKeySelector
  5498. </a>
  5499. </em>
  5500. </td>
  5501. <td>
  5502. <em>(Optional)</em>
  5503. <p>The SecretAccessKey is used for authentication</p>
  5504. </td>
  5505. </tr>
  5506. </tbody>
  5507. </table>
  5508. <h3 id="external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider
  5509. </h3>
  5510. <p>
  5511. (<em>Appears on:</em>
  5512. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5513. </p>
  5514. <p>
  5515. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  5516. </p>
  5517. <table>
  5518. <thead>
  5519. <tr>
  5520. <th>Field</th>
  5521. <th>Description</th>
  5522. </tr>
  5523. </thead>
  5524. <tbody>
  5525. <tr>
  5526. <td>
  5527. <code>auth</code></br>
  5528. <em>
  5529. <a href="#external-secrets.io/v1beta1.GCPSMAuth">
  5530. GCPSMAuth
  5531. </a>
  5532. </em>
  5533. </td>
  5534. <td>
  5535. <em>(Optional)</em>
  5536. <p>Auth defines the information necessary to authenticate against GCP</p>
  5537. </td>
  5538. </tr>
  5539. <tr>
  5540. <td>
  5541. <code>projectID</code></br>
  5542. <em>
  5543. string
  5544. </em>
  5545. </td>
  5546. <td>
  5547. <p>ProjectID project where secret is located</p>
  5548. </td>
  5549. </tr>
  5550. <tr>
  5551. <td>
  5552. <code>location</code></br>
  5553. <em>
  5554. string
  5555. </em>
  5556. </td>
  5557. <td>
  5558. <p>Location optionally defines a location for a secret</p>
  5559. </td>
  5560. </tr>
  5561. </tbody>
  5562. </table>
  5563. <h3 id="external-secrets.io/v1beta1.GCPWorkloadIdentity">GCPWorkloadIdentity
  5564. </h3>
  5565. <p>
  5566. (<em>Appears on:</em>
  5567. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</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>serviceAccountRef</code></br>
  5582. <em>
  5583. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  5584. External Secrets meta/v1.ServiceAccountSelector
  5585. </a>
  5586. </em>
  5587. </td>
  5588. <td>
  5589. </td>
  5590. </tr>
  5591. <tr>
  5592. <td>
  5593. <code>clusterLocation</code></br>
  5594. <em>
  5595. string
  5596. </em>
  5597. </td>
  5598. <td>
  5599. </td>
  5600. </tr>
  5601. <tr>
  5602. <td>
  5603. <code>clusterName</code></br>
  5604. <em>
  5605. string
  5606. </em>
  5607. </td>
  5608. <td>
  5609. </td>
  5610. </tr>
  5611. <tr>
  5612. <td>
  5613. <code>clusterProjectID</code></br>
  5614. <em>
  5615. string
  5616. </em>
  5617. </td>
  5618. <td>
  5619. </td>
  5620. </tr>
  5621. </tbody>
  5622. </table>
  5623. <h3 id="external-secrets.io/v1beta1.GeneratorRef">GeneratorRef
  5624. </h3>
  5625. <p>
  5626. (<em>Appears on:</em>
  5627. <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef</a>,
  5628. <a href="#external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef</a>)
  5629. </p>
  5630. <p>
  5631. <p>GeneratorRef points to a generator custom resource.</p>
  5632. </p>
  5633. <table>
  5634. <thead>
  5635. <tr>
  5636. <th>Field</th>
  5637. <th>Description</th>
  5638. </tr>
  5639. </thead>
  5640. <tbody>
  5641. <tr>
  5642. <td>
  5643. <code>apiVersion</code></br>
  5644. <em>
  5645. string
  5646. </em>
  5647. </td>
  5648. <td>
  5649. <p>Specify the apiVersion of the generator resource</p>
  5650. </td>
  5651. </tr>
  5652. <tr>
  5653. <td>
  5654. <code>kind</code></br>
  5655. <em>
  5656. string
  5657. </em>
  5658. </td>
  5659. <td>
  5660. <p>Specify the Kind of the resource, e.g. Password, ACRAccessToken, ClusterGenerator etc.</p>
  5661. </td>
  5662. </tr>
  5663. <tr>
  5664. <td>
  5665. <code>name</code></br>
  5666. <em>
  5667. string
  5668. </em>
  5669. </td>
  5670. <td>
  5671. <p>Specify the name of the generator resource</p>
  5672. </td>
  5673. </tr>
  5674. </tbody>
  5675. </table>
  5676. <h3 id="external-secrets.io/v1beta1.GenericStore">GenericStore
  5677. </h3>
  5678. <p>
  5679. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  5680. or a namespaced SecretStore.</p>
  5681. </p>
  5682. <h3 id="external-secrets.io/v1beta1.GenericStoreValidator">GenericStoreValidator
  5683. </h3>
  5684. <p>
  5685. </p>
  5686. <h3 id="external-secrets.io/v1beta1.GitlabAuth">GitlabAuth
  5687. </h3>
  5688. <p>
  5689. (<em>Appears on:</em>
  5690. <a href="#external-secrets.io/v1beta1.GitlabProvider">GitlabProvider</a>)
  5691. </p>
  5692. <p>
  5693. </p>
  5694. <table>
  5695. <thead>
  5696. <tr>
  5697. <th>Field</th>
  5698. <th>Description</th>
  5699. </tr>
  5700. </thead>
  5701. <tbody>
  5702. <tr>
  5703. <td>
  5704. <code>SecretRef</code></br>
  5705. <em>
  5706. <a href="#external-secrets.io/v1beta1.GitlabSecretRef">
  5707. GitlabSecretRef
  5708. </a>
  5709. </em>
  5710. </td>
  5711. <td>
  5712. </td>
  5713. </tr>
  5714. </tbody>
  5715. </table>
  5716. <h3 id="external-secrets.io/v1beta1.GitlabProvider">GitlabProvider
  5717. </h3>
  5718. <p>
  5719. (<em>Appears on:</em>
  5720. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5721. </p>
  5722. <p>
  5723. <p>Configures a store to sync secrets with a GitLab instance.</p>
  5724. </p>
  5725. <table>
  5726. <thead>
  5727. <tr>
  5728. <th>Field</th>
  5729. <th>Description</th>
  5730. </tr>
  5731. </thead>
  5732. <tbody>
  5733. <tr>
  5734. <td>
  5735. <code>url</code></br>
  5736. <em>
  5737. string
  5738. </em>
  5739. </td>
  5740. <td>
  5741. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
  5742. </td>
  5743. </tr>
  5744. <tr>
  5745. <td>
  5746. <code>auth</code></br>
  5747. <em>
  5748. <a href="#external-secrets.io/v1beta1.GitlabAuth">
  5749. GitlabAuth
  5750. </a>
  5751. </em>
  5752. </td>
  5753. <td>
  5754. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
  5755. </td>
  5756. </tr>
  5757. <tr>
  5758. <td>
  5759. <code>projectID</code></br>
  5760. <em>
  5761. string
  5762. </em>
  5763. </td>
  5764. <td>
  5765. <p>ProjectID specifies a project where secrets are located.</p>
  5766. </td>
  5767. </tr>
  5768. <tr>
  5769. <td>
  5770. <code>inheritFromGroups</code></br>
  5771. <em>
  5772. bool
  5773. </em>
  5774. </td>
  5775. <td>
  5776. <p>InheritFromGroups specifies whether parent groups should be discovered and checked for secrets.</p>
  5777. </td>
  5778. </tr>
  5779. <tr>
  5780. <td>
  5781. <code>groupIDs</code></br>
  5782. <em>
  5783. []string
  5784. </em>
  5785. </td>
  5786. <td>
  5787. <p>GroupIDs specify, which gitlab groups to pull secrets from. Group secrets are read from left to right followed by the project variables.</p>
  5788. </td>
  5789. </tr>
  5790. <tr>
  5791. <td>
  5792. <code>environment</code></br>
  5793. <em>
  5794. string
  5795. </em>
  5796. </td>
  5797. <td>
  5798. <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>
  5799. </td>
  5800. </tr>
  5801. </tbody>
  5802. </table>
  5803. <h3 id="external-secrets.io/v1beta1.GitlabSecretRef">GitlabSecretRef
  5804. </h3>
  5805. <p>
  5806. (<em>Appears on:</em>
  5807. <a href="#external-secrets.io/v1beta1.GitlabAuth">GitlabAuth</a>)
  5808. </p>
  5809. <p>
  5810. </p>
  5811. <table>
  5812. <thead>
  5813. <tr>
  5814. <th>Field</th>
  5815. <th>Description</th>
  5816. </tr>
  5817. </thead>
  5818. <tbody>
  5819. <tr>
  5820. <td>
  5821. <code>accessToken</code></br>
  5822. <em>
  5823. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5824. External Secrets meta/v1.SecretKeySelector
  5825. </a>
  5826. </em>
  5827. </td>
  5828. <td>
  5829. <p>AccessToken is used for authentication.</p>
  5830. </td>
  5831. </tr>
  5832. </tbody>
  5833. </table>
  5834. <h3 id="external-secrets.io/v1beta1.IBMAuth">IBMAuth
  5835. </h3>
  5836. <p>
  5837. (<em>Appears on:</em>
  5838. <a href="#external-secrets.io/v1beta1.IBMProvider">IBMProvider</a>)
  5839. </p>
  5840. <p>
  5841. </p>
  5842. <table>
  5843. <thead>
  5844. <tr>
  5845. <th>Field</th>
  5846. <th>Description</th>
  5847. </tr>
  5848. </thead>
  5849. <tbody>
  5850. <tr>
  5851. <td>
  5852. <code>secretRef</code></br>
  5853. <em>
  5854. <a href="#external-secrets.io/v1beta1.IBMAuthSecretRef">
  5855. IBMAuthSecretRef
  5856. </a>
  5857. </em>
  5858. </td>
  5859. <td>
  5860. </td>
  5861. </tr>
  5862. <tr>
  5863. <td>
  5864. <code>containerAuth</code></br>
  5865. <em>
  5866. <a href="#external-secrets.io/v1beta1.IBMAuthContainerAuth">
  5867. IBMAuthContainerAuth
  5868. </a>
  5869. </em>
  5870. </td>
  5871. <td>
  5872. </td>
  5873. </tr>
  5874. </tbody>
  5875. </table>
  5876. <h3 id="external-secrets.io/v1beta1.IBMAuthContainerAuth">IBMAuthContainerAuth
  5877. </h3>
  5878. <p>
  5879. (<em>Appears on:</em>
  5880. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  5881. </p>
  5882. <p>
  5883. <p>IBM Container-based auth with IAM Trusted Profile.</p>
  5884. </p>
  5885. <table>
  5886. <thead>
  5887. <tr>
  5888. <th>Field</th>
  5889. <th>Description</th>
  5890. </tr>
  5891. </thead>
  5892. <tbody>
  5893. <tr>
  5894. <td>
  5895. <code>profile</code></br>
  5896. <em>
  5897. string
  5898. </em>
  5899. </td>
  5900. <td>
  5901. <p>the IBM Trusted Profile</p>
  5902. </td>
  5903. </tr>
  5904. <tr>
  5905. <td>
  5906. <code>tokenLocation</code></br>
  5907. <em>
  5908. string
  5909. </em>
  5910. </td>
  5911. <td>
  5912. <p>Location the token is mounted on the pod</p>
  5913. </td>
  5914. </tr>
  5915. <tr>
  5916. <td>
  5917. <code>iamEndpoint</code></br>
  5918. <em>
  5919. string
  5920. </em>
  5921. </td>
  5922. <td>
  5923. </td>
  5924. </tr>
  5925. </tbody>
  5926. </table>
  5927. <h3 id="external-secrets.io/v1beta1.IBMAuthSecretRef">IBMAuthSecretRef
  5928. </h3>
  5929. <p>
  5930. (<em>Appears on:</em>
  5931. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  5932. </p>
  5933. <p>
  5934. </p>
  5935. <table>
  5936. <thead>
  5937. <tr>
  5938. <th>Field</th>
  5939. <th>Description</th>
  5940. </tr>
  5941. </thead>
  5942. <tbody>
  5943. <tr>
  5944. <td>
  5945. <code>secretApiKeySecretRef</code></br>
  5946. <em>
  5947. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5948. External Secrets meta/v1.SecretKeySelector
  5949. </a>
  5950. </em>
  5951. </td>
  5952. <td>
  5953. <p>The SecretAccessKey is used for authentication</p>
  5954. </td>
  5955. </tr>
  5956. </tbody>
  5957. </table>
  5958. <h3 id="external-secrets.io/v1beta1.IBMProvider">IBMProvider
  5959. </h3>
  5960. <p>
  5961. (<em>Appears on:</em>
  5962. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5963. </p>
  5964. <p>
  5965. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
  5966. backend.</p>
  5967. </p>
  5968. <table>
  5969. <thead>
  5970. <tr>
  5971. <th>Field</th>
  5972. <th>Description</th>
  5973. </tr>
  5974. </thead>
  5975. <tbody>
  5976. <tr>
  5977. <td>
  5978. <code>auth</code></br>
  5979. <em>
  5980. <a href="#external-secrets.io/v1beta1.IBMAuth">
  5981. IBMAuth
  5982. </a>
  5983. </em>
  5984. </td>
  5985. <td>
  5986. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
  5987. </td>
  5988. </tr>
  5989. <tr>
  5990. <td>
  5991. <code>serviceUrl</code></br>
  5992. <em>
  5993. string
  5994. </em>
  5995. </td>
  5996. <td>
  5997. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
  5998. </td>
  5999. </tr>
  6000. </tbody>
  6001. </table>
  6002. <h3 id="external-secrets.io/v1beta1.InfisicalAuth">InfisicalAuth
  6003. </h3>
  6004. <p>
  6005. (<em>Appears on:</em>
  6006. <a href="#external-secrets.io/v1beta1.InfisicalProvider">InfisicalProvider</a>)
  6007. </p>
  6008. <p>
  6009. </p>
  6010. <table>
  6011. <thead>
  6012. <tr>
  6013. <th>Field</th>
  6014. <th>Description</th>
  6015. </tr>
  6016. </thead>
  6017. <tbody>
  6018. <tr>
  6019. <td>
  6020. <code>universalAuthCredentials</code></br>
  6021. <em>
  6022. <a href="#external-secrets.io/v1beta1.UniversalAuthCredentials">
  6023. UniversalAuthCredentials
  6024. </a>
  6025. </em>
  6026. </td>
  6027. <td>
  6028. <em>(Optional)</em>
  6029. </td>
  6030. </tr>
  6031. </tbody>
  6032. </table>
  6033. <h3 id="external-secrets.io/v1beta1.InfisicalProvider">InfisicalProvider
  6034. </h3>
  6035. <p>
  6036. (<em>Appears on:</em>
  6037. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6038. </p>
  6039. <p>
  6040. <p>InfisicalProvider configures a store to sync secrets using the Infisical provider.</p>
  6041. </p>
  6042. <table>
  6043. <thead>
  6044. <tr>
  6045. <th>Field</th>
  6046. <th>Description</th>
  6047. </tr>
  6048. </thead>
  6049. <tbody>
  6050. <tr>
  6051. <td>
  6052. <code>auth</code></br>
  6053. <em>
  6054. <a href="#external-secrets.io/v1beta1.InfisicalAuth">
  6055. InfisicalAuth
  6056. </a>
  6057. </em>
  6058. </td>
  6059. <td>
  6060. <p>Auth configures how the Operator authenticates with the Infisical API</p>
  6061. </td>
  6062. </tr>
  6063. <tr>
  6064. <td>
  6065. <code>secretsScope</code></br>
  6066. <em>
  6067. <a href="#external-secrets.io/v1beta1.MachineIdentityScopeInWorkspace">
  6068. MachineIdentityScopeInWorkspace
  6069. </a>
  6070. </em>
  6071. </td>
  6072. <td>
  6073. </td>
  6074. </tr>
  6075. <tr>
  6076. <td>
  6077. <code>hostAPI</code></br>
  6078. <em>
  6079. string
  6080. </em>
  6081. </td>
  6082. <td>
  6083. <em>(Optional)</em>
  6084. </td>
  6085. </tr>
  6086. </tbody>
  6087. </table>
  6088. <h3 id="external-secrets.io/v1beta1.KeeperSecurityProvider">KeeperSecurityProvider
  6089. </h3>
  6090. <p>
  6091. (<em>Appears on:</em>
  6092. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6093. </p>
  6094. <p>
  6095. <p>KeeperSecurityProvider Configures a store to sync secrets using Keeper Security.</p>
  6096. </p>
  6097. <table>
  6098. <thead>
  6099. <tr>
  6100. <th>Field</th>
  6101. <th>Description</th>
  6102. </tr>
  6103. </thead>
  6104. <tbody>
  6105. <tr>
  6106. <td>
  6107. <code>authRef</code></br>
  6108. <em>
  6109. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6110. External Secrets meta/v1.SecretKeySelector
  6111. </a>
  6112. </em>
  6113. </td>
  6114. <td>
  6115. </td>
  6116. </tr>
  6117. <tr>
  6118. <td>
  6119. <code>folderID</code></br>
  6120. <em>
  6121. string
  6122. </em>
  6123. </td>
  6124. <td>
  6125. </td>
  6126. </tr>
  6127. </tbody>
  6128. </table>
  6129. <h3 id="external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth
  6130. </h3>
  6131. <p>
  6132. (<em>Appears on:</em>
  6133. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  6134. </p>
  6135. <p>
  6136. </p>
  6137. <table>
  6138. <thead>
  6139. <tr>
  6140. <th>Field</th>
  6141. <th>Description</th>
  6142. </tr>
  6143. </thead>
  6144. <tbody>
  6145. <tr>
  6146. <td>
  6147. <code>cert</code></br>
  6148. <em>
  6149. <a href="#external-secrets.io/v1beta1.CertAuth">
  6150. CertAuth
  6151. </a>
  6152. </em>
  6153. </td>
  6154. <td>
  6155. <em>(Optional)</em>
  6156. <p>has both clientCert and clientKey as secretKeySelector</p>
  6157. </td>
  6158. </tr>
  6159. <tr>
  6160. <td>
  6161. <code>token</code></br>
  6162. <em>
  6163. <a href="#external-secrets.io/v1beta1.TokenAuth">
  6164. TokenAuth
  6165. </a>
  6166. </em>
  6167. </td>
  6168. <td>
  6169. <em>(Optional)</em>
  6170. <p>use static token to authenticate with</p>
  6171. </td>
  6172. </tr>
  6173. <tr>
  6174. <td>
  6175. <code>serviceAccount</code></br>
  6176. <em>
  6177. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  6178. External Secrets meta/v1.ServiceAccountSelector
  6179. </a>
  6180. </em>
  6181. </td>
  6182. <td>
  6183. <em>(Optional)</em>
  6184. <p>points to a service account that should be used for authentication</p>
  6185. </td>
  6186. </tr>
  6187. </tbody>
  6188. </table>
  6189. <h3 id="external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider
  6190. </h3>
  6191. <p>
  6192. (<em>Appears on:</em>
  6193. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6194. </p>
  6195. <p>
  6196. <p>Configures a store to sync secrets with a Kubernetes instance.</p>
  6197. </p>
  6198. <table>
  6199. <thead>
  6200. <tr>
  6201. <th>Field</th>
  6202. <th>Description</th>
  6203. </tr>
  6204. </thead>
  6205. <tbody>
  6206. <tr>
  6207. <td>
  6208. <code>server</code></br>
  6209. <em>
  6210. <a href="#external-secrets.io/v1beta1.KubernetesServer">
  6211. KubernetesServer
  6212. </a>
  6213. </em>
  6214. </td>
  6215. <td>
  6216. <em>(Optional)</em>
  6217. <p>configures the Kubernetes server Address.</p>
  6218. </td>
  6219. </tr>
  6220. <tr>
  6221. <td>
  6222. <code>auth</code></br>
  6223. <em>
  6224. <a href="#external-secrets.io/v1beta1.KubernetesAuth">
  6225. KubernetesAuth
  6226. </a>
  6227. </em>
  6228. </td>
  6229. <td>
  6230. <em>(Optional)</em>
  6231. <p>Auth configures how secret-manager authenticates with a Kubernetes instance.</p>
  6232. </td>
  6233. </tr>
  6234. <tr>
  6235. <td>
  6236. <code>authRef</code></br>
  6237. <em>
  6238. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6239. External Secrets meta/v1.SecretKeySelector
  6240. </a>
  6241. </em>
  6242. </td>
  6243. <td>
  6244. <em>(Optional)</em>
  6245. <p>A reference to a secret that contains the auth information.</p>
  6246. </td>
  6247. </tr>
  6248. <tr>
  6249. <td>
  6250. <code>remoteNamespace</code></br>
  6251. <em>
  6252. string
  6253. </em>
  6254. </td>
  6255. <td>
  6256. <em>(Optional)</em>
  6257. <p>Remote namespace to fetch the secrets from</p>
  6258. </td>
  6259. </tr>
  6260. </tbody>
  6261. </table>
  6262. <h3 id="external-secrets.io/v1beta1.KubernetesServer">KubernetesServer
  6263. </h3>
  6264. <p>
  6265. (<em>Appears on:</em>
  6266. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  6267. </p>
  6268. <p>
  6269. </p>
  6270. <table>
  6271. <thead>
  6272. <tr>
  6273. <th>Field</th>
  6274. <th>Description</th>
  6275. </tr>
  6276. </thead>
  6277. <tbody>
  6278. <tr>
  6279. <td>
  6280. <code>url</code></br>
  6281. <em>
  6282. string
  6283. </em>
  6284. </td>
  6285. <td>
  6286. <em>(Optional)</em>
  6287. <p>configures the Kubernetes server Address.</p>
  6288. </td>
  6289. </tr>
  6290. <tr>
  6291. <td>
  6292. <code>caBundle</code></br>
  6293. <em>
  6294. []byte
  6295. </em>
  6296. </td>
  6297. <td>
  6298. <em>(Optional)</em>
  6299. <p>CABundle is a base64-encoded CA certificate</p>
  6300. </td>
  6301. </tr>
  6302. <tr>
  6303. <td>
  6304. <code>caProvider</code></br>
  6305. <em>
  6306. <a href="#external-secrets.io/v1beta1.CAProvider">
  6307. CAProvider
  6308. </a>
  6309. </em>
  6310. </td>
  6311. <td>
  6312. <em>(Optional)</em>
  6313. <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>
  6314. </td>
  6315. </tr>
  6316. </tbody>
  6317. </table>
  6318. <h3 id="external-secrets.io/v1beta1.MachineIdentityScopeInWorkspace">MachineIdentityScopeInWorkspace
  6319. </h3>
  6320. <p>
  6321. (<em>Appears on:</em>
  6322. <a href="#external-secrets.io/v1beta1.InfisicalProvider">InfisicalProvider</a>)
  6323. </p>
  6324. <p>
  6325. </p>
  6326. <table>
  6327. <thead>
  6328. <tr>
  6329. <th>Field</th>
  6330. <th>Description</th>
  6331. </tr>
  6332. </thead>
  6333. <tbody>
  6334. <tr>
  6335. <td>
  6336. <code>secretsPath</code></br>
  6337. <em>
  6338. string
  6339. </em>
  6340. </td>
  6341. <td>
  6342. <em>(Optional)</em>
  6343. </td>
  6344. </tr>
  6345. <tr>
  6346. <td>
  6347. <code>recursive</code></br>
  6348. <em>
  6349. bool
  6350. </em>
  6351. </td>
  6352. <td>
  6353. <em>(Optional)</em>
  6354. </td>
  6355. </tr>
  6356. <tr>
  6357. <td>
  6358. <code>environmentSlug</code></br>
  6359. <em>
  6360. string
  6361. </em>
  6362. </td>
  6363. <td>
  6364. </td>
  6365. </tr>
  6366. <tr>
  6367. <td>
  6368. <code>projectSlug</code></br>
  6369. <em>
  6370. string
  6371. </em>
  6372. </td>
  6373. <td>
  6374. </td>
  6375. </tr>
  6376. </tbody>
  6377. </table>
  6378. <h3 id="external-secrets.io/v1beta1.NoSecretError">NoSecretError
  6379. </h3>
  6380. <p>
  6381. <p>NoSecretError shall be returned when a GetSecret can not find the
  6382. desired secret. This is used for deletionPolicy.</p>
  6383. </p>
  6384. <h3 id="external-secrets.io/v1beta1.NotModifiedError">NotModifiedError
  6385. </h3>
  6386. <p>
  6387. <p>NotModifiedError to signal that the webhook received no changes,
  6388. and it should just return without doing anything.</p>
  6389. </p>
  6390. <h3 id="external-secrets.io/v1beta1.OnboardbaseAuthSecretRef">OnboardbaseAuthSecretRef
  6391. </h3>
  6392. <p>
  6393. (<em>Appears on:</em>
  6394. <a href="#external-secrets.io/v1beta1.OnboardbaseProvider">OnboardbaseProvider</a>)
  6395. </p>
  6396. <p>
  6397. <p>OnboardbaseAuthSecretRef holds secret references for onboardbase API Key credentials.</p>
  6398. </p>
  6399. <table>
  6400. <thead>
  6401. <tr>
  6402. <th>Field</th>
  6403. <th>Description</th>
  6404. </tr>
  6405. </thead>
  6406. <tbody>
  6407. <tr>
  6408. <td>
  6409. <code>apiKeyRef</code></br>
  6410. <em>
  6411. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6412. External Secrets meta/v1.SecretKeySelector
  6413. </a>
  6414. </em>
  6415. </td>
  6416. <td>
  6417. <p>OnboardbaseAPIKey is the APIKey generated by an admin account.
  6418. It is used to recognize and authorize access to a project and environment within onboardbase</p>
  6419. </td>
  6420. </tr>
  6421. <tr>
  6422. <td>
  6423. <code>passcodeRef</code></br>
  6424. <em>
  6425. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6426. External Secrets meta/v1.SecretKeySelector
  6427. </a>
  6428. </em>
  6429. </td>
  6430. <td>
  6431. <p>OnboardbasePasscode is the passcode attached to the API Key</p>
  6432. </td>
  6433. </tr>
  6434. </tbody>
  6435. </table>
  6436. <h3 id="external-secrets.io/v1beta1.OnboardbaseProvider">OnboardbaseProvider
  6437. </h3>
  6438. <p>
  6439. (<em>Appears on:</em>
  6440. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6441. </p>
  6442. <p>
  6443. <p>OnboardbaseProvider configures a store to sync secrets using the Onboardbase provider.
  6444. Project and Config are required if not using a Service Token.</p>
  6445. </p>
  6446. <table>
  6447. <thead>
  6448. <tr>
  6449. <th>Field</th>
  6450. <th>Description</th>
  6451. </tr>
  6452. </thead>
  6453. <tbody>
  6454. <tr>
  6455. <td>
  6456. <code>auth</code></br>
  6457. <em>
  6458. <a href="#external-secrets.io/v1beta1.OnboardbaseAuthSecretRef">
  6459. OnboardbaseAuthSecretRef
  6460. </a>
  6461. </em>
  6462. </td>
  6463. <td>
  6464. <p>Auth configures how the Operator authenticates with the Onboardbase API</p>
  6465. </td>
  6466. </tr>
  6467. <tr>
  6468. <td>
  6469. <code>apiHost</code></br>
  6470. <em>
  6471. string
  6472. </em>
  6473. </td>
  6474. <td>
  6475. <p>APIHost use this to configure the host url for the API for selfhosted installation, default is <a href="https://public.onboardbase.com/api/v1/">https://public.onboardbase.com/api/v1/</a></p>
  6476. </td>
  6477. </tr>
  6478. <tr>
  6479. <td>
  6480. <code>project</code></br>
  6481. <em>
  6482. string
  6483. </em>
  6484. </td>
  6485. <td>
  6486. <p>Project is an onboardbase project that the secrets should be pulled from</p>
  6487. </td>
  6488. </tr>
  6489. <tr>
  6490. <td>
  6491. <code>environment</code></br>
  6492. <em>
  6493. string
  6494. </em>
  6495. </td>
  6496. <td>
  6497. <p>Environment is the name of an environmnent within a project to pull the secrets from</p>
  6498. </td>
  6499. </tr>
  6500. </tbody>
  6501. </table>
  6502. <h3 id="external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth
  6503. </h3>
  6504. <p>
  6505. (<em>Appears on:</em>
  6506. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider</a>)
  6507. </p>
  6508. <p>
  6509. <p>OnePasswordAuth contains a secretRef for credentials.</p>
  6510. </p>
  6511. <table>
  6512. <thead>
  6513. <tr>
  6514. <th>Field</th>
  6515. <th>Description</th>
  6516. </tr>
  6517. </thead>
  6518. <tbody>
  6519. <tr>
  6520. <td>
  6521. <code>secretRef</code></br>
  6522. <em>
  6523. <a href="#external-secrets.io/v1beta1.OnePasswordAuthSecretRef">
  6524. OnePasswordAuthSecretRef
  6525. </a>
  6526. </em>
  6527. </td>
  6528. <td>
  6529. </td>
  6530. </tr>
  6531. </tbody>
  6532. </table>
  6533. <h3 id="external-secrets.io/v1beta1.OnePasswordAuthSecretRef">OnePasswordAuthSecretRef
  6534. </h3>
  6535. <p>
  6536. (<em>Appears on:</em>
  6537. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth</a>)
  6538. </p>
  6539. <p>
  6540. <p>OnePasswordAuthSecretRef holds secret references for 1Password credentials.</p>
  6541. </p>
  6542. <table>
  6543. <thead>
  6544. <tr>
  6545. <th>Field</th>
  6546. <th>Description</th>
  6547. </tr>
  6548. </thead>
  6549. <tbody>
  6550. <tr>
  6551. <td>
  6552. <code>connectTokenSecretRef</code></br>
  6553. <em>
  6554. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6555. External Secrets meta/v1.SecretKeySelector
  6556. </a>
  6557. </em>
  6558. </td>
  6559. <td>
  6560. <p>The ConnectToken is used for authentication to a 1Password Connect Server.</p>
  6561. </td>
  6562. </tr>
  6563. </tbody>
  6564. </table>
  6565. <h3 id="external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider
  6566. </h3>
  6567. <p>
  6568. (<em>Appears on:</em>
  6569. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6570. </p>
  6571. <p>
  6572. <p>OnePasswordProvider configures a store to sync secrets using the 1Password Secret Manager provider.</p>
  6573. </p>
  6574. <table>
  6575. <thead>
  6576. <tr>
  6577. <th>Field</th>
  6578. <th>Description</th>
  6579. </tr>
  6580. </thead>
  6581. <tbody>
  6582. <tr>
  6583. <td>
  6584. <code>auth</code></br>
  6585. <em>
  6586. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">
  6587. OnePasswordAuth
  6588. </a>
  6589. </em>
  6590. </td>
  6591. <td>
  6592. <p>Auth defines the information necessary to authenticate against OnePassword Connect Server</p>
  6593. </td>
  6594. </tr>
  6595. <tr>
  6596. <td>
  6597. <code>connectHost</code></br>
  6598. <em>
  6599. string
  6600. </em>
  6601. </td>
  6602. <td>
  6603. <p>ConnectHost defines the OnePassword Connect Server to connect to</p>
  6604. </td>
  6605. </tr>
  6606. <tr>
  6607. <td>
  6608. <code>vaults</code></br>
  6609. <em>
  6610. map[string]int
  6611. </em>
  6612. </td>
  6613. <td>
  6614. <p>Vaults defines which OnePassword vaults to search in which order</p>
  6615. </td>
  6616. </tr>
  6617. </tbody>
  6618. </table>
  6619. <h3 id="external-secrets.io/v1beta1.OracleAuth">OracleAuth
  6620. </h3>
  6621. <p>
  6622. (<em>Appears on:</em>
  6623. <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
  6624. </p>
  6625. <p>
  6626. </p>
  6627. <table>
  6628. <thead>
  6629. <tr>
  6630. <th>Field</th>
  6631. <th>Description</th>
  6632. </tr>
  6633. </thead>
  6634. <tbody>
  6635. <tr>
  6636. <td>
  6637. <code>tenancy</code></br>
  6638. <em>
  6639. string
  6640. </em>
  6641. </td>
  6642. <td>
  6643. <p>Tenancy is the tenancy OCID where user is located.</p>
  6644. </td>
  6645. </tr>
  6646. <tr>
  6647. <td>
  6648. <code>user</code></br>
  6649. <em>
  6650. string
  6651. </em>
  6652. </td>
  6653. <td>
  6654. <p>User is an access OCID specific to the account.</p>
  6655. </td>
  6656. </tr>
  6657. <tr>
  6658. <td>
  6659. <code>secretRef</code></br>
  6660. <em>
  6661. <a href="#external-secrets.io/v1beta1.OracleSecretRef">
  6662. OracleSecretRef
  6663. </a>
  6664. </em>
  6665. </td>
  6666. <td>
  6667. <p>SecretRef to pass through sensitive information.</p>
  6668. </td>
  6669. </tr>
  6670. </tbody>
  6671. </table>
  6672. <h3 id="external-secrets.io/v1beta1.OraclePrincipalType">OraclePrincipalType
  6673. (<code>string</code> alias)</p></h3>
  6674. <p>
  6675. (<em>Appears on:</em>
  6676. <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
  6677. </p>
  6678. <p>
  6679. </p>
  6680. <table>
  6681. <thead>
  6682. <tr>
  6683. <th>Value</th>
  6684. <th>Description</th>
  6685. </tr>
  6686. </thead>
  6687. <tbody><tr><td><p>&#34;InstancePrincipal&#34;</p></td>
  6688. <td><p>InstancePrincipal represents a instance principal.</p>
  6689. </td>
  6690. </tr><tr><td><p>&#34;UserPrincipal&#34;</p></td>
  6691. <td><p>UserPrincipal represents a user principal.</p>
  6692. </td>
  6693. </tr><tr><td><p>&#34;Workload&#34;</p></td>
  6694. <td><p>WorkloadPrincipal represents a workload principal.</p>
  6695. </td>
  6696. </tr></tbody>
  6697. </table>
  6698. <h3 id="external-secrets.io/v1beta1.OracleProvider">OracleProvider
  6699. </h3>
  6700. <p>
  6701. (<em>Appears on:</em>
  6702. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6703. </p>
  6704. <p>
  6705. <p>Configures an store to sync secrets using a Oracle Vault
  6706. backend.</p>
  6707. </p>
  6708. <table>
  6709. <thead>
  6710. <tr>
  6711. <th>Field</th>
  6712. <th>Description</th>
  6713. </tr>
  6714. </thead>
  6715. <tbody>
  6716. <tr>
  6717. <td>
  6718. <code>region</code></br>
  6719. <em>
  6720. string
  6721. </em>
  6722. </td>
  6723. <td>
  6724. <p>Region is the region where vault is located.</p>
  6725. </td>
  6726. </tr>
  6727. <tr>
  6728. <td>
  6729. <code>vault</code></br>
  6730. <em>
  6731. string
  6732. </em>
  6733. </td>
  6734. <td>
  6735. <p>Vault is the vault&rsquo;s OCID of the specific vault where secret is located.</p>
  6736. </td>
  6737. </tr>
  6738. <tr>
  6739. <td>
  6740. <code>compartment</code></br>
  6741. <em>
  6742. string
  6743. </em>
  6744. </td>
  6745. <td>
  6746. <em>(Optional)</em>
  6747. <p>Compartment is the vault compartment OCID.
  6748. Required for PushSecret</p>
  6749. </td>
  6750. </tr>
  6751. <tr>
  6752. <td>
  6753. <code>encryptionKey</code></br>
  6754. <em>
  6755. string
  6756. </em>
  6757. </td>
  6758. <td>
  6759. <em>(Optional)</em>
  6760. <p>EncryptionKey is the OCID of the encryption key within the vault.
  6761. Required for PushSecret</p>
  6762. </td>
  6763. </tr>
  6764. <tr>
  6765. <td>
  6766. <code>principalType</code></br>
  6767. <em>
  6768. <a href="#external-secrets.io/v1beta1.OraclePrincipalType">
  6769. OraclePrincipalType
  6770. </a>
  6771. </em>
  6772. </td>
  6773. <td>
  6774. <em>(Optional)</em>
  6775. <p>The type of principal to use for authentication. If left blank, the Auth struct will
  6776. determine the principal type. This optional field must be specified if using
  6777. workload identity.</p>
  6778. </td>
  6779. </tr>
  6780. <tr>
  6781. <td>
  6782. <code>auth</code></br>
  6783. <em>
  6784. <a href="#external-secrets.io/v1beta1.OracleAuth">
  6785. OracleAuth
  6786. </a>
  6787. </em>
  6788. </td>
  6789. <td>
  6790. <em>(Optional)</em>
  6791. <p>Auth configures how secret-manager authenticates with the Oracle Vault.
  6792. If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
  6793. </td>
  6794. </tr>
  6795. <tr>
  6796. <td>
  6797. <code>serviceAccountRef</code></br>
  6798. <em>
  6799. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  6800. External Secrets meta/v1.ServiceAccountSelector
  6801. </a>
  6802. </em>
  6803. </td>
  6804. <td>
  6805. <em>(Optional)</em>
  6806. <p>ServiceAccountRef specified the service account
  6807. that should be used when authenticating with WorkloadIdentity.</p>
  6808. </td>
  6809. </tr>
  6810. </tbody>
  6811. </table>
  6812. <h3 id="external-secrets.io/v1beta1.OracleSecretRef">OracleSecretRef
  6813. </h3>
  6814. <p>
  6815. (<em>Appears on:</em>
  6816. <a href="#external-secrets.io/v1beta1.OracleAuth">OracleAuth</a>)
  6817. </p>
  6818. <p>
  6819. </p>
  6820. <table>
  6821. <thead>
  6822. <tr>
  6823. <th>Field</th>
  6824. <th>Description</th>
  6825. </tr>
  6826. </thead>
  6827. <tbody>
  6828. <tr>
  6829. <td>
  6830. <code>privatekey</code></br>
  6831. <em>
  6832. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6833. External Secrets meta/v1.SecretKeySelector
  6834. </a>
  6835. </em>
  6836. </td>
  6837. <td>
  6838. <p>PrivateKey is the user&rsquo;s API Signing Key in PEM format, used for authentication.</p>
  6839. </td>
  6840. </tr>
  6841. <tr>
  6842. <td>
  6843. <code>fingerprint</code></br>
  6844. <em>
  6845. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6846. External Secrets meta/v1.SecretKeySelector
  6847. </a>
  6848. </em>
  6849. </td>
  6850. <td>
  6851. <p>Fingerprint is the fingerprint of the API private key.</p>
  6852. </td>
  6853. </tr>
  6854. </tbody>
  6855. </table>
  6856. <h3 id="external-secrets.io/v1beta1.PassboltAuth">PassboltAuth
  6857. </h3>
  6858. <p>
  6859. (<em>Appears on:</em>
  6860. <a href="#external-secrets.io/v1beta1.PassboltProvider">PassboltProvider</a>)
  6861. </p>
  6862. <p>
  6863. <p>Passbolt contains a secretRef for the passbolt credentials.</p>
  6864. </p>
  6865. <table>
  6866. <thead>
  6867. <tr>
  6868. <th>Field</th>
  6869. <th>Description</th>
  6870. </tr>
  6871. </thead>
  6872. <tbody>
  6873. <tr>
  6874. <td>
  6875. <code>passwordSecretRef</code></br>
  6876. <em>
  6877. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6878. External Secrets meta/v1.SecretKeySelector
  6879. </a>
  6880. </em>
  6881. </td>
  6882. <td>
  6883. </td>
  6884. </tr>
  6885. <tr>
  6886. <td>
  6887. <code>privateKeySecretRef</code></br>
  6888. <em>
  6889. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6890. External Secrets meta/v1.SecretKeySelector
  6891. </a>
  6892. </em>
  6893. </td>
  6894. <td>
  6895. </td>
  6896. </tr>
  6897. </tbody>
  6898. </table>
  6899. <h3 id="external-secrets.io/v1beta1.PassboltProvider">PassboltProvider
  6900. </h3>
  6901. <p>
  6902. (<em>Appears on:</em>
  6903. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6904. </p>
  6905. <p>
  6906. </p>
  6907. <table>
  6908. <thead>
  6909. <tr>
  6910. <th>Field</th>
  6911. <th>Description</th>
  6912. </tr>
  6913. </thead>
  6914. <tbody>
  6915. <tr>
  6916. <td>
  6917. <code>auth</code></br>
  6918. <em>
  6919. <a href="#external-secrets.io/v1beta1.PassboltAuth">
  6920. PassboltAuth
  6921. </a>
  6922. </em>
  6923. </td>
  6924. <td>
  6925. <p>Auth defines the information necessary to authenticate against Passbolt Server</p>
  6926. </td>
  6927. </tr>
  6928. <tr>
  6929. <td>
  6930. <code>host</code></br>
  6931. <em>
  6932. string
  6933. </em>
  6934. </td>
  6935. <td>
  6936. <p>Host defines the Passbolt Server to connect to</p>
  6937. </td>
  6938. </tr>
  6939. </tbody>
  6940. </table>
  6941. <h3 id="external-secrets.io/v1beta1.PasswordDepotAuth">PasswordDepotAuth
  6942. </h3>
  6943. <p>
  6944. (<em>Appears on:</em>
  6945. <a href="#external-secrets.io/v1beta1.PasswordDepotProvider">PasswordDepotProvider</a>)
  6946. </p>
  6947. <p>
  6948. </p>
  6949. <table>
  6950. <thead>
  6951. <tr>
  6952. <th>Field</th>
  6953. <th>Description</th>
  6954. </tr>
  6955. </thead>
  6956. <tbody>
  6957. <tr>
  6958. <td>
  6959. <code>secretRef</code></br>
  6960. <em>
  6961. <a href="#external-secrets.io/v1beta1.PasswordDepotSecretRef">
  6962. PasswordDepotSecretRef
  6963. </a>
  6964. </em>
  6965. </td>
  6966. <td>
  6967. </td>
  6968. </tr>
  6969. </tbody>
  6970. </table>
  6971. <h3 id="external-secrets.io/v1beta1.PasswordDepotProvider">PasswordDepotProvider
  6972. </h3>
  6973. <p>
  6974. (<em>Appears on:</em>
  6975. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6976. </p>
  6977. <p>
  6978. <p>Configures a store to sync secrets with a Password Depot instance.</p>
  6979. </p>
  6980. <table>
  6981. <thead>
  6982. <tr>
  6983. <th>Field</th>
  6984. <th>Description</th>
  6985. </tr>
  6986. </thead>
  6987. <tbody>
  6988. <tr>
  6989. <td>
  6990. <code>host</code></br>
  6991. <em>
  6992. string
  6993. </em>
  6994. </td>
  6995. <td>
  6996. <p>URL configures the Password Depot instance URL.</p>
  6997. </td>
  6998. </tr>
  6999. <tr>
  7000. <td>
  7001. <code>database</code></br>
  7002. <em>
  7003. string
  7004. </em>
  7005. </td>
  7006. <td>
  7007. <p>Database to use as source</p>
  7008. </td>
  7009. </tr>
  7010. <tr>
  7011. <td>
  7012. <code>auth</code></br>
  7013. <em>
  7014. <a href="#external-secrets.io/v1beta1.PasswordDepotAuth">
  7015. PasswordDepotAuth
  7016. </a>
  7017. </em>
  7018. </td>
  7019. <td>
  7020. <p>Auth configures how secret-manager authenticates with a Password Depot instance.</p>
  7021. </td>
  7022. </tr>
  7023. </tbody>
  7024. </table>
  7025. <h3 id="external-secrets.io/v1beta1.PasswordDepotSecretRef">PasswordDepotSecretRef
  7026. </h3>
  7027. <p>
  7028. (<em>Appears on:</em>
  7029. <a href="#external-secrets.io/v1beta1.PasswordDepotAuth">PasswordDepotAuth</a>)
  7030. </p>
  7031. <p>
  7032. </p>
  7033. <table>
  7034. <thead>
  7035. <tr>
  7036. <th>Field</th>
  7037. <th>Description</th>
  7038. </tr>
  7039. </thead>
  7040. <tbody>
  7041. <tr>
  7042. <td>
  7043. <code>credentials</code></br>
  7044. <em>
  7045. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7046. External Secrets meta/v1.SecretKeySelector
  7047. </a>
  7048. </em>
  7049. </td>
  7050. <td>
  7051. <em>(Optional)</em>
  7052. <p>Username / Password is used for authentication.</p>
  7053. </td>
  7054. </tr>
  7055. </tbody>
  7056. </table>
  7057. <h3 id="external-secrets.io/v1beta1.PreviderAuth">PreviderAuth
  7058. </h3>
  7059. <p>
  7060. (<em>Appears on:</em>
  7061. <a href="#external-secrets.io/v1beta1.PreviderProvider">PreviderProvider</a>)
  7062. </p>
  7063. <p>
  7064. <p>PreviderAuth contains a secretRef for credentials.</p>
  7065. </p>
  7066. <table>
  7067. <thead>
  7068. <tr>
  7069. <th>Field</th>
  7070. <th>Description</th>
  7071. </tr>
  7072. </thead>
  7073. <tbody>
  7074. <tr>
  7075. <td>
  7076. <code>secretRef</code></br>
  7077. <em>
  7078. <a href="#external-secrets.io/v1beta1.PreviderAuthSecretRef">
  7079. PreviderAuthSecretRef
  7080. </a>
  7081. </em>
  7082. </td>
  7083. <td>
  7084. <em>(Optional)</em>
  7085. </td>
  7086. </tr>
  7087. </tbody>
  7088. </table>
  7089. <h3 id="external-secrets.io/v1beta1.PreviderAuthSecretRef">PreviderAuthSecretRef
  7090. </h3>
  7091. <p>
  7092. (<em>Appears on:</em>
  7093. <a href="#external-secrets.io/v1beta1.PreviderAuth">PreviderAuth</a>)
  7094. </p>
  7095. <p>
  7096. <p>PreviderAuthSecretRef holds secret references for Previder Vault credentials.</p>
  7097. </p>
  7098. <table>
  7099. <thead>
  7100. <tr>
  7101. <th>Field</th>
  7102. <th>Description</th>
  7103. </tr>
  7104. </thead>
  7105. <tbody>
  7106. <tr>
  7107. <td>
  7108. <code>accessToken</code></br>
  7109. <em>
  7110. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7111. External Secrets meta/v1.SecretKeySelector
  7112. </a>
  7113. </em>
  7114. </td>
  7115. <td>
  7116. <p>The AccessToken is used for authentication</p>
  7117. </td>
  7118. </tr>
  7119. </tbody>
  7120. </table>
  7121. <h3 id="external-secrets.io/v1beta1.PreviderProvider">PreviderProvider
  7122. </h3>
  7123. <p>
  7124. (<em>Appears on:</em>
  7125. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  7126. </p>
  7127. <p>
  7128. <p>PreviderProvider configures a store to sync secrets using the Previder Secret Manager provider.</p>
  7129. </p>
  7130. <table>
  7131. <thead>
  7132. <tr>
  7133. <th>Field</th>
  7134. <th>Description</th>
  7135. </tr>
  7136. </thead>
  7137. <tbody>
  7138. <tr>
  7139. <td>
  7140. <code>auth</code></br>
  7141. <em>
  7142. <a href="#external-secrets.io/v1beta1.PreviderAuth">
  7143. PreviderAuth
  7144. </a>
  7145. </em>
  7146. </td>
  7147. <td>
  7148. </td>
  7149. </tr>
  7150. <tr>
  7151. <td>
  7152. <code>baseUri</code></br>
  7153. <em>
  7154. string
  7155. </em>
  7156. </td>
  7157. <td>
  7158. <em>(Optional)</em>
  7159. </td>
  7160. </tr>
  7161. </tbody>
  7162. </table>
  7163. <h3 id="external-secrets.io/v1beta1.Provider">Provider
  7164. </h3>
  7165. <p>
  7166. <p>Provider is a common interface for interacting with secret backends.</p>
  7167. </p>
  7168. <h3 id="external-secrets.io/v1beta1.PulumiProvider">PulumiProvider
  7169. </h3>
  7170. <p>
  7171. (<em>Appears on:</em>
  7172. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  7173. </p>
  7174. <p>
  7175. </p>
  7176. <table>
  7177. <thead>
  7178. <tr>
  7179. <th>Field</th>
  7180. <th>Description</th>
  7181. </tr>
  7182. </thead>
  7183. <tbody>
  7184. <tr>
  7185. <td>
  7186. <code>apiUrl</code></br>
  7187. <em>
  7188. string
  7189. </em>
  7190. </td>
  7191. <td>
  7192. <p>APIURL is the URL of the Pulumi API.</p>
  7193. </td>
  7194. </tr>
  7195. <tr>
  7196. <td>
  7197. <code>accessToken</code></br>
  7198. <em>
  7199. <a href="#external-secrets.io/v1beta1.PulumiProviderSecretRef">
  7200. PulumiProviderSecretRef
  7201. </a>
  7202. </em>
  7203. </td>
  7204. <td>
  7205. <p>AccessToken is the access tokens to sign in to the Pulumi Cloud Console.</p>
  7206. </td>
  7207. </tr>
  7208. <tr>
  7209. <td>
  7210. <code>organization</code></br>
  7211. <em>
  7212. string
  7213. </em>
  7214. </td>
  7215. <td>
  7216. <p>Organization are a space to collaborate on shared projects and stacks.
  7217. To create a new organization, visit <a href="https://app.pulumi.com/">https://app.pulumi.com/</a> and click &ldquo;New Organization&rdquo;.</p>
  7218. </td>
  7219. </tr>
  7220. <tr>
  7221. <td>
  7222. <code>project</code></br>
  7223. <em>
  7224. string
  7225. </em>
  7226. </td>
  7227. <td>
  7228. <p>Project is the name of the Pulumi ESC project the environment belongs to.</p>
  7229. </td>
  7230. </tr>
  7231. <tr>
  7232. <td>
  7233. <code>environment</code></br>
  7234. <em>
  7235. string
  7236. </em>
  7237. </td>
  7238. <td>
  7239. <p>Environment are YAML documents composed of static key-value pairs, programmatic expressions,
  7240. dynamically retrieved values from supported providers including all major clouds,
  7241. and other Pulumi ESC environments.
  7242. To create a new environment, visit <a href="https://www.pulumi.com/docs/esc/environments/">https://www.pulumi.com/docs/esc/environments/</a> for more information.</p>
  7243. </td>
  7244. </tr>
  7245. </tbody>
  7246. </table>
  7247. <h3 id="external-secrets.io/v1beta1.PulumiProviderSecretRef">PulumiProviderSecretRef
  7248. </h3>
  7249. <p>
  7250. (<em>Appears on:</em>
  7251. <a href="#external-secrets.io/v1beta1.PulumiProvider">PulumiProvider</a>)
  7252. </p>
  7253. <p>
  7254. </p>
  7255. <table>
  7256. <thead>
  7257. <tr>
  7258. <th>Field</th>
  7259. <th>Description</th>
  7260. </tr>
  7261. </thead>
  7262. <tbody>
  7263. <tr>
  7264. <td>
  7265. <code>secretRef</code></br>
  7266. <em>
  7267. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7268. External Secrets meta/v1.SecretKeySelector
  7269. </a>
  7270. </em>
  7271. </td>
  7272. <td>
  7273. <p>SecretRef is a reference to a secret containing the Pulumi API token.</p>
  7274. </td>
  7275. </tr>
  7276. </tbody>
  7277. </table>
  7278. <h3 id="external-secrets.io/v1beta1.PushSecretData">PushSecretData
  7279. </h3>
  7280. <p>
  7281. <p>PushSecretData is an interface to allow using v1alpha1.PushSecretData content in Provider registered in v1beta1.</p>
  7282. </p>
  7283. <h3 id="external-secrets.io/v1beta1.PushSecretRemoteRef">PushSecretRemoteRef
  7284. </h3>
  7285. <p>
  7286. <p>PushSecretRemoteRef is an interface to allow using v1alpha1.PushSecretRemoteRef in Provider registered in v1beta1.</p>
  7287. </p>
  7288. <h3 id="external-secrets.io/v1beta1.ScalewayProvider">ScalewayProvider
  7289. </h3>
  7290. <p>
  7291. (<em>Appears on:</em>
  7292. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  7293. </p>
  7294. <p>
  7295. </p>
  7296. <table>
  7297. <thead>
  7298. <tr>
  7299. <th>Field</th>
  7300. <th>Description</th>
  7301. </tr>
  7302. </thead>
  7303. <tbody>
  7304. <tr>
  7305. <td>
  7306. <code>apiUrl</code></br>
  7307. <em>
  7308. string
  7309. </em>
  7310. </td>
  7311. <td>
  7312. <em>(Optional)</em>
  7313. <p>APIURL is the url of the api to use. Defaults to <a href="https://api.scaleway.com">https://api.scaleway.com</a></p>
  7314. </td>
  7315. </tr>
  7316. <tr>
  7317. <td>
  7318. <code>region</code></br>
  7319. <em>
  7320. string
  7321. </em>
  7322. </td>
  7323. <td>
  7324. <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>
  7325. </td>
  7326. </tr>
  7327. <tr>
  7328. <td>
  7329. <code>projectId</code></br>
  7330. <em>
  7331. string
  7332. </em>
  7333. </td>
  7334. <td>
  7335. <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>
  7336. </td>
  7337. </tr>
  7338. <tr>
  7339. <td>
  7340. <code>accessKey</code></br>
  7341. <em>
  7342. <a href="#external-secrets.io/v1beta1.ScalewayProviderSecretRef">
  7343. ScalewayProviderSecretRef
  7344. </a>
  7345. </em>
  7346. </td>
  7347. <td>
  7348. <p>AccessKey is the non-secret part of the api key.</p>
  7349. </td>
  7350. </tr>
  7351. <tr>
  7352. <td>
  7353. <code>secretKey</code></br>
  7354. <em>
  7355. <a href="#external-secrets.io/v1beta1.ScalewayProviderSecretRef">
  7356. ScalewayProviderSecretRef
  7357. </a>
  7358. </em>
  7359. </td>
  7360. <td>
  7361. <p>SecretKey is the non-secret part of the api key.</p>
  7362. </td>
  7363. </tr>
  7364. </tbody>
  7365. </table>
  7366. <h3 id="external-secrets.io/v1beta1.ScalewayProviderSecretRef">ScalewayProviderSecretRef
  7367. </h3>
  7368. <p>
  7369. (<em>Appears on:</em>
  7370. <a href="#external-secrets.io/v1beta1.ScalewayProvider">ScalewayProvider</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>value</code></br>
  7385. <em>
  7386. string
  7387. </em>
  7388. </td>
  7389. <td>
  7390. <em>(Optional)</em>
  7391. <p>Value can be specified directly to set a value without using a secret.</p>
  7392. </td>
  7393. </tr>
  7394. <tr>
  7395. <td>
  7396. <code>secretRef</code></br>
  7397. <em>
  7398. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7399. External Secrets meta/v1.SecretKeySelector
  7400. </a>
  7401. </em>
  7402. </td>
  7403. <td>
  7404. <em>(Optional)</em>
  7405. <p>SecretRef references a key in a secret that will be used as value.</p>
  7406. </td>
  7407. </tr>
  7408. </tbody>
  7409. </table>
  7410. <h3 id="external-secrets.io/v1beta1.SecretServerProvider">SecretServerProvider
  7411. </h3>
  7412. <p>
  7413. (<em>Appears on:</em>
  7414. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  7415. </p>
  7416. <p>
  7417. <p>See <a href="https://github.com/DelineaXPM/tss-sdk-go/blob/main/server/server.go">https://github.com/DelineaXPM/tss-sdk-go/blob/main/server/server.go</a>.</p>
  7418. </p>
  7419. <table>
  7420. <thead>
  7421. <tr>
  7422. <th>Field</th>
  7423. <th>Description</th>
  7424. </tr>
  7425. </thead>
  7426. <tbody>
  7427. <tr>
  7428. <td>
  7429. <code>username</code></br>
  7430. <em>
  7431. <a href="#external-secrets.io/v1beta1.SecretServerProviderRef">
  7432. SecretServerProviderRef
  7433. </a>
  7434. </em>
  7435. </td>
  7436. <td>
  7437. <p>Username is the secret server account username.</p>
  7438. </td>
  7439. </tr>
  7440. <tr>
  7441. <td>
  7442. <code>password</code></br>
  7443. <em>
  7444. <a href="#external-secrets.io/v1beta1.SecretServerProviderRef">
  7445. SecretServerProviderRef
  7446. </a>
  7447. </em>
  7448. </td>
  7449. <td>
  7450. <p>Password is the secret server account password.</p>
  7451. </td>
  7452. </tr>
  7453. <tr>
  7454. <td>
  7455. <code>serverURL</code></br>
  7456. <em>
  7457. string
  7458. </em>
  7459. </td>
  7460. <td>
  7461. <p>ServerURL
  7462. URL to your secret server installation</p>
  7463. </td>
  7464. </tr>
  7465. </tbody>
  7466. </table>
  7467. <h3 id="external-secrets.io/v1beta1.SecretServerProviderRef">SecretServerProviderRef
  7468. </h3>
  7469. <p>
  7470. (<em>Appears on:</em>
  7471. <a href="#external-secrets.io/v1beta1.SecretServerProvider">SecretServerProvider</a>)
  7472. </p>
  7473. <p>
  7474. </p>
  7475. <table>
  7476. <thead>
  7477. <tr>
  7478. <th>Field</th>
  7479. <th>Description</th>
  7480. </tr>
  7481. </thead>
  7482. <tbody>
  7483. <tr>
  7484. <td>
  7485. <code>value</code></br>
  7486. <em>
  7487. string
  7488. </em>
  7489. </td>
  7490. <td>
  7491. <em>(Optional)</em>
  7492. <p>Value can be specified directly to set a value without using a secret.</p>
  7493. </td>
  7494. </tr>
  7495. <tr>
  7496. <td>
  7497. <code>secretRef</code></br>
  7498. <em>
  7499. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7500. External Secrets meta/v1.SecretKeySelector
  7501. </a>
  7502. </em>
  7503. </td>
  7504. <td>
  7505. <em>(Optional)</em>
  7506. <p>SecretRef references a key in a secret that will be used as value.</p>
  7507. </td>
  7508. </tr>
  7509. </tbody>
  7510. </table>
  7511. <h3 id="external-secrets.io/v1beta1.SecretStore">SecretStore
  7512. </h3>
  7513. <p>
  7514. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  7515. </p>
  7516. <table>
  7517. <thead>
  7518. <tr>
  7519. <th>Field</th>
  7520. <th>Description</th>
  7521. </tr>
  7522. </thead>
  7523. <tbody>
  7524. <tr>
  7525. <td>
  7526. <code>metadata</code></br>
  7527. <em>
  7528. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  7529. Kubernetes meta/v1.ObjectMeta
  7530. </a>
  7531. </em>
  7532. </td>
  7533. <td>
  7534. Refer to the Kubernetes API documentation for the fields of the
  7535. <code>metadata</code> field.
  7536. </td>
  7537. </tr>
  7538. <tr>
  7539. <td>
  7540. <code>spec</code></br>
  7541. <em>
  7542. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  7543. SecretStoreSpec
  7544. </a>
  7545. </em>
  7546. </td>
  7547. <td>
  7548. <br/>
  7549. <br/>
  7550. <table>
  7551. <tr>
  7552. <td>
  7553. <code>controller</code></br>
  7554. <em>
  7555. string
  7556. </em>
  7557. </td>
  7558. <td>
  7559. <em>(Optional)</em>
  7560. <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
  7561. The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
  7562. </td>
  7563. </tr>
  7564. <tr>
  7565. <td>
  7566. <code>provider</code></br>
  7567. <em>
  7568. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  7569. SecretStoreProvider
  7570. </a>
  7571. </em>
  7572. </td>
  7573. <td>
  7574. <p>Used to configure the provider. Only one provider may be set</p>
  7575. </td>
  7576. </tr>
  7577. <tr>
  7578. <td>
  7579. <code>retrySettings</code></br>
  7580. <em>
  7581. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  7582. SecretStoreRetrySettings
  7583. </a>
  7584. </em>
  7585. </td>
  7586. <td>
  7587. <em>(Optional)</em>
  7588. <p>Used to configure http retries if failed</p>
  7589. </td>
  7590. </tr>
  7591. <tr>
  7592. <td>
  7593. <code>refreshInterval</code></br>
  7594. <em>
  7595. int
  7596. </em>
  7597. </td>
  7598. <td>
  7599. <em>(Optional)</em>
  7600. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  7601. </td>
  7602. </tr>
  7603. <tr>
  7604. <td>
  7605. <code>conditions</code></br>
  7606. <em>
  7607. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  7608. []ClusterSecretStoreCondition
  7609. </a>
  7610. </em>
  7611. </td>
  7612. <td>
  7613. <em>(Optional)</em>
  7614. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  7615. </td>
  7616. </tr>
  7617. </table>
  7618. </td>
  7619. </tr>
  7620. <tr>
  7621. <td>
  7622. <code>status</code></br>
  7623. <em>
  7624. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  7625. SecretStoreStatus
  7626. </a>
  7627. </em>
  7628. </td>
  7629. <td>
  7630. </td>
  7631. </tr>
  7632. </tbody>
  7633. </table>
  7634. <h3 id="external-secrets.io/v1beta1.SecretStoreCapabilities">SecretStoreCapabilities
  7635. (<code>string</code> alias)</p></h3>
  7636. <p>
  7637. (<em>Appears on:</em>
  7638. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  7639. </p>
  7640. <p>
  7641. <p>SecretStoreCapabilities defines the possible operations a SecretStore can do.</p>
  7642. </p>
  7643. <table>
  7644. <thead>
  7645. <tr>
  7646. <th>Value</th>
  7647. <th>Description</th>
  7648. </tr>
  7649. </thead>
  7650. <tbody><tr><td><p>&#34;ReadOnly&#34;</p></td>
  7651. <td></td>
  7652. </tr><tr><td><p>&#34;ReadWrite&#34;</p></td>
  7653. <td></td>
  7654. </tr><tr><td><p>&#34;WriteOnly&#34;</p></td>
  7655. <td></td>
  7656. </tr></tbody>
  7657. </table>
  7658. <h3 id="external-secrets.io/v1beta1.SecretStoreConditionType">SecretStoreConditionType
  7659. (<code>string</code> alias)</p></h3>
  7660. <p>
  7661. (<em>Appears on:</em>
  7662. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  7663. </p>
  7664. <p>
  7665. </p>
  7666. <table>
  7667. <thead>
  7668. <tr>
  7669. <th>Value</th>
  7670. <th>Description</th>
  7671. </tr>
  7672. </thead>
  7673. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  7674. <td></td>
  7675. </tr></tbody>
  7676. </table>
  7677. <h3 id="external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider
  7678. </h3>
  7679. <p>
  7680. (<em>Appears on:</em>
  7681. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  7682. </p>
  7683. <p>
  7684. <p>SecretStoreProvider contains the provider-specific configuration.</p>
  7685. </p>
  7686. <table>
  7687. <thead>
  7688. <tr>
  7689. <th>Field</th>
  7690. <th>Description</th>
  7691. </tr>
  7692. </thead>
  7693. <tbody>
  7694. <tr>
  7695. <td>
  7696. <code>aws</code></br>
  7697. <em>
  7698. <a href="#external-secrets.io/v1beta1.AWSProvider">
  7699. AWSProvider
  7700. </a>
  7701. </em>
  7702. </td>
  7703. <td>
  7704. <em>(Optional)</em>
  7705. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  7706. </td>
  7707. </tr>
  7708. <tr>
  7709. <td>
  7710. <code>azurekv</code></br>
  7711. <em>
  7712. <a href="#external-secrets.io/v1beta1.AzureKVProvider">
  7713. AzureKVProvider
  7714. </a>
  7715. </em>
  7716. </td>
  7717. <td>
  7718. <em>(Optional)</em>
  7719. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  7720. </td>
  7721. </tr>
  7722. <tr>
  7723. <td>
  7724. <code>akeyless</code></br>
  7725. <em>
  7726. <a href="#external-secrets.io/v1beta1.AkeylessProvider">
  7727. AkeylessProvider
  7728. </a>
  7729. </em>
  7730. </td>
  7731. <td>
  7732. <em>(Optional)</em>
  7733. <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
  7734. </td>
  7735. </tr>
  7736. <tr>
  7737. <td>
  7738. <code>bitwardensecretsmanager</code></br>
  7739. <em>
  7740. <a href="#external-secrets.io/v1beta1.BitwardenSecretsManagerProvider">
  7741. BitwardenSecretsManagerProvider
  7742. </a>
  7743. </em>
  7744. </td>
  7745. <td>
  7746. <em>(Optional)</em>
  7747. <p>BitwardenSecretsManager configures this store to sync secrets using BitwardenSecretsManager provider</p>
  7748. </td>
  7749. </tr>
  7750. <tr>
  7751. <td>
  7752. <code>vault</code></br>
  7753. <em>
  7754. <a href="#external-secrets.io/v1beta1.VaultProvider">
  7755. VaultProvider
  7756. </a>
  7757. </em>
  7758. </td>
  7759. <td>
  7760. <em>(Optional)</em>
  7761. <p>Vault configures this store to sync secrets using Hashi provider</p>
  7762. </td>
  7763. </tr>
  7764. <tr>
  7765. <td>
  7766. <code>gcpsm</code></br>
  7767. <em>
  7768. <a href="#external-secrets.io/v1beta1.GCPSMProvider">
  7769. GCPSMProvider
  7770. </a>
  7771. </em>
  7772. </td>
  7773. <td>
  7774. <em>(Optional)</em>
  7775. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  7776. </td>
  7777. </tr>
  7778. <tr>
  7779. <td>
  7780. <code>oracle</code></br>
  7781. <em>
  7782. <a href="#external-secrets.io/v1beta1.OracleProvider">
  7783. OracleProvider
  7784. </a>
  7785. </em>
  7786. </td>
  7787. <td>
  7788. <em>(Optional)</em>
  7789. <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
  7790. </td>
  7791. </tr>
  7792. <tr>
  7793. <td>
  7794. <code>ibm</code></br>
  7795. <em>
  7796. <a href="#external-secrets.io/v1beta1.IBMProvider">
  7797. IBMProvider
  7798. </a>
  7799. </em>
  7800. </td>
  7801. <td>
  7802. <em>(Optional)</em>
  7803. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
  7804. </td>
  7805. </tr>
  7806. <tr>
  7807. <td>
  7808. <code>yandexcertificatemanager</code></br>
  7809. <em>
  7810. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">
  7811. YandexCertificateManagerProvider
  7812. </a>
  7813. </em>
  7814. </td>
  7815. <td>
  7816. <em>(Optional)</em>
  7817. <p>YandexCertificateManager configures this store to sync secrets using Yandex Certificate Manager provider</p>
  7818. </td>
  7819. </tr>
  7820. <tr>
  7821. <td>
  7822. <code>yandexlockbox</code></br>
  7823. <em>
  7824. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">
  7825. YandexLockboxProvider
  7826. </a>
  7827. </em>
  7828. </td>
  7829. <td>
  7830. <em>(Optional)</em>
  7831. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
  7832. </td>
  7833. </tr>
  7834. <tr>
  7835. <td>
  7836. <code>gitlab</code></br>
  7837. <em>
  7838. <a href="#external-secrets.io/v1beta1.GitlabProvider">
  7839. GitlabProvider
  7840. </a>
  7841. </em>
  7842. </td>
  7843. <td>
  7844. <em>(Optional)</em>
  7845. <p>GitLab configures this store to sync secrets using GitLab Variables provider</p>
  7846. </td>
  7847. </tr>
  7848. <tr>
  7849. <td>
  7850. <code>alibaba</code></br>
  7851. <em>
  7852. <a href="#external-secrets.io/v1beta1.AlibabaProvider">
  7853. AlibabaProvider
  7854. </a>
  7855. </em>
  7856. </td>
  7857. <td>
  7858. <em>(Optional)</em>
  7859. <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
  7860. </td>
  7861. </tr>
  7862. <tr>
  7863. <td>
  7864. <code>onepassword</code></br>
  7865. <em>
  7866. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">
  7867. OnePasswordProvider
  7868. </a>
  7869. </em>
  7870. </td>
  7871. <td>
  7872. <em>(Optional)</em>
  7873. <p>OnePassword configures this store to sync secrets using the 1Password Cloud provider</p>
  7874. </td>
  7875. </tr>
  7876. <tr>
  7877. <td>
  7878. <code>webhook</code></br>
  7879. <em>
  7880. <a href="#external-secrets.io/v1beta1.WebhookProvider">
  7881. WebhookProvider
  7882. </a>
  7883. </em>
  7884. </td>
  7885. <td>
  7886. <em>(Optional)</em>
  7887. <p>Webhook configures this store to sync secrets using a generic templated webhook</p>
  7888. </td>
  7889. </tr>
  7890. <tr>
  7891. <td>
  7892. <code>kubernetes</code></br>
  7893. <em>
  7894. <a href="#external-secrets.io/v1beta1.KubernetesProvider">
  7895. KubernetesProvider
  7896. </a>
  7897. </em>
  7898. </td>
  7899. <td>
  7900. <em>(Optional)</em>
  7901. <p>Kubernetes configures this store to sync secrets using a Kubernetes cluster provider</p>
  7902. </td>
  7903. </tr>
  7904. <tr>
  7905. <td>
  7906. <code>fake</code></br>
  7907. <em>
  7908. <a href="#external-secrets.io/v1beta1.FakeProvider">
  7909. FakeProvider
  7910. </a>
  7911. </em>
  7912. </td>
  7913. <td>
  7914. <em>(Optional)</em>
  7915. <p>Fake configures a store with static key/value pairs</p>
  7916. </td>
  7917. </tr>
  7918. <tr>
  7919. <td>
  7920. <code>senhasegura</code></br>
  7921. <em>
  7922. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">
  7923. SenhaseguraProvider
  7924. </a>
  7925. </em>
  7926. </td>
  7927. <td>
  7928. <em>(Optional)</em>
  7929. <p>Senhasegura configures this store to sync secrets using senhasegura provider</p>
  7930. </td>
  7931. </tr>
  7932. <tr>
  7933. <td>
  7934. <code>scaleway</code></br>
  7935. <em>
  7936. <a href="#external-secrets.io/v1beta1.ScalewayProvider">
  7937. ScalewayProvider
  7938. </a>
  7939. </em>
  7940. </td>
  7941. <td>
  7942. <em>(Optional)</em>
  7943. <p>Scaleway</p>
  7944. </td>
  7945. </tr>
  7946. <tr>
  7947. <td>
  7948. <code>doppler</code></br>
  7949. <em>
  7950. <a href="#external-secrets.io/v1beta1.DopplerProvider">
  7951. DopplerProvider
  7952. </a>
  7953. </em>
  7954. </td>
  7955. <td>
  7956. <em>(Optional)</em>
  7957. <p>Doppler configures this store to sync secrets using the Doppler provider</p>
  7958. </td>
  7959. </tr>
  7960. <tr>
  7961. <td>
  7962. <code>previder</code></br>
  7963. <em>
  7964. <a href="#external-secrets.io/v1beta1.PreviderProvider">
  7965. PreviderProvider
  7966. </a>
  7967. </em>
  7968. </td>
  7969. <td>
  7970. <em>(Optional)</em>
  7971. <p>Previder configures this store to sync secrets using the Previder provider</p>
  7972. </td>
  7973. </tr>
  7974. <tr>
  7975. <td>
  7976. <code>onboardbase</code></br>
  7977. <em>
  7978. <a href="#external-secrets.io/v1beta1.OnboardbaseProvider">
  7979. OnboardbaseProvider
  7980. </a>
  7981. </em>
  7982. </td>
  7983. <td>
  7984. <em>(Optional)</em>
  7985. <p>Onboardbase configures this store to sync secrets using the Onboardbase provider</p>
  7986. </td>
  7987. </tr>
  7988. <tr>
  7989. <td>
  7990. <code>keepersecurity</code></br>
  7991. <em>
  7992. <a href="#external-secrets.io/v1beta1.KeeperSecurityProvider">
  7993. KeeperSecurityProvider
  7994. </a>
  7995. </em>
  7996. </td>
  7997. <td>
  7998. <em>(Optional)</em>
  7999. <p>KeeperSecurity configures this store to sync secrets using the KeeperSecurity provider</p>
  8000. </td>
  8001. </tr>
  8002. <tr>
  8003. <td>
  8004. <code>conjur</code></br>
  8005. <em>
  8006. <a href="#external-secrets.io/v1beta1.ConjurProvider">
  8007. ConjurProvider
  8008. </a>
  8009. </em>
  8010. </td>
  8011. <td>
  8012. <em>(Optional)</em>
  8013. <p>Conjur configures this store to sync secrets using conjur provider</p>
  8014. </td>
  8015. </tr>
  8016. <tr>
  8017. <td>
  8018. <code>delinea</code></br>
  8019. <em>
  8020. <a href="#external-secrets.io/v1beta1.DelineaProvider">
  8021. DelineaProvider
  8022. </a>
  8023. </em>
  8024. </td>
  8025. <td>
  8026. <em>(Optional)</em>
  8027. <p>Delinea DevOps Secrets Vault
  8028. <a href="https://docs.delinea.com/online-help/products/devops-secrets-vault/current">https://docs.delinea.com/online-help/products/devops-secrets-vault/current</a></p>
  8029. </td>
  8030. </tr>
  8031. <tr>
  8032. <td>
  8033. <code>secretserver</code></br>
  8034. <em>
  8035. <a href="#external-secrets.io/v1beta1.SecretServerProvider">
  8036. SecretServerProvider
  8037. </a>
  8038. </em>
  8039. </td>
  8040. <td>
  8041. <em>(Optional)</em>
  8042. <p>SecretServer configures this store to sync secrets using SecretServer provider
  8043. <a href="https://docs.delinea.com/online-help/secret-server/start.htm">https://docs.delinea.com/online-help/secret-server/start.htm</a></p>
  8044. </td>
  8045. </tr>
  8046. <tr>
  8047. <td>
  8048. <code>chef</code></br>
  8049. <em>
  8050. <a href="#external-secrets.io/v1beta1.ChefProvider">
  8051. ChefProvider
  8052. </a>
  8053. </em>
  8054. </td>
  8055. <td>
  8056. <em>(Optional)</em>
  8057. <p>Chef configures this store to sync secrets with chef server</p>
  8058. </td>
  8059. </tr>
  8060. <tr>
  8061. <td>
  8062. <code>pulumi</code></br>
  8063. <em>
  8064. <a href="#external-secrets.io/v1beta1.PulumiProvider">
  8065. PulumiProvider
  8066. </a>
  8067. </em>
  8068. </td>
  8069. <td>
  8070. <em>(Optional)</em>
  8071. <p>Pulumi configures this store to sync secrets using the Pulumi provider</p>
  8072. </td>
  8073. </tr>
  8074. <tr>
  8075. <td>
  8076. <code>fortanix</code></br>
  8077. <em>
  8078. <a href="#external-secrets.io/v1beta1.FortanixProvider">
  8079. FortanixProvider
  8080. </a>
  8081. </em>
  8082. </td>
  8083. <td>
  8084. <em>(Optional)</em>
  8085. <p>Fortanix configures this store to sync secrets using the Fortanix provider</p>
  8086. </td>
  8087. </tr>
  8088. <tr>
  8089. <td>
  8090. <code>passworddepot</code></br>
  8091. <em>
  8092. <a href="#external-secrets.io/v1beta1.PasswordDepotProvider">
  8093. PasswordDepotProvider
  8094. </a>
  8095. </em>
  8096. </td>
  8097. <td>
  8098. <em>(Optional)</em>
  8099. </td>
  8100. </tr>
  8101. <tr>
  8102. <td>
  8103. <code>passbolt</code></br>
  8104. <em>
  8105. <a href="#external-secrets.io/v1beta1.PassboltProvider">
  8106. PassboltProvider
  8107. </a>
  8108. </em>
  8109. </td>
  8110. <td>
  8111. <em>(Optional)</em>
  8112. </td>
  8113. </tr>
  8114. <tr>
  8115. <td>
  8116. <code>device42</code></br>
  8117. <em>
  8118. <a href="#external-secrets.io/v1beta1.Device42Provider">
  8119. Device42Provider
  8120. </a>
  8121. </em>
  8122. </td>
  8123. <td>
  8124. <em>(Optional)</em>
  8125. <p>Device42 configures this store to sync secrets using the Device42 provider</p>
  8126. </td>
  8127. </tr>
  8128. <tr>
  8129. <td>
  8130. <code>infisical</code></br>
  8131. <em>
  8132. <a href="#external-secrets.io/v1beta1.InfisicalProvider">
  8133. InfisicalProvider
  8134. </a>
  8135. </em>
  8136. </td>
  8137. <td>
  8138. <em>(Optional)</em>
  8139. <p>Infisical configures this store to sync secrets using the Infisical provider</p>
  8140. </td>
  8141. </tr>
  8142. <tr>
  8143. <td>
  8144. <code>beyondtrust</code></br>
  8145. <em>
  8146. <a href="#external-secrets.io/v1beta1.BeyondtrustProvider">
  8147. BeyondtrustProvider
  8148. </a>
  8149. </em>
  8150. </td>
  8151. <td>
  8152. <em>(Optional)</em>
  8153. <p>Beyondtrust configures this store to sync secrets using Password Safe provider.</p>
  8154. </td>
  8155. </tr>
  8156. </tbody>
  8157. </table>
  8158. <h3 id="external-secrets.io/v1beta1.SecretStoreRef">SecretStoreRef
  8159. </h3>
  8160. <p>
  8161. (<em>Appears on:</em>
  8162. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>,
  8163. <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef</a>,
  8164. <a href="#external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef</a>)
  8165. </p>
  8166. <p>
  8167. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  8168. </p>
  8169. <table>
  8170. <thead>
  8171. <tr>
  8172. <th>Field</th>
  8173. <th>Description</th>
  8174. </tr>
  8175. </thead>
  8176. <tbody>
  8177. <tr>
  8178. <td>
  8179. <code>name</code></br>
  8180. <em>
  8181. string
  8182. </em>
  8183. </td>
  8184. <td>
  8185. <p>Name of the SecretStore resource</p>
  8186. </td>
  8187. </tr>
  8188. <tr>
  8189. <td>
  8190. <code>kind</code></br>
  8191. <em>
  8192. string
  8193. </em>
  8194. </td>
  8195. <td>
  8196. <em>(Optional)</em>
  8197. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  8198. Defaults to <code>SecretStore</code></p>
  8199. </td>
  8200. </tr>
  8201. </tbody>
  8202. </table>
  8203. <h3 id="external-secrets.io/v1beta1.SecretStoreRetrySettings">SecretStoreRetrySettings
  8204. </h3>
  8205. <p>
  8206. (<em>Appears on:</em>
  8207. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  8208. </p>
  8209. <p>
  8210. </p>
  8211. <table>
  8212. <thead>
  8213. <tr>
  8214. <th>Field</th>
  8215. <th>Description</th>
  8216. </tr>
  8217. </thead>
  8218. <tbody>
  8219. <tr>
  8220. <td>
  8221. <code>maxRetries</code></br>
  8222. <em>
  8223. int32
  8224. </em>
  8225. </td>
  8226. <td>
  8227. </td>
  8228. </tr>
  8229. <tr>
  8230. <td>
  8231. <code>retryInterval</code></br>
  8232. <em>
  8233. string
  8234. </em>
  8235. </td>
  8236. <td>
  8237. </td>
  8238. </tr>
  8239. </tbody>
  8240. </table>
  8241. <h3 id="external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec
  8242. </h3>
  8243. <p>
  8244. (<em>Appears on:</em>
  8245. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  8246. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  8247. </p>
  8248. <p>
  8249. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  8250. </p>
  8251. <table>
  8252. <thead>
  8253. <tr>
  8254. <th>Field</th>
  8255. <th>Description</th>
  8256. </tr>
  8257. </thead>
  8258. <tbody>
  8259. <tr>
  8260. <td>
  8261. <code>controller</code></br>
  8262. <em>
  8263. string
  8264. </em>
  8265. </td>
  8266. <td>
  8267. <em>(Optional)</em>
  8268. <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
  8269. The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
  8270. </td>
  8271. </tr>
  8272. <tr>
  8273. <td>
  8274. <code>provider</code></br>
  8275. <em>
  8276. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  8277. SecretStoreProvider
  8278. </a>
  8279. </em>
  8280. </td>
  8281. <td>
  8282. <p>Used to configure the provider. Only one provider may be set</p>
  8283. </td>
  8284. </tr>
  8285. <tr>
  8286. <td>
  8287. <code>retrySettings</code></br>
  8288. <em>
  8289. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  8290. SecretStoreRetrySettings
  8291. </a>
  8292. </em>
  8293. </td>
  8294. <td>
  8295. <em>(Optional)</em>
  8296. <p>Used to configure http retries if failed</p>
  8297. </td>
  8298. </tr>
  8299. <tr>
  8300. <td>
  8301. <code>refreshInterval</code></br>
  8302. <em>
  8303. int
  8304. </em>
  8305. </td>
  8306. <td>
  8307. <em>(Optional)</em>
  8308. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  8309. </td>
  8310. </tr>
  8311. <tr>
  8312. <td>
  8313. <code>conditions</code></br>
  8314. <em>
  8315. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  8316. []ClusterSecretStoreCondition
  8317. </a>
  8318. </em>
  8319. </td>
  8320. <td>
  8321. <em>(Optional)</em>
  8322. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  8323. </td>
  8324. </tr>
  8325. </tbody>
  8326. </table>
  8327. <h3 id="external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus
  8328. </h3>
  8329. <p>
  8330. (<em>Appears on:</em>
  8331. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  8332. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  8333. </p>
  8334. <p>
  8335. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  8336. </p>
  8337. <table>
  8338. <thead>
  8339. <tr>
  8340. <th>Field</th>
  8341. <th>Description</th>
  8342. </tr>
  8343. </thead>
  8344. <tbody>
  8345. <tr>
  8346. <td>
  8347. <code>conditions</code></br>
  8348. <em>
  8349. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">
  8350. []SecretStoreStatusCondition
  8351. </a>
  8352. </em>
  8353. </td>
  8354. <td>
  8355. <em>(Optional)</em>
  8356. </td>
  8357. </tr>
  8358. <tr>
  8359. <td>
  8360. <code>capabilities</code></br>
  8361. <em>
  8362. <a href="#external-secrets.io/v1beta1.SecretStoreCapabilities">
  8363. SecretStoreCapabilities
  8364. </a>
  8365. </em>
  8366. </td>
  8367. <td>
  8368. <em>(Optional)</em>
  8369. </td>
  8370. </tr>
  8371. </tbody>
  8372. </table>
  8373. <h3 id="external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition
  8374. </h3>
  8375. <p>
  8376. (<em>Appears on:</em>
  8377. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  8378. </p>
  8379. <p>
  8380. </p>
  8381. <table>
  8382. <thead>
  8383. <tr>
  8384. <th>Field</th>
  8385. <th>Description</th>
  8386. </tr>
  8387. </thead>
  8388. <tbody>
  8389. <tr>
  8390. <td>
  8391. <code>type</code></br>
  8392. <em>
  8393. <a href="#external-secrets.io/v1beta1.SecretStoreConditionType">
  8394. SecretStoreConditionType
  8395. </a>
  8396. </em>
  8397. </td>
  8398. <td>
  8399. </td>
  8400. </tr>
  8401. <tr>
  8402. <td>
  8403. <code>status</code></br>
  8404. <em>
  8405. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  8406. Kubernetes core/v1.ConditionStatus
  8407. </a>
  8408. </em>
  8409. </td>
  8410. <td>
  8411. </td>
  8412. </tr>
  8413. <tr>
  8414. <td>
  8415. <code>reason</code></br>
  8416. <em>
  8417. string
  8418. </em>
  8419. </td>
  8420. <td>
  8421. <em>(Optional)</em>
  8422. </td>
  8423. </tr>
  8424. <tr>
  8425. <td>
  8426. <code>message</code></br>
  8427. <em>
  8428. string
  8429. </em>
  8430. </td>
  8431. <td>
  8432. <em>(Optional)</em>
  8433. </td>
  8434. </tr>
  8435. <tr>
  8436. <td>
  8437. <code>lastTransitionTime</code></br>
  8438. <em>
  8439. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  8440. Kubernetes meta/v1.Time
  8441. </a>
  8442. </em>
  8443. </td>
  8444. <td>
  8445. <em>(Optional)</em>
  8446. </td>
  8447. </tr>
  8448. </tbody>
  8449. </table>
  8450. <h3 id="external-secrets.io/v1beta1.SecretsClient">SecretsClient
  8451. </h3>
  8452. <p>
  8453. <p>SecretsClient provides access to secrets.</p>
  8454. </p>
  8455. <h3 id="external-secrets.io/v1beta1.SecretsManager">SecretsManager
  8456. </h3>
  8457. <p>
  8458. (<em>Appears on:</em>
  8459. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  8460. </p>
  8461. <p>
  8462. <p>SecretsManager defines how the provider behaves when interacting with AWS
  8463. SecretsManager. Some of these settings are only applicable to controlling how
  8464. secrets are deleted, and hence only apply to PushSecret (and only when
  8465. deletionPolicy is set to Delete).</p>
  8466. </p>
  8467. <table>
  8468. <thead>
  8469. <tr>
  8470. <th>Field</th>
  8471. <th>Description</th>
  8472. </tr>
  8473. </thead>
  8474. <tbody>
  8475. <tr>
  8476. <td>
  8477. <code>forceDeleteWithoutRecovery</code></br>
  8478. <em>
  8479. bool
  8480. </em>
  8481. </td>
  8482. <td>
  8483. <em>(Optional)</em>
  8484. <p>Specifies whether to delete the secret without any recovery window. You
  8485. can&rsquo;t use both this parameter and RecoveryWindowInDays in the same call.
  8486. If you don&rsquo;t use either, then by default Secrets Manager uses a 30 day
  8487. recovery window.
  8488. see: <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-ForceDeleteWithoutRecovery">https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-ForceDeleteWithoutRecovery</a></p>
  8489. </td>
  8490. </tr>
  8491. <tr>
  8492. <td>
  8493. <code>recoveryWindowInDays</code></br>
  8494. <em>
  8495. int64
  8496. </em>
  8497. </td>
  8498. <td>
  8499. <em>(Optional)</em>
  8500. <p>The number of days from 7 to 30 that Secrets Manager waits before
  8501. permanently deleting the secret. You can&rsquo;t use both this parameter and
  8502. ForceDeleteWithoutRecovery in the same call. If you don&rsquo;t use either,
  8503. then by default Secrets Manager uses a 30 day recovery window.
  8504. see: <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-RecoveryWindowInDays">https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-RecoveryWindowInDays</a></p>
  8505. </td>
  8506. </tr>
  8507. </tbody>
  8508. </table>
  8509. <h3 id="external-secrets.io/v1beta1.SenhaseguraAuth">SenhaseguraAuth
  8510. </h3>
  8511. <p>
  8512. (<em>Appears on:</em>
  8513. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  8514. </p>
  8515. <p>
  8516. <p>SenhaseguraAuth tells the controller how to do auth in senhasegura.</p>
  8517. </p>
  8518. <table>
  8519. <thead>
  8520. <tr>
  8521. <th>Field</th>
  8522. <th>Description</th>
  8523. </tr>
  8524. </thead>
  8525. <tbody>
  8526. <tr>
  8527. <td>
  8528. <code>clientId</code></br>
  8529. <em>
  8530. string
  8531. </em>
  8532. </td>
  8533. <td>
  8534. </td>
  8535. </tr>
  8536. <tr>
  8537. <td>
  8538. <code>clientSecretSecretRef</code></br>
  8539. <em>
  8540. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8541. External Secrets meta/v1.SecretKeySelector
  8542. </a>
  8543. </em>
  8544. </td>
  8545. <td>
  8546. </td>
  8547. </tr>
  8548. </tbody>
  8549. </table>
  8550. <h3 id="external-secrets.io/v1beta1.SenhaseguraModuleType">SenhaseguraModuleType
  8551. (<code>string</code> alias)</p></h3>
  8552. <p>
  8553. (<em>Appears on:</em>
  8554. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  8555. </p>
  8556. <p>
  8557. <p>SenhaseguraModuleType enum defines senhasegura target module to fetch secrets</p>
  8558. </p>
  8559. <table>
  8560. <thead>
  8561. <tr>
  8562. <th>Value</th>
  8563. <th>Description</th>
  8564. </tr>
  8565. </thead>
  8566. <tbody><tr><td><p>&#34;DSM&#34;</p></td>
  8567. <td><pre><code> SenhaseguraModuleDSM is the senhasegura DevOps Secrets Management module
  8568. see: https://senhasegura.com/devops
  8569. </code></pre>
  8570. </td>
  8571. </tr></tbody>
  8572. </table>
  8573. <h3 id="external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider
  8574. </h3>
  8575. <p>
  8576. (<em>Appears on:</em>
  8577. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  8578. </p>
  8579. <p>
  8580. <p>SenhaseguraProvider setup a store to sync secrets with senhasegura.</p>
  8581. </p>
  8582. <table>
  8583. <thead>
  8584. <tr>
  8585. <th>Field</th>
  8586. <th>Description</th>
  8587. </tr>
  8588. </thead>
  8589. <tbody>
  8590. <tr>
  8591. <td>
  8592. <code>url</code></br>
  8593. <em>
  8594. string
  8595. </em>
  8596. </td>
  8597. <td>
  8598. <p>URL of senhasegura</p>
  8599. </td>
  8600. </tr>
  8601. <tr>
  8602. <td>
  8603. <code>module</code></br>
  8604. <em>
  8605. <a href="#external-secrets.io/v1beta1.SenhaseguraModuleType">
  8606. SenhaseguraModuleType
  8607. </a>
  8608. </em>
  8609. </td>
  8610. <td>
  8611. <p>Module defines which senhasegura module should be used to get secrets</p>
  8612. </td>
  8613. </tr>
  8614. <tr>
  8615. <td>
  8616. <code>auth</code></br>
  8617. <em>
  8618. <a href="#external-secrets.io/v1beta1.SenhaseguraAuth">
  8619. SenhaseguraAuth
  8620. </a>
  8621. </em>
  8622. </td>
  8623. <td>
  8624. <p>Auth defines parameters to authenticate in senhasegura</p>
  8625. </td>
  8626. </tr>
  8627. <tr>
  8628. <td>
  8629. <code>ignoreSslCertificate</code></br>
  8630. <em>
  8631. bool
  8632. </em>
  8633. </td>
  8634. <td>
  8635. <p>IgnoreSslCertificate defines if SSL certificate must be ignored</p>
  8636. </td>
  8637. </tr>
  8638. </tbody>
  8639. </table>
  8640. <h3 id="external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef
  8641. </h3>
  8642. <p>
  8643. (<em>Appears on:</em>
  8644. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  8645. </p>
  8646. <p>
  8647. <p>StoreGeneratorSourceRef allows you to override the source
  8648. from which the secret will be pulled from.
  8649. You can define at maximum one property.</p>
  8650. </p>
  8651. <table>
  8652. <thead>
  8653. <tr>
  8654. <th>Field</th>
  8655. <th>Description</th>
  8656. </tr>
  8657. </thead>
  8658. <tbody>
  8659. <tr>
  8660. <td>
  8661. <code>storeRef</code></br>
  8662. <em>
  8663. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  8664. SecretStoreRef
  8665. </a>
  8666. </em>
  8667. </td>
  8668. <td>
  8669. <em>(Optional)</em>
  8670. </td>
  8671. </tr>
  8672. <tr>
  8673. <td>
  8674. <code>generatorRef</code></br>
  8675. <em>
  8676. <a href="#external-secrets.io/v1beta1.GeneratorRef">
  8677. GeneratorRef
  8678. </a>
  8679. </em>
  8680. </td>
  8681. <td>
  8682. <em>(Optional)</em>
  8683. <p>GeneratorRef points to a generator custom resource.</p>
  8684. </td>
  8685. </tr>
  8686. </tbody>
  8687. </table>
  8688. <h3 id="external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef
  8689. </h3>
  8690. <p>
  8691. (<em>Appears on:</em>
  8692. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>)
  8693. </p>
  8694. <p>
  8695. <p>StoreSourceRef allows you to override the SecretStore source
  8696. from which the secret will be pulled from.
  8697. You can define at maximum one property.</p>
  8698. </p>
  8699. <table>
  8700. <thead>
  8701. <tr>
  8702. <th>Field</th>
  8703. <th>Description</th>
  8704. </tr>
  8705. </thead>
  8706. <tbody>
  8707. <tr>
  8708. <td>
  8709. <code>storeRef</code></br>
  8710. <em>
  8711. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  8712. SecretStoreRef
  8713. </a>
  8714. </em>
  8715. </td>
  8716. <td>
  8717. <em>(Optional)</em>
  8718. </td>
  8719. </tr>
  8720. <tr>
  8721. <td>
  8722. <code>generatorRef</code></br>
  8723. <em>
  8724. <a href="#external-secrets.io/v1beta1.GeneratorRef">
  8725. GeneratorRef
  8726. </a>
  8727. </em>
  8728. </td>
  8729. <td>
  8730. <p>GeneratorRef points to a generator custom resource.</p>
  8731. <p>Deprecated: The generatorRef is not implemented in .data[].
  8732. this will be removed with v1.</p>
  8733. </td>
  8734. </tr>
  8735. </tbody>
  8736. </table>
  8737. <h3 id="external-secrets.io/v1beta1.Tag">Tag
  8738. </h3>
  8739. <p>
  8740. </p>
  8741. <table>
  8742. <thead>
  8743. <tr>
  8744. <th>Field</th>
  8745. <th>Description</th>
  8746. </tr>
  8747. </thead>
  8748. <tbody>
  8749. <tr>
  8750. <td>
  8751. <code>key</code></br>
  8752. <em>
  8753. string
  8754. </em>
  8755. </td>
  8756. <td>
  8757. </td>
  8758. </tr>
  8759. <tr>
  8760. <td>
  8761. <code>value</code></br>
  8762. <em>
  8763. string
  8764. </em>
  8765. </td>
  8766. <td>
  8767. </td>
  8768. </tr>
  8769. </tbody>
  8770. </table>
  8771. <h3 id="external-secrets.io/v1beta1.TemplateEngineVersion">TemplateEngineVersion
  8772. (<code>string</code> alias)</p></h3>
  8773. <p>
  8774. (<em>Appears on:</em>
  8775. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  8776. </p>
  8777. <p>
  8778. </p>
  8779. <table>
  8780. <thead>
  8781. <tr>
  8782. <th>Value</th>
  8783. <th>Description</th>
  8784. </tr>
  8785. </thead>
  8786. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  8787. <td></td>
  8788. </tr><tr><td><p>&#34;v2&#34;</p></td>
  8789. <td></td>
  8790. </tr></tbody>
  8791. </table>
  8792. <h3 id="external-secrets.io/v1beta1.TemplateFrom">TemplateFrom
  8793. </h3>
  8794. <p>
  8795. (<em>Appears on:</em>
  8796. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  8797. </p>
  8798. <p>
  8799. </p>
  8800. <table>
  8801. <thead>
  8802. <tr>
  8803. <th>Field</th>
  8804. <th>Description</th>
  8805. </tr>
  8806. </thead>
  8807. <tbody>
  8808. <tr>
  8809. <td>
  8810. <code>configMap</code></br>
  8811. <em>
  8812. <a href="#external-secrets.io/v1beta1.TemplateRef">
  8813. TemplateRef
  8814. </a>
  8815. </em>
  8816. </td>
  8817. <td>
  8818. </td>
  8819. </tr>
  8820. <tr>
  8821. <td>
  8822. <code>secret</code></br>
  8823. <em>
  8824. <a href="#external-secrets.io/v1beta1.TemplateRef">
  8825. TemplateRef
  8826. </a>
  8827. </em>
  8828. </td>
  8829. <td>
  8830. </td>
  8831. </tr>
  8832. <tr>
  8833. <td>
  8834. <code>target</code></br>
  8835. <em>
  8836. <a href="#external-secrets.io/v1beta1.TemplateTarget">
  8837. TemplateTarget
  8838. </a>
  8839. </em>
  8840. </td>
  8841. <td>
  8842. <em>(Optional)</em>
  8843. </td>
  8844. </tr>
  8845. <tr>
  8846. <td>
  8847. <code>literal</code></br>
  8848. <em>
  8849. string
  8850. </em>
  8851. </td>
  8852. <td>
  8853. <em>(Optional)</em>
  8854. </td>
  8855. </tr>
  8856. </tbody>
  8857. </table>
  8858. <h3 id="external-secrets.io/v1beta1.TemplateMergePolicy">TemplateMergePolicy
  8859. (<code>string</code> alias)</p></h3>
  8860. <p>
  8861. (<em>Appears on:</em>
  8862. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  8863. </p>
  8864. <p>
  8865. </p>
  8866. <table>
  8867. <thead>
  8868. <tr>
  8869. <th>Value</th>
  8870. <th>Description</th>
  8871. </tr>
  8872. </thead>
  8873. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  8874. <td></td>
  8875. </tr><tr><td><p>&#34;Replace&#34;</p></td>
  8876. <td></td>
  8877. </tr></tbody>
  8878. </table>
  8879. <h3 id="external-secrets.io/v1beta1.TemplateRef">TemplateRef
  8880. </h3>
  8881. <p>
  8882. (<em>Appears on:</em>
  8883. <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
  8884. </p>
  8885. <p>
  8886. </p>
  8887. <table>
  8888. <thead>
  8889. <tr>
  8890. <th>Field</th>
  8891. <th>Description</th>
  8892. </tr>
  8893. </thead>
  8894. <tbody>
  8895. <tr>
  8896. <td>
  8897. <code>name</code></br>
  8898. <em>
  8899. string
  8900. </em>
  8901. </td>
  8902. <td>
  8903. </td>
  8904. </tr>
  8905. <tr>
  8906. <td>
  8907. <code>items</code></br>
  8908. <em>
  8909. <a href="#external-secrets.io/v1beta1.TemplateRefItem">
  8910. []TemplateRefItem
  8911. </a>
  8912. </em>
  8913. </td>
  8914. <td>
  8915. </td>
  8916. </tr>
  8917. </tbody>
  8918. </table>
  8919. <h3 id="external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem
  8920. </h3>
  8921. <p>
  8922. (<em>Appears on:</em>
  8923. <a href="#external-secrets.io/v1beta1.TemplateRef">TemplateRef</a>)
  8924. </p>
  8925. <p>
  8926. </p>
  8927. <table>
  8928. <thead>
  8929. <tr>
  8930. <th>Field</th>
  8931. <th>Description</th>
  8932. </tr>
  8933. </thead>
  8934. <tbody>
  8935. <tr>
  8936. <td>
  8937. <code>key</code></br>
  8938. <em>
  8939. string
  8940. </em>
  8941. </td>
  8942. <td>
  8943. </td>
  8944. </tr>
  8945. <tr>
  8946. <td>
  8947. <code>templateAs</code></br>
  8948. <em>
  8949. <a href="#external-secrets.io/v1beta1.TemplateScope">
  8950. TemplateScope
  8951. </a>
  8952. </em>
  8953. </td>
  8954. <td>
  8955. </td>
  8956. </tr>
  8957. </tbody>
  8958. </table>
  8959. <h3 id="external-secrets.io/v1beta1.TemplateScope">TemplateScope
  8960. (<code>string</code> alias)</p></h3>
  8961. <p>
  8962. (<em>Appears on:</em>
  8963. <a href="#external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem</a>)
  8964. </p>
  8965. <p>
  8966. </p>
  8967. <table>
  8968. <thead>
  8969. <tr>
  8970. <th>Value</th>
  8971. <th>Description</th>
  8972. </tr>
  8973. </thead>
  8974. <tbody><tr><td><p>&#34;KeysAndValues&#34;</p></td>
  8975. <td></td>
  8976. </tr><tr><td><p>&#34;Values&#34;</p></td>
  8977. <td></td>
  8978. </tr></tbody>
  8979. </table>
  8980. <h3 id="external-secrets.io/v1beta1.TemplateTarget">TemplateTarget
  8981. (<code>string</code> alias)</p></h3>
  8982. <p>
  8983. (<em>Appears on:</em>
  8984. <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
  8985. </p>
  8986. <p>
  8987. </p>
  8988. <table>
  8989. <thead>
  8990. <tr>
  8991. <th>Value</th>
  8992. <th>Description</th>
  8993. </tr>
  8994. </thead>
  8995. <tbody><tr><td><p>&#34;Annotations&#34;</p></td>
  8996. <td></td>
  8997. </tr><tr><td><p>&#34;Data&#34;</p></td>
  8998. <td></td>
  8999. </tr><tr><td><p>&#34;Labels&#34;</p></td>
  9000. <td></td>
  9001. </tr></tbody>
  9002. </table>
  9003. <h3 id="external-secrets.io/v1beta1.TokenAuth">TokenAuth
  9004. </h3>
  9005. <p>
  9006. (<em>Appears on:</em>
  9007. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  9008. </p>
  9009. <p>
  9010. </p>
  9011. <table>
  9012. <thead>
  9013. <tr>
  9014. <th>Field</th>
  9015. <th>Description</th>
  9016. </tr>
  9017. </thead>
  9018. <tbody>
  9019. <tr>
  9020. <td>
  9021. <code>bearerToken</code></br>
  9022. <em>
  9023. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9024. External Secrets meta/v1.SecretKeySelector
  9025. </a>
  9026. </em>
  9027. </td>
  9028. <td>
  9029. </td>
  9030. </tr>
  9031. </tbody>
  9032. </table>
  9033. <h3 id="external-secrets.io/v1beta1.UniversalAuthCredentials">UniversalAuthCredentials
  9034. </h3>
  9035. <p>
  9036. (<em>Appears on:</em>
  9037. <a href="#external-secrets.io/v1beta1.InfisicalAuth">InfisicalAuth</a>)
  9038. </p>
  9039. <p>
  9040. </p>
  9041. <table>
  9042. <thead>
  9043. <tr>
  9044. <th>Field</th>
  9045. <th>Description</th>
  9046. </tr>
  9047. </thead>
  9048. <tbody>
  9049. <tr>
  9050. <td>
  9051. <code>clientId</code></br>
  9052. <em>
  9053. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9054. External Secrets meta/v1.SecretKeySelector
  9055. </a>
  9056. </em>
  9057. </td>
  9058. <td>
  9059. </td>
  9060. </tr>
  9061. <tr>
  9062. <td>
  9063. <code>clientSecret</code></br>
  9064. <em>
  9065. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9066. External Secrets meta/v1.SecretKeySelector
  9067. </a>
  9068. </em>
  9069. </td>
  9070. <td>
  9071. </td>
  9072. </tr>
  9073. </tbody>
  9074. </table>
  9075. <h3 id="external-secrets.io/v1beta1.ValidationResult">ValidationResult
  9076. (<code>byte</code> alias)</p></h3>
  9077. <p>
  9078. </p>
  9079. <table>
  9080. <thead>
  9081. <tr>
  9082. <th>Value</th>
  9083. <th>Description</th>
  9084. </tr>
  9085. </thead>
  9086. <tbody><tr><td><p>2</p></td>
  9087. <td><p>Error indicates that there is a misconfiguration.</p>
  9088. </td>
  9089. </tr><tr><td><p>0</p></td>
  9090. <td><p>Ready indicates that the client is configured correctly
  9091. and can be used.</p>
  9092. </td>
  9093. </tr><tr><td><p>1</p></td>
  9094. <td><p>Unknown indicates that the client can be used
  9095. but information is missing and it can not be validated.</p>
  9096. </td>
  9097. </tr></tbody>
  9098. </table>
  9099. <h3 id="external-secrets.io/v1beta1.VaultAppRole">VaultAppRole
  9100. </h3>
  9101. <p>
  9102. (<em>Appears on:</em>
  9103. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  9104. </p>
  9105. <p>
  9106. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  9107. with the role and secret stored in a Kubernetes Secret resource.</p>
  9108. </p>
  9109. <table>
  9110. <thead>
  9111. <tr>
  9112. <th>Field</th>
  9113. <th>Description</th>
  9114. </tr>
  9115. </thead>
  9116. <tbody>
  9117. <tr>
  9118. <td>
  9119. <code>path</code></br>
  9120. <em>
  9121. string
  9122. </em>
  9123. </td>
  9124. <td>
  9125. <p>Path where the App Role authentication backend is mounted
  9126. in Vault, e.g: &ldquo;approle&rdquo;</p>
  9127. </td>
  9128. </tr>
  9129. <tr>
  9130. <td>
  9131. <code>roleId</code></br>
  9132. <em>
  9133. string
  9134. </em>
  9135. </td>
  9136. <td>
  9137. <em>(Optional)</em>
  9138. <p>RoleID configured in the App Role authentication backend when setting
  9139. up the authentication backend in Vault.</p>
  9140. </td>
  9141. </tr>
  9142. <tr>
  9143. <td>
  9144. <code>roleRef</code></br>
  9145. <em>
  9146. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9147. External Secrets meta/v1.SecretKeySelector
  9148. </a>
  9149. </em>
  9150. </td>
  9151. <td>
  9152. <em>(Optional)</em>
  9153. <p>Reference to a key in a Secret that contains the App Role ID used
  9154. to authenticate with Vault.
  9155. The <code>key</code> field must be specified and denotes which entry within the Secret
  9156. resource is used as the app role id.</p>
  9157. </td>
  9158. </tr>
  9159. <tr>
  9160. <td>
  9161. <code>secretRef</code></br>
  9162. <em>
  9163. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9164. External Secrets meta/v1.SecretKeySelector
  9165. </a>
  9166. </em>
  9167. </td>
  9168. <td>
  9169. <p>Reference to a key in a Secret that contains the App Role secret used
  9170. to authenticate with Vault.
  9171. The <code>key</code> field must be specified and denotes which entry within the Secret
  9172. resource is used as the app role secret.</p>
  9173. </td>
  9174. </tr>
  9175. </tbody>
  9176. </table>
  9177. <h3 id="external-secrets.io/v1beta1.VaultAuth">VaultAuth
  9178. </h3>
  9179. <p>
  9180. (<em>Appears on:</em>
  9181. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  9182. </p>
  9183. <p>
  9184. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  9185. Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>userPass</code>, <code>jwt</code> or <code>cert</code>
  9186. can be specified. A namespace to authenticate against can optionally be specified.</p>
  9187. </p>
  9188. <table>
  9189. <thead>
  9190. <tr>
  9191. <th>Field</th>
  9192. <th>Description</th>
  9193. </tr>
  9194. </thead>
  9195. <tbody>
  9196. <tr>
  9197. <td>
  9198. <code>namespace</code></br>
  9199. <em>
  9200. string
  9201. </em>
  9202. </td>
  9203. <td>
  9204. <em>(Optional)</em>
  9205. <p>Name of the vault namespace to authenticate to. This can be different than the namespace your secret is in.
  9206. Namespaces is a set of features within Vault Enterprise that allows
  9207. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  9208. More about namespaces can be found here <a href="https://www.vaultproject.io/docs/enterprise/namespaces">https://www.vaultproject.io/docs/enterprise/namespaces</a>
  9209. This will default to Vault.Namespace field if set, or empty otherwise</p>
  9210. </td>
  9211. </tr>
  9212. <tr>
  9213. <td>
  9214. <code>tokenSecretRef</code></br>
  9215. <em>
  9216. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9217. External Secrets meta/v1.SecretKeySelector
  9218. </a>
  9219. </em>
  9220. </td>
  9221. <td>
  9222. <em>(Optional)</em>
  9223. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  9224. </td>
  9225. </tr>
  9226. <tr>
  9227. <td>
  9228. <code>appRole</code></br>
  9229. <em>
  9230. <a href="#external-secrets.io/v1beta1.VaultAppRole">
  9231. VaultAppRole
  9232. </a>
  9233. </em>
  9234. </td>
  9235. <td>
  9236. <em>(Optional)</em>
  9237. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  9238. with the role and secret stored in a Kubernetes Secret resource.</p>
  9239. </td>
  9240. </tr>
  9241. <tr>
  9242. <td>
  9243. <code>kubernetes</code></br>
  9244. <em>
  9245. <a href="#external-secrets.io/v1beta1.VaultKubernetesAuth">
  9246. VaultKubernetesAuth
  9247. </a>
  9248. </em>
  9249. </td>
  9250. <td>
  9251. <em>(Optional)</em>
  9252. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  9253. token stored in the named Secret resource to the Vault server.</p>
  9254. </td>
  9255. </tr>
  9256. <tr>
  9257. <td>
  9258. <code>ldap</code></br>
  9259. <em>
  9260. <a href="#external-secrets.io/v1beta1.VaultLdapAuth">
  9261. VaultLdapAuth
  9262. </a>
  9263. </em>
  9264. </td>
  9265. <td>
  9266. <em>(Optional)</em>
  9267. <p>Ldap authenticates with Vault by passing username/password pair using
  9268. the LDAP authentication method</p>
  9269. </td>
  9270. </tr>
  9271. <tr>
  9272. <td>
  9273. <code>jwt</code></br>
  9274. <em>
  9275. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">
  9276. VaultJwtAuth
  9277. </a>
  9278. </em>
  9279. </td>
  9280. <td>
  9281. <em>(Optional)</em>
  9282. <p>Jwt authenticates with Vault by passing role and JWT token using the
  9283. JWT/OIDC authentication method</p>
  9284. </td>
  9285. </tr>
  9286. <tr>
  9287. <td>
  9288. <code>cert</code></br>
  9289. <em>
  9290. <a href="#external-secrets.io/v1beta1.VaultCertAuth">
  9291. VaultCertAuth
  9292. </a>
  9293. </em>
  9294. </td>
  9295. <td>
  9296. <em>(Optional)</em>
  9297. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  9298. Cert authentication method</p>
  9299. </td>
  9300. </tr>
  9301. <tr>
  9302. <td>
  9303. <code>iam</code></br>
  9304. <em>
  9305. <a href="#external-secrets.io/v1beta1.VaultIamAuth">
  9306. VaultIamAuth
  9307. </a>
  9308. </em>
  9309. </td>
  9310. <td>
  9311. <em>(Optional)</em>
  9312. <p>Iam authenticates with vault by passing a special AWS request signed with AWS IAM credentials
  9313. AWS IAM authentication method</p>
  9314. </td>
  9315. </tr>
  9316. <tr>
  9317. <td>
  9318. <code>userPass</code></br>
  9319. <em>
  9320. <a href="#external-secrets.io/v1beta1.VaultUserPassAuth">
  9321. VaultUserPassAuth
  9322. </a>
  9323. </em>
  9324. </td>
  9325. <td>
  9326. <em>(Optional)</em>
  9327. <p>UserPass authenticates with Vault by passing username/password pair</p>
  9328. </td>
  9329. </tr>
  9330. </tbody>
  9331. </table>
  9332. <h3 id="external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth
  9333. </h3>
  9334. <p>
  9335. <p>VaultAwsAuth tells the controller how to do authentication with aws.
  9336. Only one of secretRef or jwt can be specified.
  9337. if none is specified the controller will try to load credentials from its own service account assuming it is IRSA enabled.</p>
  9338. </p>
  9339. <table>
  9340. <thead>
  9341. <tr>
  9342. <th>Field</th>
  9343. <th>Description</th>
  9344. </tr>
  9345. </thead>
  9346. <tbody>
  9347. <tr>
  9348. <td>
  9349. <code>secretRef</code></br>
  9350. <em>
  9351. <a href="#external-secrets.io/v1beta1.VaultAwsAuthSecretRef">
  9352. VaultAwsAuthSecretRef
  9353. </a>
  9354. </em>
  9355. </td>
  9356. <td>
  9357. <em>(Optional)</em>
  9358. </td>
  9359. </tr>
  9360. <tr>
  9361. <td>
  9362. <code>jwt</code></br>
  9363. <em>
  9364. <a href="#external-secrets.io/v1beta1.VaultAwsJWTAuth">
  9365. VaultAwsJWTAuth
  9366. </a>
  9367. </em>
  9368. </td>
  9369. <td>
  9370. <em>(Optional)</em>
  9371. </td>
  9372. </tr>
  9373. </tbody>
  9374. </table>
  9375. <h3 id="external-secrets.io/v1beta1.VaultAwsAuthSecretRef">VaultAwsAuthSecretRef
  9376. </h3>
  9377. <p>
  9378. (<em>Appears on:</em>
  9379. <a href="#external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth</a>,
  9380. <a href="#external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth</a>)
  9381. </p>
  9382. <p>
  9383. <p>VaultAWSAuthSecretRef holds secret references for AWS credentials
  9384. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  9385. </p>
  9386. <table>
  9387. <thead>
  9388. <tr>
  9389. <th>Field</th>
  9390. <th>Description</th>
  9391. </tr>
  9392. </thead>
  9393. <tbody>
  9394. <tr>
  9395. <td>
  9396. <code>accessKeyIDSecretRef</code></br>
  9397. <em>
  9398. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9399. External Secrets meta/v1.SecretKeySelector
  9400. </a>
  9401. </em>
  9402. </td>
  9403. <td>
  9404. <p>The AccessKeyID is used for authentication</p>
  9405. </td>
  9406. </tr>
  9407. <tr>
  9408. <td>
  9409. <code>secretAccessKeySecretRef</code></br>
  9410. <em>
  9411. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9412. External Secrets meta/v1.SecretKeySelector
  9413. </a>
  9414. </em>
  9415. </td>
  9416. <td>
  9417. <p>The SecretAccessKey is used for authentication</p>
  9418. </td>
  9419. </tr>
  9420. <tr>
  9421. <td>
  9422. <code>sessionTokenSecretRef</code></br>
  9423. <em>
  9424. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9425. External Secrets meta/v1.SecretKeySelector
  9426. </a>
  9427. </em>
  9428. </td>
  9429. <td>
  9430. <p>The SessionToken used for authentication
  9431. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  9432. 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>
  9433. </td>
  9434. </tr>
  9435. </tbody>
  9436. </table>
  9437. <h3 id="external-secrets.io/v1beta1.VaultAwsJWTAuth">VaultAwsJWTAuth
  9438. </h3>
  9439. <p>
  9440. (<em>Appears on:</em>
  9441. <a href="#external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth</a>,
  9442. <a href="#external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth</a>)
  9443. </p>
  9444. <p>
  9445. <p>Authenticate against AWS using service account tokens.</p>
  9446. </p>
  9447. <table>
  9448. <thead>
  9449. <tr>
  9450. <th>Field</th>
  9451. <th>Description</th>
  9452. </tr>
  9453. </thead>
  9454. <tbody>
  9455. <tr>
  9456. <td>
  9457. <code>serviceAccountRef</code></br>
  9458. <em>
  9459. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  9460. External Secrets meta/v1.ServiceAccountSelector
  9461. </a>
  9462. </em>
  9463. </td>
  9464. <td>
  9465. </td>
  9466. </tr>
  9467. </tbody>
  9468. </table>
  9469. <h3 id="external-secrets.io/v1beta1.VaultCertAuth">VaultCertAuth
  9470. </h3>
  9471. <p>
  9472. (<em>Appears on:</em>
  9473. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  9474. </p>
  9475. <p>
  9476. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  9477. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  9478. </p>
  9479. <table>
  9480. <thead>
  9481. <tr>
  9482. <th>Field</th>
  9483. <th>Description</th>
  9484. </tr>
  9485. </thead>
  9486. <tbody>
  9487. <tr>
  9488. <td>
  9489. <code>clientCert</code></br>
  9490. <em>
  9491. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9492. External Secrets meta/v1.SecretKeySelector
  9493. </a>
  9494. </em>
  9495. </td>
  9496. <td>
  9497. <em>(Optional)</em>
  9498. <p>ClientCert is a certificate to authenticate using the Cert Vault
  9499. authentication method</p>
  9500. </td>
  9501. </tr>
  9502. <tr>
  9503. <td>
  9504. <code>secretRef</code></br>
  9505. <em>
  9506. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9507. External Secrets meta/v1.SecretKeySelector
  9508. </a>
  9509. </em>
  9510. </td>
  9511. <td>
  9512. <p>SecretRef to a key in a Secret resource containing client private key to
  9513. authenticate with Vault using the Cert authentication method</p>
  9514. </td>
  9515. </tr>
  9516. </tbody>
  9517. </table>
  9518. <h3 id="external-secrets.io/v1beta1.VaultClientTLS">VaultClientTLS
  9519. </h3>
  9520. <p>
  9521. (<em>Appears on:</em>
  9522. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  9523. </p>
  9524. <p>
  9525. <p>VaultClientTLS is the configuration used for client side related TLS communication,
  9526. when the Vault server requires mutual authentication.</p>
  9527. </p>
  9528. <table>
  9529. <thead>
  9530. <tr>
  9531. <th>Field</th>
  9532. <th>Description</th>
  9533. </tr>
  9534. </thead>
  9535. <tbody>
  9536. <tr>
  9537. <td>
  9538. <code>certSecretRef</code></br>
  9539. <em>
  9540. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9541. External Secrets meta/v1.SecretKeySelector
  9542. </a>
  9543. </em>
  9544. </td>
  9545. <td>
  9546. <p>CertSecretRef is a certificate added to the transport layer
  9547. when communicating with the Vault server.
  9548. If no key for the Secret is specified, external-secret will default to &lsquo;tls.crt&rsquo;.</p>
  9549. </td>
  9550. </tr>
  9551. <tr>
  9552. <td>
  9553. <code>keySecretRef</code></br>
  9554. <em>
  9555. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9556. External Secrets meta/v1.SecretKeySelector
  9557. </a>
  9558. </em>
  9559. </td>
  9560. <td>
  9561. <p>KeySecretRef to a key in a Secret resource containing client private key
  9562. added to the transport layer when communicating with the Vault server.
  9563. If no key for the Secret is specified, external-secret will default to &lsquo;tls.key&rsquo;.</p>
  9564. </td>
  9565. </tr>
  9566. </tbody>
  9567. </table>
  9568. <h3 id="external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth
  9569. </h3>
  9570. <p>
  9571. (<em>Appears on:</em>
  9572. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  9573. </p>
  9574. <p>
  9575. <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>
  9576. </p>
  9577. <table>
  9578. <thead>
  9579. <tr>
  9580. <th>Field</th>
  9581. <th>Description</th>
  9582. </tr>
  9583. </thead>
  9584. <tbody>
  9585. <tr>
  9586. <td>
  9587. <code>path</code></br>
  9588. <em>
  9589. string
  9590. </em>
  9591. </td>
  9592. <td>
  9593. <p>Path where the AWS auth method is enabled in Vault, e.g: &ldquo;aws&rdquo;</p>
  9594. </td>
  9595. </tr>
  9596. <tr>
  9597. <td>
  9598. <code>region</code></br>
  9599. <em>
  9600. string
  9601. </em>
  9602. </td>
  9603. <td>
  9604. <p>AWS region</p>
  9605. </td>
  9606. </tr>
  9607. <tr>
  9608. <td>
  9609. <code>role</code></br>
  9610. <em>
  9611. string
  9612. </em>
  9613. </td>
  9614. <td>
  9615. <p>This is the AWS role to be assumed before talking to vault</p>
  9616. </td>
  9617. </tr>
  9618. <tr>
  9619. <td>
  9620. <code>vaultRole</code></br>
  9621. <em>
  9622. string
  9623. </em>
  9624. </td>
  9625. <td>
  9626. <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>
  9627. </td>
  9628. </tr>
  9629. <tr>
  9630. <td>
  9631. <code>externalID</code></br>
  9632. <em>
  9633. string
  9634. </em>
  9635. </td>
  9636. <td>
  9637. <p>AWS External ID set on assumed IAM roles</p>
  9638. </td>
  9639. </tr>
  9640. <tr>
  9641. <td>
  9642. <code>vaultAwsIamServerID</code></br>
  9643. <em>
  9644. string
  9645. </em>
  9646. </td>
  9647. <td>
  9648. <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>
  9649. </td>
  9650. </tr>
  9651. <tr>
  9652. <td>
  9653. <code>secretRef</code></br>
  9654. <em>
  9655. <a href="#external-secrets.io/v1beta1.VaultAwsAuthSecretRef">
  9656. VaultAwsAuthSecretRef
  9657. </a>
  9658. </em>
  9659. </td>
  9660. <td>
  9661. <em>(Optional)</em>
  9662. <p>Specify credentials in a Secret object</p>
  9663. </td>
  9664. </tr>
  9665. <tr>
  9666. <td>
  9667. <code>jwt</code></br>
  9668. <em>
  9669. <a href="#external-secrets.io/v1beta1.VaultAwsJWTAuth">
  9670. VaultAwsJWTAuth
  9671. </a>
  9672. </em>
  9673. </td>
  9674. <td>
  9675. <em>(Optional)</em>
  9676. <p>Specify a service account with IRSA enabled</p>
  9677. </td>
  9678. </tr>
  9679. </tbody>
  9680. </table>
  9681. <h3 id="external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth
  9682. </h3>
  9683. <p>
  9684. (<em>Appears on:</em>
  9685. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  9686. </p>
  9687. <p>
  9688. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  9689. method, with the role name and a token stored in a Kubernetes Secret resource or
  9690. a Kubernetes service account token retrieved via <code>TokenRequest</code>.</p>
  9691. </p>
  9692. <table>
  9693. <thead>
  9694. <tr>
  9695. <th>Field</th>
  9696. <th>Description</th>
  9697. </tr>
  9698. </thead>
  9699. <tbody>
  9700. <tr>
  9701. <td>
  9702. <code>path</code></br>
  9703. <em>
  9704. string
  9705. </em>
  9706. </td>
  9707. <td>
  9708. <p>Path where the JWT authentication backend is mounted
  9709. in Vault, e.g: &ldquo;jwt&rdquo;</p>
  9710. </td>
  9711. </tr>
  9712. <tr>
  9713. <td>
  9714. <code>role</code></br>
  9715. <em>
  9716. string
  9717. </em>
  9718. </td>
  9719. <td>
  9720. <em>(Optional)</em>
  9721. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  9722. authentication method</p>
  9723. </td>
  9724. </tr>
  9725. <tr>
  9726. <td>
  9727. <code>secretRef</code></br>
  9728. <em>
  9729. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9730. External Secrets meta/v1.SecretKeySelector
  9731. </a>
  9732. </em>
  9733. </td>
  9734. <td>
  9735. <em>(Optional)</em>
  9736. <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  9737. authenticate with Vault using the JWT/OIDC authentication method.</p>
  9738. </td>
  9739. </tr>
  9740. <tr>
  9741. <td>
  9742. <code>kubernetesServiceAccountToken</code></br>
  9743. <em>
  9744. <a href="#external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">
  9745. VaultKubernetesServiceAccountTokenAuth
  9746. </a>
  9747. </em>
  9748. </td>
  9749. <td>
  9750. <em>(Optional)</em>
  9751. <p>Optional ServiceAccountToken specifies the Kubernetes service account for which to request
  9752. a token for with the <code>TokenRequest</code> API.</p>
  9753. </td>
  9754. </tr>
  9755. </tbody>
  9756. </table>
  9757. <h3 id="external-secrets.io/v1beta1.VaultKVStoreVersion">VaultKVStoreVersion
  9758. (<code>string</code> alias)</p></h3>
  9759. <p>
  9760. (<em>Appears on:</em>
  9761. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  9762. </p>
  9763. <p>
  9764. </p>
  9765. <table>
  9766. <thead>
  9767. <tr>
  9768. <th>Value</th>
  9769. <th>Description</th>
  9770. </tr>
  9771. </thead>
  9772. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  9773. <td></td>
  9774. </tr><tr><td><p>&#34;v2&#34;</p></td>
  9775. <td></td>
  9776. </tr></tbody>
  9777. </table>
  9778. <h3 id="external-secrets.io/v1beta1.VaultKubernetesAuth">VaultKubernetesAuth
  9779. </h3>
  9780. <p>
  9781. (<em>Appears on:</em>
  9782. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  9783. </p>
  9784. <p>
  9785. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  9786. a Secret.</p>
  9787. </p>
  9788. <table>
  9789. <thead>
  9790. <tr>
  9791. <th>Field</th>
  9792. <th>Description</th>
  9793. </tr>
  9794. </thead>
  9795. <tbody>
  9796. <tr>
  9797. <td>
  9798. <code>mountPath</code></br>
  9799. <em>
  9800. string
  9801. </em>
  9802. </td>
  9803. <td>
  9804. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  9805. &ldquo;kubernetes&rdquo;</p>
  9806. </td>
  9807. </tr>
  9808. <tr>
  9809. <td>
  9810. <code>serviceAccountRef</code></br>
  9811. <em>
  9812. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  9813. External Secrets meta/v1.ServiceAccountSelector
  9814. </a>
  9815. </em>
  9816. </td>
  9817. <td>
  9818. <em>(Optional)</em>
  9819. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  9820. If the service account is specified, the service account secret token JWT will be used
  9821. for authenticating with Vault. If the service account selector is not supplied,
  9822. the secretRef will be used instead.</p>
  9823. </td>
  9824. </tr>
  9825. <tr>
  9826. <td>
  9827. <code>secretRef</code></br>
  9828. <em>
  9829. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9830. External Secrets meta/v1.SecretKeySelector
  9831. </a>
  9832. </em>
  9833. </td>
  9834. <td>
  9835. <em>(Optional)</em>
  9836. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  9837. for authenticating with Vault. If a name is specified without a key,
  9838. <code>token</code> is the default. If one is not specified, the one bound to
  9839. the controller will be used.</p>
  9840. </td>
  9841. </tr>
  9842. <tr>
  9843. <td>
  9844. <code>role</code></br>
  9845. <em>
  9846. string
  9847. </em>
  9848. </td>
  9849. <td>
  9850. <p>A required field containing the Vault Role to assume. A Role binds a
  9851. Kubernetes ServiceAccount with a set of Vault policies.</p>
  9852. </td>
  9853. </tr>
  9854. </tbody>
  9855. </table>
  9856. <h3 id="external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">VaultKubernetesServiceAccountTokenAuth
  9857. </h3>
  9858. <p>
  9859. (<em>Appears on:</em>
  9860. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth</a>)
  9861. </p>
  9862. <p>
  9863. <p>VaultKubernetesServiceAccountTokenAuth authenticates with Vault using a temporary
  9864. Kubernetes service account token retrieved by the <code>TokenRequest</code> API.</p>
  9865. </p>
  9866. <table>
  9867. <thead>
  9868. <tr>
  9869. <th>Field</th>
  9870. <th>Description</th>
  9871. </tr>
  9872. </thead>
  9873. <tbody>
  9874. <tr>
  9875. <td>
  9876. <code>serviceAccountRef</code></br>
  9877. <em>
  9878. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  9879. External Secrets meta/v1.ServiceAccountSelector
  9880. </a>
  9881. </em>
  9882. </td>
  9883. <td>
  9884. <p>Service account field containing the name of a kubernetes ServiceAccount.</p>
  9885. </td>
  9886. </tr>
  9887. <tr>
  9888. <td>
  9889. <code>audiences</code></br>
  9890. <em>
  9891. []string
  9892. </em>
  9893. </td>
  9894. <td>
  9895. <em>(Optional)</em>
  9896. <p>Optional audiences field that will be used to request a temporary Kubernetes service
  9897. account token for the service account referenced by <code>serviceAccountRef</code>.
  9898. Defaults to a single audience <code>vault</code> it not specified.
  9899. Deprecated: use serviceAccountRef.Audiences instead</p>
  9900. </td>
  9901. </tr>
  9902. <tr>
  9903. <td>
  9904. <code>expirationSeconds</code></br>
  9905. <em>
  9906. int64
  9907. </em>
  9908. </td>
  9909. <td>
  9910. <em>(Optional)</em>
  9911. <p>Optional expiration time in seconds that will be used to request a temporary
  9912. Kubernetes service account token for the service account referenced by
  9913. <code>serviceAccountRef</code>.
  9914. Deprecated: this will be removed in the future.
  9915. Defaults to 10 minutes.</p>
  9916. </td>
  9917. </tr>
  9918. </tbody>
  9919. </table>
  9920. <h3 id="external-secrets.io/v1beta1.VaultLdapAuth">VaultLdapAuth
  9921. </h3>
  9922. <p>
  9923. (<em>Appears on:</em>
  9924. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  9925. </p>
  9926. <p>
  9927. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  9928. with the username and password stored in a Kubernetes Secret resource.</p>
  9929. </p>
  9930. <table>
  9931. <thead>
  9932. <tr>
  9933. <th>Field</th>
  9934. <th>Description</th>
  9935. </tr>
  9936. </thead>
  9937. <tbody>
  9938. <tr>
  9939. <td>
  9940. <code>path</code></br>
  9941. <em>
  9942. string
  9943. </em>
  9944. </td>
  9945. <td>
  9946. <p>Path where the LDAP authentication backend is mounted
  9947. in Vault, e.g: &ldquo;ldap&rdquo;</p>
  9948. </td>
  9949. </tr>
  9950. <tr>
  9951. <td>
  9952. <code>username</code></br>
  9953. <em>
  9954. string
  9955. </em>
  9956. </td>
  9957. <td>
  9958. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  9959. authentication method</p>
  9960. </td>
  9961. </tr>
  9962. <tr>
  9963. <td>
  9964. <code>secretRef</code></br>
  9965. <em>
  9966. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  9967. External Secrets meta/v1.SecretKeySelector
  9968. </a>
  9969. </em>
  9970. </td>
  9971. <td>
  9972. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  9973. user used to authenticate with Vault using the LDAP authentication
  9974. method</p>
  9975. </td>
  9976. </tr>
  9977. </tbody>
  9978. </table>
  9979. <h3 id="external-secrets.io/v1beta1.VaultProvider">VaultProvider
  9980. </h3>
  9981. <p>
  9982. (<em>Appears on:</em>
  9983. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  9984. </p>
  9985. <p>
  9986. <p>Configures an store to sync secrets using a HashiCorp Vault
  9987. KV backend.</p>
  9988. </p>
  9989. <table>
  9990. <thead>
  9991. <tr>
  9992. <th>Field</th>
  9993. <th>Description</th>
  9994. </tr>
  9995. </thead>
  9996. <tbody>
  9997. <tr>
  9998. <td>
  9999. <code>auth</code></br>
  10000. <em>
  10001. <a href="#external-secrets.io/v1beta1.VaultAuth">
  10002. VaultAuth
  10003. </a>
  10004. </em>
  10005. </td>
  10006. <td>
  10007. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  10008. </td>
  10009. </tr>
  10010. <tr>
  10011. <td>
  10012. <code>server</code></br>
  10013. <em>
  10014. string
  10015. </em>
  10016. </td>
  10017. <td>
  10018. <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>
  10019. </td>
  10020. </tr>
  10021. <tr>
  10022. <td>
  10023. <code>path</code></br>
  10024. <em>
  10025. string
  10026. </em>
  10027. </td>
  10028. <td>
  10029. <em>(Optional)</em>
  10030. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  10031. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  10032. for fetching secrets from Vault is optional and will be appended
  10033. if not present in specified path.</p>
  10034. </td>
  10035. </tr>
  10036. <tr>
  10037. <td>
  10038. <code>version</code></br>
  10039. <em>
  10040. <a href="#external-secrets.io/v1beta1.VaultKVStoreVersion">
  10041. VaultKVStoreVersion
  10042. </a>
  10043. </em>
  10044. </td>
  10045. <td>
  10046. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  10047. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  10048. </td>
  10049. </tr>
  10050. <tr>
  10051. <td>
  10052. <code>namespace</code></br>
  10053. <em>
  10054. string
  10055. </em>
  10056. </td>
  10057. <td>
  10058. <em>(Optional)</em>
  10059. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  10060. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  10061. 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>
  10062. </td>
  10063. </tr>
  10064. <tr>
  10065. <td>
  10066. <code>caBundle</code></br>
  10067. <em>
  10068. []byte
  10069. </em>
  10070. </td>
  10071. <td>
  10072. <em>(Optional)</em>
  10073. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  10074. if the Server URL is using HTTPS protocol. This parameter is ignored for
  10075. plain HTTP protocol connection. If not set the system root certificates
  10076. are used to validate the TLS connection.</p>
  10077. </td>
  10078. </tr>
  10079. <tr>
  10080. <td>
  10081. <code>tls</code></br>
  10082. <em>
  10083. <a href="#external-secrets.io/v1beta1.VaultClientTLS">
  10084. VaultClientTLS
  10085. </a>
  10086. </em>
  10087. </td>
  10088. <td>
  10089. <em>(Optional)</em>
  10090. <p>The configuration used for client side related TLS communication, when the Vault server
  10091. requires mutual authentication. Only used if the Server URL is using HTTPS protocol.
  10092. This parameter is ignored for plain HTTP protocol connection.
  10093. It&rsquo;s worth noting this configuration is different from the &ldquo;TLS certificates auth method&rdquo;,
  10094. which is available under the <code>auth.cert</code> section.</p>
  10095. </td>
  10096. </tr>
  10097. <tr>
  10098. <td>
  10099. <code>caProvider</code></br>
  10100. <em>
  10101. <a href="#external-secrets.io/v1beta1.CAProvider">
  10102. CAProvider
  10103. </a>
  10104. </em>
  10105. </td>
  10106. <td>
  10107. <em>(Optional)</em>
  10108. <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
  10109. </td>
  10110. </tr>
  10111. <tr>
  10112. <td>
  10113. <code>readYourWrites</code></br>
  10114. <em>
  10115. bool
  10116. </em>
  10117. </td>
  10118. <td>
  10119. <em>(Optional)</em>
  10120. <p>ReadYourWrites ensures isolated read-after-write semantics by
  10121. providing discovered cluster replication states in each request.
  10122. More information about eventual consistency in Vault can be found here
  10123. <a href="https://www.vaultproject.io/docs/enterprise/consistency">https://www.vaultproject.io/docs/enterprise/consistency</a></p>
  10124. </td>
  10125. </tr>
  10126. <tr>
  10127. <td>
  10128. <code>forwardInconsistent</code></br>
  10129. <em>
  10130. bool
  10131. </em>
  10132. </td>
  10133. <td>
  10134. <em>(Optional)</em>
  10135. <p>ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
  10136. leader instead of simply retrying within a loop. This can increase performance if
  10137. the option is enabled serverside.
  10138. <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>
  10139. </td>
  10140. </tr>
  10141. <tr>
  10142. <td>
  10143. <code>headers</code></br>
  10144. <em>
  10145. map[string]string
  10146. </em>
  10147. </td>
  10148. <td>
  10149. <em>(Optional)</em>
  10150. <p>Headers to be added in Vault request</p>
  10151. </td>
  10152. </tr>
  10153. </tbody>
  10154. </table>
  10155. <h3 id="external-secrets.io/v1beta1.VaultUserPassAuth">VaultUserPassAuth
  10156. </h3>
  10157. <p>
  10158. (<em>Appears on:</em>
  10159. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  10160. </p>
  10161. <p>
  10162. <p>VaultUserPassAuth authenticates with Vault using UserPass authentication method,
  10163. with the username and password stored in a Kubernetes Secret resource.</p>
  10164. </p>
  10165. <table>
  10166. <thead>
  10167. <tr>
  10168. <th>Field</th>
  10169. <th>Description</th>
  10170. </tr>
  10171. </thead>
  10172. <tbody>
  10173. <tr>
  10174. <td>
  10175. <code>path</code></br>
  10176. <em>
  10177. string
  10178. </em>
  10179. </td>
  10180. <td>
  10181. <p>Path where the UserPassword authentication backend is mounted
  10182. in Vault, e.g: &ldquo;user&rdquo;</p>
  10183. </td>
  10184. </tr>
  10185. <tr>
  10186. <td>
  10187. <code>username</code></br>
  10188. <em>
  10189. string
  10190. </em>
  10191. </td>
  10192. <td>
  10193. <p>Username is a user name used to authenticate using the UserPass Vault
  10194. authentication method</p>
  10195. </td>
  10196. </tr>
  10197. <tr>
  10198. <td>
  10199. <code>secretRef</code></br>
  10200. <em>
  10201. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  10202. External Secrets meta/v1.SecretKeySelector
  10203. </a>
  10204. </em>
  10205. </td>
  10206. <td>
  10207. <p>SecretRef to a key in a Secret resource containing password for the
  10208. user used to authenticate with Vault using the UserPass authentication
  10209. method</p>
  10210. </td>
  10211. </tr>
  10212. </tbody>
  10213. </table>
  10214. <h3 id="external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider
  10215. </h3>
  10216. <p>
  10217. (<em>Appears on:</em>
  10218. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  10219. </p>
  10220. <p>
  10221. <p>Defines a location to fetch the cert for the webhook provider from.</p>
  10222. </p>
  10223. <table>
  10224. <thead>
  10225. <tr>
  10226. <th>Field</th>
  10227. <th>Description</th>
  10228. </tr>
  10229. </thead>
  10230. <tbody>
  10231. <tr>
  10232. <td>
  10233. <code>type</code></br>
  10234. <em>
  10235. <a href="#external-secrets.io/v1beta1.WebhookCAProviderType">
  10236. WebhookCAProviderType
  10237. </a>
  10238. </em>
  10239. </td>
  10240. <td>
  10241. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  10242. </td>
  10243. </tr>
  10244. <tr>
  10245. <td>
  10246. <code>name</code></br>
  10247. <em>
  10248. string
  10249. </em>
  10250. </td>
  10251. <td>
  10252. <p>The name of the object located at the provider type.</p>
  10253. </td>
  10254. </tr>
  10255. <tr>
  10256. <td>
  10257. <code>key</code></br>
  10258. <em>
  10259. string
  10260. </em>
  10261. </td>
  10262. <td>
  10263. <p>The key the value inside of the provider type to use, only used with &ldquo;Secret&rdquo; type</p>
  10264. </td>
  10265. </tr>
  10266. <tr>
  10267. <td>
  10268. <code>namespace</code></br>
  10269. <em>
  10270. string
  10271. </em>
  10272. </td>
  10273. <td>
  10274. <em>(Optional)</em>
  10275. <p>The namespace the Provider type is in.</p>
  10276. </td>
  10277. </tr>
  10278. </tbody>
  10279. </table>
  10280. <h3 id="external-secrets.io/v1beta1.WebhookCAProviderType">WebhookCAProviderType
  10281. (<code>string</code> alias)</p></h3>
  10282. <p>
  10283. (<em>Appears on:</em>
  10284. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider</a>)
  10285. </p>
  10286. <p>
  10287. </p>
  10288. <table>
  10289. <thead>
  10290. <tr>
  10291. <th>Value</th>
  10292. <th>Description</th>
  10293. </tr>
  10294. </thead>
  10295. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  10296. <td></td>
  10297. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  10298. <td></td>
  10299. </tr></tbody>
  10300. </table>
  10301. <h3 id="external-secrets.io/v1beta1.WebhookProvider">WebhookProvider
  10302. </h3>
  10303. <p>
  10304. (<em>Appears on:</em>
  10305. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  10306. </p>
  10307. <p>
  10308. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  10309. </p>
  10310. <table>
  10311. <thead>
  10312. <tr>
  10313. <th>Field</th>
  10314. <th>Description</th>
  10315. </tr>
  10316. </thead>
  10317. <tbody>
  10318. <tr>
  10319. <td>
  10320. <code>method</code></br>
  10321. <em>
  10322. string
  10323. </em>
  10324. </td>
  10325. <td>
  10326. <p>Webhook Method</p>
  10327. </td>
  10328. </tr>
  10329. <tr>
  10330. <td>
  10331. <code>url</code></br>
  10332. <em>
  10333. string
  10334. </em>
  10335. </td>
  10336. <td>
  10337. <p>Webhook url to call</p>
  10338. </td>
  10339. </tr>
  10340. <tr>
  10341. <td>
  10342. <code>headers</code></br>
  10343. <em>
  10344. map[string]string
  10345. </em>
  10346. </td>
  10347. <td>
  10348. <em>(Optional)</em>
  10349. <p>Headers</p>
  10350. </td>
  10351. </tr>
  10352. <tr>
  10353. <td>
  10354. <code>body</code></br>
  10355. <em>
  10356. string
  10357. </em>
  10358. </td>
  10359. <td>
  10360. <em>(Optional)</em>
  10361. <p>Body</p>
  10362. </td>
  10363. </tr>
  10364. <tr>
  10365. <td>
  10366. <code>timeout</code></br>
  10367. <em>
  10368. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  10369. Kubernetes meta/v1.Duration
  10370. </a>
  10371. </em>
  10372. </td>
  10373. <td>
  10374. <em>(Optional)</em>
  10375. <p>Timeout</p>
  10376. </td>
  10377. </tr>
  10378. <tr>
  10379. <td>
  10380. <code>result</code></br>
  10381. <em>
  10382. <a href="#external-secrets.io/v1beta1.WebhookResult">
  10383. WebhookResult
  10384. </a>
  10385. </em>
  10386. </td>
  10387. <td>
  10388. <p>Result formatting</p>
  10389. </td>
  10390. </tr>
  10391. <tr>
  10392. <td>
  10393. <code>secrets</code></br>
  10394. <em>
  10395. <a href="#external-secrets.io/v1beta1.WebhookSecret">
  10396. []WebhookSecret
  10397. </a>
  10398. </em>
  10399. </td>
  10400. <td>
  10401. <em>(Optional)</em>
  10402. <p>Secrets to fill in templates
  10403. These secrets will be passed to the templating function as key value pairs under the given name</p>
  10404. </td>
  10405. </tr>
  10406. <tr>
  10407. <td>
  10408. <code>caBundle</code></br>
  10409. <em>
  10410. []byte
  10411. </em>
  10412. </td>
  10413. <td>
  10414. <em>(Optional)</em>
  10415. <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
  10416. if the Server URL is using HTTPS protocol. This parameter is ignored for
  10417. plain HTTP protocol connection. If not set the system root certificates
  10418. are used to validate the TLS connection.</p>
  10419. </td>
  10420. </tr>
  10421. <tr>
  10422. <td>
  10423. <code>caProvider</code></br>
  10424. <em>
  10425. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">
  10426. WebhookCAProvider
  10427. </a>
  10428. </em>
  10429. </td>
  10430. <td>
  10431. <em>(Optional)</em>
  10432. <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
  10433. </td>
  10434. </tr>
  10435. </tbody>
  10436. </table>
  10437. <h3 id="external-secrets.io/v1beta1.WebhookResult">WebhookResult
  10438. </h3>
  10439. <p>
  10440. (<em>Appears on:</em>
  10441. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  10442. </p>
  10443. <p>
  10444. </p>
  10445. <table>
  10446. <thead>
  10447. <tr>
  10448. <th>Field</th>
  10449. <th>Description</th>
  10450. </tr>
  10451. </thead>
  10452. <tbody>
  10453. <tr>
  10454. <td>
  10455. <code>jsonPath</code></br>
  10456. <em>
  10457. string
  10458. </em>
  10459. </td>
  10460. <td>
  10461. <em>(Optional)</em>
  10462. <p>Json path of return value</p>
  10463. </td>
  10464. </tr>
  10465. </tbody>
  10466. </table>
  10467. <h3 id="external-secrets.io/v1beta1.WebhookSecret">WebhookSecret
  10468. </h3>
  10469. <p>
  10470. (<em>Appears on:</em>
  10471. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  10472. </p>
  10473. <p>
  10474. </p>
  10475. <table>
  10476. <thead>
  10477. <tr>
  10478. <th>Field</th>
  10479. <th>Description</th>
  10480. </tr>
  10481. </thead>
  10482. <tbody>
  10483. <tr>
  10484. <td>
  10485. <code>name</code></br>
  10486. <em>
  10487. string
  10488. </em>
  10489. </td>
  10490. <td>
  10491. <p>Name of this secret in templates</p>
  10492. </td>
  10493. </tr>
  10494. <tr>
  10495. <td>
  10496. <code>secretRef</code></br>
  10497. <em>
  10498. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  10499. External Secrets meta/v1.SecretKeySelector
  10500. </a>
  10501. </em>
  10502. </td>
  10503. <td>
  10504. <p>Secret ref to fill in credentials</p>
  10505. </td>
  10506. </tr>
  10507. </tbody>
  10508. </table>
  10509. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerAuth">YandexCertificateManagerAuth
  10510. </h3>
  10511. <p>
  10512. (<em>Appears on:</em>
  10513. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  10514. </p>
  10515. <p>
  10516. </p>
  10517. <table>
  10518. <thead>
  10519. <tr>
  10520. <th>Field</th>
  10521. <th>Description</th>
  10522. </tr>
  10523. </thead>
  10524. <tbody>
  10525. <tr>
  10526. <td>
  10527. <code>authorizedKeySecretRef</code></br>
  10528. <em>
  10529. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  10530. External Secrets meta/v1.SecretKeySelector
  10531. </a>
  10532. </em>
  10533. </td>
  10534. <td>
  10535. <em>(Optional)</em>
  10536. <p>The authorized key used for authentication</p>
  10537. </td>
  10538. </tr>
  10539. </tbody>
  10540. </table>
  10541. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">YandexCertificateManagerCAProvider
  10542. </h3>
  10543. <p>
  10544. (<em>Appears on:</em>
  10545. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  10546. </p>
  10547. <p>
  10548. </p>
  10549. <table>
  10550. <thead>
  10551. <tr>
  10552. <th>Field</th>
  10553. <th>Description</th>
  10554. </tr>
  10555. </thead>
  10556. <tbody>
  10557. <tr>
  10558. <td>
  10559. <code>certSecretRef</code></br>
  10560. <em>
  10561. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  10562. External Secrets meta/v1.SecretKeySelector
  10563. </a>
  10564. </em>
  10565. </td>
  10566. <td>
  10567. </td>
  10568. </tr>
  10569. </tbody>
  10570. </table>
  10571. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider
  10572. </h3>
  10573. <p>
  10574. (<em>Appears on:</em>
  10575. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  10576. </p>
  10577. <p>
  10578. <p>YandexCertificateManagerProvider Configures a store to sync secrets using the Yandex Certificate Manager provider.</p>
  10579. </p>
  10580. <table>
  10581. <thead>
  10582. <tr>
  10583. <th>Field</th>
  10584. <th>Description</th>
  10585. </tr>
  10586. </thead>
  10587. <tbody>
  10588. <tr>
  10589. <td>
  10590. <code>apiEndpoint</code></br>
  10591. <em>
  10592. string
  10593. </em>
  10594. </td>
  10595. <td>
  10596. <em>(Optional)</em>
  10597. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  10598. </td>
  10599. </tr>
  10600. <tr>
  10601. <td>
  10602. <code>auth</code></br>
  10603. <em>
  10604. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerAuth">
  10605. YandexCertificateManagerAuth
  10606. </a>
  10607. </em>
  10608. </td>
  10609. <td>
  10610. <p>Auth defines the information necessary to authenticate against Yandex Certificate Manager</p>
  10611. </td>
  10612. </tr>
  10613. <tr>
  10614. <td>
  10615. <code>caProvider</code></br>
  10616. <em>
  10617. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">
  10618. YandexCertificateManagerCAProvider
  10619. </a>
  10620. </em>
  10621. </td>
  10622. <td>
  10623. <em>(Optional)</em>
  10624. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  10625. </td>
  10626. </tr>
  10627. </tbody>
  10628. </table>
  10629. <h3 id="external-secrets.io/v1beta1.YandexLockboxAuth">YandexLockboxAuth
  10630. </h3>
  10631. <p>
  10632. (<em>Appears on:</em>
  10633. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  10634. </p>
  10635. <p>
  10636. </p>
  10637. <table>
  10638. <thead>
  10639. <tr>
  10640. <th>Field</th>
  10641. <th>Description</th>
  10642. </tr>
  10643. </thead>
  10644. <tbody>
  10645. <tr>
  10646. <td>
  10647. <code>authorizedKeySecretRef</code></br>
  10648. <em>
  10649. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  10650. External Secrets meta/v1.SecretKeySelector
  10651. </a>
  10652. </em>
  10653. </td>
  10654. <td>
  10655. <em>(Optional)</em>
  10656. <p>The authorized key used for authentication</p>
  10657. </td>
  10658. </tr>
  10659. </tbody>
  10660. </table>
  10661. <h3 id="external-secrets.io/v1beta1.YandexLockboxCAProvider">YandexLockboxCAProvider
  10662. </h3>
  10663. <p>
  10664. (<em>Appears on:</em>
  10665. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  10666. </p>
  10667. <p>
  10668. </p>
  10669. <table>
  10670. <thead>
  10671. <tr>
  10672. <th>Field</th>
  10673. <th>Description</th>
  10674. </tr>
  10675. </thead>
  10676. <tbody>
  10677. <tr>
  10678. <td>
  10679. <code>certSecretRef</code></br>
  10680. <em>
  10681. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  10682. External Secrets meta/v1.SecretKeySelector
  10683. </a>
  10684. </em>
  10685. </td>
  10686. <td>
  10687. </td>
  10688. </tr>
  10689. </tbody>
  10690. </table>
  10691. <h3 id="external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider
  10692. </h3>
  10693. <p>
  10694. (<em>Appears on:</em>
  10695. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  10696. </p>
  10697. <p>
  10698. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
  10699. </p>
  10700. <table>
  10701. <thead>
  10702. <tr>
  10703. <th>Field</th>
  10704. <th>Description</th>
  10705. </tr>
  10706. </thead>
  10707. <tbody>
  10708. <tr>
  10709. <td>
  10710. <code>apiEndpoint</code></br>
  10711. <em>
  10712. string
  10713. </em>
  10714. </td>
  10715. <td>
  10716. <em>(Optional)</em>
  10717. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  10718. </td>
  10719. </tr>
  10720. <tr>
  10721. <td>
  10722. <code>auth</code></br>
  10723. <em>
  10724. <a href="#external-secrets.io/v1beta1.YandexLockboxAuth">
  10725. YandexLockboxAuth
  10726. </a>
  10727. </em>
  10728. </td>
  10729. <td>
  10730. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
  10731. </td>
  10732. </tr>
  10733. <tr>
  10734. <td>
  10735. <code>caProvider</code></br>
  10736. <em>
  10737. <a href="#external-secrets.io/v1beta1.YandexLockboxCAProvider">
  10738. YandexLockboxCAProvider
  10739. </a>
  10740. </em>
  10741. </td>
  10742. <td>
  10743. <em>(Optional)</em>
  10744. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  10745. </td>
  10746. </tr>
  10747. </tbody>
  10748. </table>
  10749. <hr/>
  10750. <p><em>
  10751. Generated with <code>gen-crd-api-reference-docs</code>.
  10752. </em></p>
  10753. </article>
  10754. </div>
  10755. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  10756. </div>
  10757. </main>
  10758. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" />
  10759. <footer class="md-footer">
  10760. <div class="md-footer-meta md-typeset">
  10761. <div class="md-footer-meta__inner md-grid">
  10762. <div class="md-copyright">
  10763. <div class="md-copyright__highlight">
  10764. &copy; 2024 The external-secrets Authors.<br/>
  10765. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  10766. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  10767. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  10768. </div>
  10769. Made with
  10770. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  10771. Material for MkDocs
  10772. </a>
  10773. </div>
  10774. </div>
  10775. </div>
  10776. </footer>
  10777. </div>
  10778. <div class="md-dialog" data-md-component="dialog">
  10779. <div class="md-dialog__inner md-typeset"></div>
  10780. </div>
  10781. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.6ce7567c.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>
  10782. <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
  10783. </body>
  10784. </html>