index.html 152 KB

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