index.html 146 KB

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