index.html 143 KB

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