index.html 122 KB

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