index.html 148 KB

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