index.html 129 KB

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