index.html 133 KB

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