index.html 147 KB

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