index.html 137 KB

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