index.html 200 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030
  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="prev" href="../generator/webhook/">
  7. <link rel="next" href="../controller-options/">
  8. <link rel="icon" href="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.9">
  10. <title>API specification - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.f2e4d321.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__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>
  16. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. </div>
  25. <div data-md-component="announce">
  26. </div>
  27. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  28. <aside class="md-banner md-banner--warning">
  29. <div class="md-banner__inner md-grid md-typeset">
  30. You're not viewing the latest version.
  31. <a href="../../..">
  32. <strong>Click here to go to latest.</strong>
  33. </a>
  34. </div>
  35. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  36. </aside>
  37. </div>
  38. <header class="md-header" data-md-component="header">
  39. <nav class="md-header__inner md-grid" aria-label="Header">
  40. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  41. <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>
  42. </a>
  43. <label class="md-header__button md-icon" for="__drawer">
  44. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  45. </label>
  46. <div class="md-header__title" data-md-component="header-title">
  47. <div class="md-header__ellipsis">
  48. <div class="md-header__topic">
  49. <span class="md-ellipsis">
  50. External Secrets Operator
  51. </span>
  52. </div>
  53. <div class="md-header__topic" data-md-component="header-topic">
  54. <span class="md-ellipsis">
  55. API specification
  56. </span>
  57. </div>
  58. </div>
  59. </div>
  60. <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  61. <label class="md-header__button md-icon" for="__search">
  62. <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>
  63. </label>
  64. <div class="md-search" data-md-component="search" role="dialog">
  65. <label class="md-search__overlay" for="__search"></label>
  66. <div class="md-search__inner" role="search">
  67. <form class="md-search__form" name="search">
  68. <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>
  69. <label class="md-search__icon md-icon" for="__search">
  70. <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>
  71. <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>
  72. </label>
  73. <nav class="md-search__options" aria-label="Search">
  74. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  75. <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>
  76. </button>
  77. </nav>
  78. </form>
  79. <div class="md-search__output">
  80. <div class="md-search__scrollwrap" data-md-scrollfix>
  81. <div class="md-search-result" data-md-component="search-result">
  82. <div class="md-search-result__meta">
  83. Initializing search
  84. </div>
  85. <ol class="md-search-result__list" role="presentation"></ol>
  86. </div>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. <div class="md-header__source">
  92. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  93. <div class="md-source__icon md-icon">
  94. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
  95. </div>
  96. <div class="md-source__repository">
  97. External Secrets Operator
  98. </div>
  99. </a>
  100. </div>
  101. </nav>
  102. </header>
  103. <div class="md-container" data-md-component="container">
  104. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  105. <div class="md-grid">
  106. <ul class="md-tabs__list">
  107. <li class="md-tabs__item">
  108. <a href="../.." class="md-tabs__link">
  109. Introduction
  110. </a>
  111. </li>
  112. <li class="md-tabs__item md-tabs__item--active">
  113. <a href="../components/" class="md-tabs__link">
  114. API
  115. </a>
  116. </li>
  117. <li class="md-tabs__item">
  118. <a href="../../guides/introduction/" class="md-tabs__link">
  119. Guides
  120. </a>
  121. </li>
  122. <li class="md-tabs__item">
  123. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  124. Provider
  125. </a>
  126. </li>
  127. <li class="md-tabs__item">
  128. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  129. Examples
  130. </a>
  131. </li>
  132. <li class="md-tabs__item">
  133. <a href="../../contributing/devguide/" class="md-tabs__link">
  134. Community
  135. </a>
  136. </li>
  137. </ul>
  138. </div>
  139. </nav>
  140. <main class="md-main" data-md-component="main">
  141. <div class="md-main__inner md-grid">
  142. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  143. <div class="md-sidebar__scrollwrap">
  144. <div class="md-sidebar__inner">
  145. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  146. <label class="md-nav__title" for="__drawer">
  147. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  148. <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>
  149. </a>
  150. External Secrets Operator
  151. </label>
  152. <div class="md-nav__source">
  153. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  154. <div class="md-source__icon md-icon">
  155. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
  156. </div>
  157. <div class="md-source__repository">
  158. External Secrets Operator
  159. </div>
  160. </a>
  161. </div>
  162. <ul class="md-nav__list" data-md-scrollfix>
  163. <li class="md-nav__item md-nav__item--nested">
  164. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  165. <div class="md-nav__link md-nav__container">
  166. <a href="../.." class="md-nav__link ">
  167. <span class="md-ellipsis">
  168. Introduction
  169. </span>
  170. </a>
  171. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  172. <span class="md-nav__icon md-icon"></span>
  173. </label>
  174. </div>
  175. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  176. <label class="md-nav__title" for="__nav_1">
  177. <span class="md-nav__icon md-icon"></span>
  178. Introduction
  179. </label>
  180. <ul class="md-nav__list" data-md-scrollfix>
  181. <li class="md-nav__item">
  182. <a href="../../introduction/overview/" class="md-nav__link">
  183. <span class="md-ellipsis">
  184. Overview
  185. </span>
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/getting-started/" class="md-nav__link">
  190. <span class="md-ellipsis">
  191. Getting started
  192. </span>
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/faq/" class="md-nav__link">
  197. <span class="md-ellipsis">
  198. FAQ
  199. </span>
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../../introduction/stability-support/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Stability and Support
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. Deprecation Policy
  213. </span>
  214. </a>
  215. </li>
  216. </ul>
  217. </nav>
  218. </li>
  219. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  220. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  221. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  222. <span class="md-ellipsis">
  223. API
  224. </span>
  225. <span class="md-nav__icon md-icon"></span>
  226. </label>
  227. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  228. <label class="md-nav__title" for="__nav_2">
  229. <span class="md-nav__icon md-icon"></span>
  230. API
  231. </label>
  232. <ul class="md-nav__list" data-md-scrollfix>
  233. <li class="md-nav__item">
  234. <a href="../components/" class="md-nav__link">
  235. <span class="md-ellipsis">
  236. Components
  237. </span>
  238. </a>
  239. </li>
  240. <li class="md-nav__item md-nav__item--nested">
  241. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  242. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  243. <span class="md-ellipsis">
  244. Core Resources
  245. </span>
  246. <span class="md-nav__icon md-icon"></span>
  247. </label>
  248. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  249. <label class="md-nav__title" for="__nav_2_2">
  250. <span class="md-nav__icon md-icon"></span>
  251. Core Resources
  252. </label>
  253. <ul class="md-nav__list" data-md-scrollfix>
  254. <li class="md-nav__item">
  255. <a href="../externalsecret/" class="md-nav__link">
  256. <span class="md-ellipsis">
  257. ExternalSecret
  258. </span>
  259. </a>
  260. </li>
  261. <li class="md-nav__item">
  262. <a href="../secretstore/" class="md-nav__link">
  263. <span class="md-ellipsis">
  264. SecretStore
  265. </span>
  266. </a>
  267. </li>
  268. <li class="md-nav__item">
  269. <a href="../clustersecretstore/" class="md-nav__link">
  270. <span class="md-ellipsis">
  271. ClusterSecretStore
  272. </span>
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="../clusterexternalsecret/" class="md-nav__link">
  277. <span class="md-ellipsis">
  278. ClusterExternalSecret
  279. </span>
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../pushsecret/" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. PushSecret
  286. </span>
  287. </a>
  288. </li>
  289. </ul>
  290. </nav>
  291. </li>
  292. <li class="md-nav__item md-nav__item--nested">
  293. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  294. <div class="md-nav__link md-nav__container">
  295. <a href="../generator/" class="md-nav__link ">
  296. <span class="md-ellipsis">
  297. Generators
  298. </span>
  299. </a>
  300. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  301. <span class="md-nav__icon md-icon"></span>
  302. </label>
  303. </div>
  304. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  305. <label class="md-nav__title" for="__nav_2_3">
  306. <span class="md-nav__icon md-icon"></span>
  307. Generators
  308. </label>
  309. <ul class="md-nav__list" data-md-scrollfix>
  310. <li class="md-nav__item">
  311. <a href="../generator/acr/" class="md-nav__link">
  312. <span class="md-ellipsis">
  313. Azure Container Registry
  314. </span>
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../generator/ecr/" class="md-nav__link">
  319. <span class="md-ellipsis">
  320. AWS Elastic Container Registry
  321. </span>
  322. </a>
  323. </li>
  324. <li class="md-nav__item">
  325. <a href="../generator/gcr/" class="md-nav__link">
  326. <span class="md-ellipsis">
  327. Google Container Registry
  328. </span>
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="../generator/vault/" class="md-nav__link">
  333. <span class="md-ellipsis">
  334. Vault Dynamic Secret
  335. </span>
  336. </a>
  337. </li>
  338. <li class="md-nav__item">
  339. <a href="../generator/password/" class="md-nav__link">
  340. <span class="md-ellipsis">
  341. Password
  342. </span>
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="../generator/fake/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. Fake
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../generator/webhook/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. Webhook
  356. </span>
  357. </a>
  358. </li>
  359. </ul>
  360. </nav>
  361. </li>
  362. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  363. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" checked>
  364. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  365. <span class="md-ellipsis">
  366. Reference Docs
  367. </span>
  368. <span class="md-nav__icon md-icon"></span>
  369. </label>
  370. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="true">
  371. <label class="md-nav__title" for="__nav_2_4">
  372. <span class="md-nav__icon md-icon"></span>
  373. Reference Docs
  374. </label>
  375. <ul class="md-nav__list" data-md-scrollfix>
  376. <li class="md-nav__item md-nav__item--active">
  377. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  378. <a href="./" class="md-nav__link md-nav__link--active">
  379. <span class="md-ellipsis">
  380. API specification
  381. </span>
  382. </a>
  383. </li>
  384. <li class="md-nav__item">
  385. <a href="../controller-options/" class="md-nav__link">
  386. <span class="md-ellipsis">
  387. Controller Options
  388. </span>
  389. </a>
  390. </li>
  391. <li class="md-nav__item">
  392. <a href="../metrics/" class="md-nav__link">
  393. <span class="md-ellipsis">
  394. Metrics
  395. </span>
  396. </a>
  397. </li>
  398. </ul>
  399. </nav>
  400. </li>
  401. </ul>
  402. </nav>
  403. </li>
  404. <li class="md-nav__item md-nav__item--nested">
  405. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  406. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  407. <span class="md-ellipsis">
  408. Guides
  409. </span>
  410. <span class="md-nav__icon md-icon"></span>
  411. </label>
  412. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  413. <label class="md-nav__title" for="__nav_3">
  414. <span class="md-nav__icon md-icon"></span>
  415. Guides
  416. </label>
  417. <ul class="md-nav__list" data-md-scrollfix>
  418. <li class="md-nav__item">
  419. <a href="../../guides/introduction/" class="md-nav__link">
  420. <span class="md-ellipsis">
  421. Introduction
  422. </span>
  423. </a>
  424. </li>
  425. <li class="md-nav__item md-nav__item--nested">
  426. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  427. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  428. <span class="md-ellipsis">
  429. External Secrets
  430. </span>
  431. <span class="md-nav__icon md-icon"></span>
  432. </label>
  433. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  434. <label class="md-nav__title" for="__nav_3_2">
  435. <span class="md-nav__icon md-icon"></span>
  436. External Secrets
  437. </label>
  438. <ul class="md-nav__list" data-md-scrollfix>
  439. <li class="md-nav__item">
  440. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  441. <span class="md-ellipsis">
  442. Extract structured data
  443. </span>
  444. </a>
  445. </li>
  446. <li class="md-nav__item">
  447. <a href="../../guides/getallsecrets/" class="md-nav__link">
  448. <span class="md-ellipsis">
  449. Find Secrets by Name or Metadata
  450. </span>
  451. </a>
  452. </li>
  453. <li class="md-nav__item">
  454. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  455. <span class="md-ellipsis">
  456. Rewriting Keys
  457. </span>
  458. </a>
  459. </li>
  460. <li class="md-nav__item md-nav__item--nested">
  461. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  462. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  463. <span class="md-ellipsis">
  464. Advanced Templating
  465. </span>
  466. <span class="md-nav__icon md-icon"></span>
  467. </label>
  468. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  469. <label class="md-nav__title" for="__nav_3_2_4">
  470. <span class="md-nav__icon md-icon"></span>
  471. Advanced Templating
  472. </label>
  473. <ul class="md-nav__list" data-md-scrollfix>
  474. <li class="md-nav__item">
  475. <a href="../../guides/templating/" class="md-nav__link">
  476. <span class="md-ellipsis">
  477. v2
  478. </span>
  479. </a>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../../guides/templating-v1/" class="md-nav__link">
  483. <span class="md-ellipsis">
  484. v1
  485. </span>
  486. </a>
  487. </li>
  488. </ul>
  489. </nav>
  490. </li>
  491. <li class="md-nav__item">
  492. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  493. <span class="md-ellipsis">
  494. Kubernetes Secret Types
  495. </span>
  496. </a>
  497. </li>
  498. <li class="md-nav__item">
  499. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  500. <span class="md-ellipsis">
  501. Lifecycle: ownership & deletion
  502. </span>
  503. </a>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  507. <span class="md-ellipsis">
  508. Decoding Strategies
  509. </span>
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="../../guides/controller-class/" class="md-nav__link">
  514. <span class="md-ellipsis">
  515. Controller Classes
  516. </span>
  517. </a>
  518. </li>
  519. </ul>
  520. </nav>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../../guides/generator/" class="md-nav__link">
  524. <span class="md-ellipsis">
  525. Generators
  526. </span>
  527. </a>
  528. </li>
  529. <li class="md-nav__item">
  530. <a href="../../guides/pushsecrets/" class="md-nav__link">
  531. <span class="md-ellipsis">
  532. Push Secrets
  533. </span>
  534. </a>
  535. </li>
  536. <li class="md-nav__item md-nav__item--nested">
  537. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  538. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  539. <span class="md-ellipsis">
  540. Operations
  541. </span>
  542. <span class="md-nav__icon md-icon"></span>
  543. </label>
  544. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  545. <label class="md-nav__title" for="__nav_3_5">
  546. <span class="md-nav__icon md-icon"></span>
  547. Operations
  548. </label>
  549. <ul class="md-nav__list" data-md-scrollfix>
  550. <li class="md-nav__item">
  551. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  552. <span class="md-ellipsis">
  553. Multi Tenancy
  554. </span>
  555. </a>
  556. </li>
  557. <li class="md-nav__item">
  558. <a href="../../guides/security-best-practices/" class="md-nav__link">
  559. <span class="md-ellipsis">
  560. Security Best Practices
  561. </span>
  562. </a>
  563. </li>
  564. <li class="md-nav__item">
  565. <a href="../../guides/threat-model/" class="md-nav__link">
  566. <span class="md-ellipsis">
  567. Threat Model
  568. </span>
  569. </a>
  570. </li>
  571. <li class="md-nav__item">
  572. <a href="../../guides/v1beta1/" class="md-nav__link">
  573. <span class="md-ellipsis">
  574. Upgrading to v1beta1
  575. </span>
  576. </a>
  577. </li>
  578. <li class="md-nav__item">
  579. <a href="../../guides/using-latest-image/" class="md-nav__link">
  580. <span class="md-ellipsis">
  581. Using Latest Image
  582. </span>
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  587. <span class="md-ellipsis">
  588. Disable Cluster Features
  589. </span>
  590. </a>
  591. </li>
  592. </ul>
  593. </nav>
  594. </li>
  595. </ul>
  596. </nav>
  597. </li>
  598. <li class="md-nav__item md-nav__item--nested">
  599. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  600. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  601. <span class="md-ellipsis">
  602. Provider
  603. </span>
  604. <span class="md-nav__icon md-icon"></span>
  605. </label>
  606. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  607. <label class="md-nav__title" for="__nav_4">
  608. <span class="md-nav__icon md-icon"></span>
  609. Provider
  610. </label>
  611. <ul class="md-nav__list" data-md-scrollfix>
  612. <li class="md-nav__item">
  613. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  614. <span class="md-ellipsis">
  615. AWS Secrets Manager
  616. </span>
  617. </a>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  621. <span class="md-ellipsis">
  622. AWS Parameter Store
  623. </span>
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  628. <span class="md-ellipsis">
  629. Azure Key Vault
  630. </span>
  631. </a>
  632. </li>
  633. <li class="md-nav__item">
  634. <a href="../../provider/chef/" class="md-nav__link">
  635. <span class="md-ellipsis">
  636. Chef
  637. </span>
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../../provider/conjur/" class="md-nav__link">
  642. <span class="md-ellipsis">
  643. CyberArk Conjur
  644. </span>
  645. </a>
  646. </li>
  647. <li class="md-nav__item">
  648. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  649. <span class="md-ellipsis">
  650. Google Cloud Secret Manager
  651. </span>
  652. </a>
  653. </li>
  654. <li class="md-nav__item">
  655. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  656. <span class="md-ellipsis">
  657. HashiCorp Vault
  658. </span>
  659. </a>
  660. </li>
  661. <li class="md-nav__item">
  662. <a href="../../provider/kubernetes/" class="md-nav__link">
  663. <span class="md-ellipsis">
  664. Kubernetes
  665. </span>
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  670. <span class="md-ellipsis">
  671. IBM Secrets Manager
  672. </span>
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../../provider/akeyless/" class="md-nav__link">
  677. <span class="md-ellipsis">
  678. Akeyless
  679. </span>
  680. </a>
  681. </li>
  682. <li class="md-nav__item">
  683. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  684. <span class="md-ellipsis">
  685. Yandex Certificate Manager
  686. </span>
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  691. <span class="md-ellipsis">
  692. Yandex Lockbox
  693. </span>
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="../../provider/alibaba/" class="md-nav__link">
  698. <span class="md-ellipsis">
  699. Alibaba Cloud
  700. </span>
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  705. <span class="md-ellipsis">
  706. GitLab Variables
  707. </span>
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="../../provider/oracle-vault/" class="md-nav__link">
  712. <span class="md-ellipsis">
  713. Oracle Vault
  714. </span>
  715. </a>
  716. </li>
  717. <li class="md-nav__item">
  718. <a href="../../provider/1password-automation/" class="md-nav__link">
  719. <span class="md-ellipsis">
  720. 1Password Secrets Automation
  721. </span>
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="../../provider/webhook/" class="md-nav__link">
  726. <span class="md-ellipsis">
  727. Webhook
  728. </span>
  729. </a>
  730. </li>
  731. <li class="md-nav__item">
  732. <a href="../../provider/fake/" class="md-nav__link">
  733. <span class="md-ellipsis">
  734. Fake
  735. </span>
  736. </a>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  740. <span class="md-ellipsis">
  741. senhasegura DevOps Secrets Management (DSM)
  742. </span>
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="../../provider/doppler/" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. Doppler
  749. </span>
  750. </a>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="../../provider/keeper-security/" class="md-nav__link">
  754. <span class="md-ellipsis">
  755. Keeper Security
  756. </span>
  757. </a>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="../../provider/cloak/" class="md-nav__link">
  761. <span class="md-ellipsis">
  762. Cloak End 2 End Encrypted Secrets
  763. </span>
  764. </a>
  765. </li>
  766. <li class="md-nav__item">
  767. <a href="../../provider/scaleway/" class="md-nav__link">
  768. <span class="md-ellipsis">
  769. Scaleway
  770. </span>
  771. </a>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="../../provider/delinea/" class="md-nav__link">
  775. <span class="md-ellipsis">
  776. Delinea
  777. </span>
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="../../provider/pulumi/" class="md-nav__link">
  782. <span class="md-ellipsis">
  783. Pulumi ESC
  784. </span>
  785. </a>
  786. </li>
  787. </ul>
  788. </nav>
  789. </li>
  790. <li class="md-nav__item md-nav__item--nested">
  791. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  792. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  793. <span class="md-ellipsis">
  794. Examples
  795. </span>
  796. <span class="md-nav__icon md-icon"></span>
  797. </label>
  798. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  799. <label class="md-nav__title" for="__nav_5">
  800. <span class="md-nav__icon md-icon"></span>
  801. Examples
  802. </label>
  803. <ul class="md-nav__list" data-md-scrollfix>
  804. <li class="md-nav__item">
  805. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  806. <span class="md-ellipsis">
  807. FluxCD
  808. </span>
  809. </a>
  810. </li>
  811. <li class="md-nav__item">
  812. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  813. <span class="md-ellipsis">
  814. Anchore Engine
  815. </span>
  816. </a>
  817. </li>
  818. <li class="md-nav__item">
  819. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  820. <span class="md-ellipsis">
  821. Jenkins
  822. </span>
  823. </a>
  824. </li>
  825. <li class="md-nav__item">
  826. <a href="../../examples/bitwarden/" class="md-nav__link">
  827. <span class="md-ellipsis">
  828. BitWarden
  829. </span>
  830. </a>
  831. </li>
  832. </ul>
  833. </nav>
  834. </li>
  835. <li class="md-nav__item md-nav__item--nested">
  836. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  837. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  838. <span class="md-ellipsis">
  839. Community
  840. </span>
  841. <span class="md-nav__icon md-icon"></span>
  842. </label>
  843. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  844. <label class="md-nav__title" for="__nav_6">
  845. <span class="md-nav__icon md-icon"></span>
  846. Community
  847. </label>
  848. <ul class="md-nav__list" data-md-scrollfix>
  849. <li class="md-nav__item md-nav__item--nested">
  850. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  851. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  852. <span class="md-ellipsis">
  853. Contributing
  854. </span>
  855. <span class="md-nav__icon md-icon"></span>
  856. </label>
  857. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  858. <label class="md-nav__title" for="__nav_6_1">
  859. <span class="md-nav__icon md-icon"></span>
  860. Contributing
  861. </label>
  862. <ul class="md-nav__list" data-md-scrollfix>
  863. <li class="md-nav__item">
  864. <a href="../../contributing/devguide/" class="md-nav__link">
  865. <span class="md-ellipsis">
  866. Developer guide
  867. </span>
  868. </a>
  869. </li>
  870. <li class="md-nav__item">
  871. <a href="../../contributing/process/" class="md-nav__link">
  872. <span class="md-ellipsis">
  873. Contributing Process
  874. </span>
  875. </a>
  876. </li>
  877. <li class="md-nav__item">
  878. <a href="../../contributing/release/" class="md-nav__link">
  879. <span class="md-ellipsis">
  880. Release Process
  881. </span>
  882. </a>
  883. </li>
  884. <li class="md-nav__item">
  885. <a href="../../contributing/coc/" class="md-nav__link">
  886. <span class="md-ellipsis">
  887. Code of Conduct
  888. </span>
  889. </a>
  890. </li>
  891. <li class="md-nav__item">
  892. <a href="../../contributing/roadmap/" class="md-nav__link">
  893. <span class="md-ellipsis">
  894. Roadmap
  895. </span>
  896. </a>
  897. </li>
  898. </ul>
  899. </nav>
  900. </li>
  901. <li class="md-nav__item md-nav__item--nested">
  902. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  903. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  904. <span class="md-ellipsis">
  905. External Resources
  906. </span>
  907. <span class="md-nav__icon md-icon"></span>
  908. </label>
  909. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  910. <label class="md-nav__title" for="__nav_6_2">
  911. <span class="md-nav__icon md-icon"></span>
  912. External Resources
  913. </label>
  914. <ul class="md-nav__list" data-md-scrollfix>
  915. <li class="md-nav__item">
  916. <a href="../../eso-talks/" class="md-nav__link">
  917. <span class="md-ellipsis">
  918. Talks
  919. </span>
  920. </a>
  921. </li>
  922. <li class="md-nav__item">
  923. <a href="../../eso-demos/" class="md-nav__link">
  924. <span class="md-ellipsis">
  925. Demos
  926. </span>
  927. </a>
  928. </li>
  929. <li class="md-nav__item">
  930. <a href="../../eso-blogs/" class="md-nav__link">
  931. <span class="md-ellipsis">
  932. Blogs
  933. </span>
  934. </a>
  935. </li>
  936. </ul>
  937. </nav>
  938. </li>
  939. </ul>
  940. </nav>
  941. </li>
  942. </ul>
  943. </nav>
  944. </div>
  945. </div>
  946. </div>
  947. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  948. <div class="md-sidebar__scrollwrap">
  949. <div class="md-sidebar__inner">
  950. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  951. </nav>
  952. </div>
  953. </div>
  954. </div>
  955. <div class="md-content" data-md-component="content">
  956. <article class="md-content__inner md-typeset">
  957. <h1>API specification</h1>
  958. <p>Packages:</p>
  959. <ul>
  960. <li>
  961. <a href="#external-secrets.io%2fv1beta1">external-secrets.io/v1beta1</a>
  962. </li>
  963. </ul>
  964. <h2 id="external-secrets.io/v1beta1">external-secrets.io/v1beta1</h2>
  965. <p>
  966. <p>Package v1beta1 contains resources for external-secrets</p>
  967. </p>
  968. <p>Resource Types:</p>
  969. <ul></ul>
  970. <h3 id="external-secrets.io/v1beta1.AWSAuth">AWSAuth
  971. </h3>
  972. <p>
  973. (<em>Appears on:</em>
  974. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  975. </p>
  976. <p>
  977. <p>AWSAuth tells the controller how to do authentication with aws.
  978. Only one of secretRef or jwt can be specified.
  979. if none is specified the controller will load credentials using the aws sdk defaults.</p>
  980. </p>
  981. <table>
  982. <thead>
  983. <tr>
  984. <th>Field</th>
  985. <th>Description</th>
  986. </tr>
  987. </thead>
  988. <tbody>
  989. <tr>
  990. <td>
  991. <code>secretRef</code></br>
  992. <em>
  993. <a href="#external-secrets.io/v1beta1.AWSAuthSecretRef">
  994. AWSAuthSecretRef
  995. </a>
  996. </em>
  997. </td>
  998. <td>
  999. <em>(Optional)</em>
  1000. </td>
  1001. </tr>
  1002. <tr>
  1003. <td>
  1004. <code>jwt</code></br>
  1005. <em>
  1006. <a href="#external-secrets.io/v1beta1.AWSJWTAuth">
  1007. AWSJWTAuth
  1008. </a>
  1009. </em>
  1010. </td>
  1011. <td>
  1012. <em>(Optional)</em>
  1013. </td>
  1014. </tr>
  1015. </tbody>
  1016. </table>
  1017. <h3 id="external-secrets.io/v1beta1.AWSAuthSecretRef">AWSAuthSecretRef
  1018. </h3>
  1019. <p>
  1020. (<em>Appears on:</em>
  1021. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  1022. </p>
  1023. <p>
  1024. <p>AWSAuthSecretRef holds secret references for AWS credentials
  1025. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  1026. </p>
  1027. <table>
  1028. <thead>
  1029. <tr>
  1030. <th>Field</th>
  1031. <th>Description</th>
  1032. </tr>
  1033. </thead>
  1034. <tbody>
  1035. <tr>
  1036. <td>
  1037. <code>accessKeyIDSecretRef</code></br>
  1038. <em>
  1039. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1040. External Secrets meta/v1.SecretKeySelector
  1041. </a>
  1042. </em>
  1043. </td>
  1044. <td>
  1045. <p>The AccessKeyID is used for authentication</p>
  1046. </td>
  1047. </tr>
  1048. <tr>
  1049. <td>
  1050. <code>secretAccessKeySecretRef</code></br>
  1051. <em>
  1052. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1053. External Secrets meta/v1.SecretKeySelector
  1054. </a>
  1055. </em>
  1056. </td>
  1057. <td>
  1058. <p>The SecretAccessKey is used for authentication</p>
  1059. </td>
  1060. </tr>
  1061. <tr>
  1062. <td>
  1063. <code>sessionTokenSecretRef</code></br>
  1064. <em>
  1065. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1066. External Secrets meta/v1.SecretKeySelector
  1067. </a>
  1068. </em>
  1069. </td>
  1070. <td>
  1071. <p>The SessionToken used for authentication
  1072. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  1073. 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>
  1074. </td>
  1075. </tr>
  1076. </tbody>
  1077. </table>
  1078. <h3 id="external-secrets.io/v1beta1.AWSJWTAuth">AWSJWTAuth
  1079. </h3>
  1080. <p>
  1081. (<em>Appears on:</em>
  1082. <a href="#external-secrets.io/v1beta1.AWSAuth">AWSAuth</a>)
  1083. </p>
  1084. <p>
  1085. <p>Authenticate against AWS using service account tokens.</p>
  1086. </p>
  1087. <table>
  1088. <thead>
  1089. <tr>
  1090. <th>Field</th>
  1091. <th>Description</th>
  1092. </tr>
  1093. </thead>
  1094. <tbody>
  1095. <tr>
  1096. <td>
  1097. <code>serviceAccountRef</code></br>
  1098. <em>
  1099. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  1100. External Secrets meta/v1.ServiceAccountSelector
  1101. </a>
  1102. </em>
  1103. </td>
  1104. <td>
  1105. </td>
  1106. </tr>
  1107. </tbody>
  1108. </table>
  1109. <h3 id="external-secrets.io/v1beta1.AWSProvider">AWSProvider
  1110. </h3>
  1111. <p>
  1112. (<em>Appears on:</em>
  1113. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1114. </p>
  1115. <p>
  1116. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  1117. </p>
  1118. <table>
  1119. <thead>
  1120. <tr>
  1121. <th>Field</th>
  1122. <th>Description</th>
  1123. </tr>
  1124. </thead>
  1125. <tbody>
  1126. <tr>
  1127. <td>
  1128. <code>service</code></br>
  1129. <em>
  1130. <a href="#external-secrets.io/v1beta1.AWSServiceType">
  1131. AWSServiceType
  1132. </a>
  1133. </em>
  1134. </td>
  1135. <td>
  1136. <p>Service defines which service should be used to fetch the secrets</p>
  1137. </td>
  1138. </tr>
  1139. <tr>
  1140. <td>
  1141. <code>auth</code></br>
  1142. <em>
  1143. <a href="#external-secrets.io/v1beta1.AWSAuth">
  1144. AWSAuth
  1145. </a>
  1146. </em>
  1147. </td>
  1148. <td>
  1149. <em>(Optional)</em>
  1150. <p>Auth defines the information necessary to authenticate against AWS
  1151. if not set aws sdk will infer credentials from your environment
  1152. 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>
  1153. </td>
  1154. </tr>
  1155. <tr>
  1156. <td>
  1157. <code>role</code></br>
  1158. <em>
  1159. string
  1160. </em>
  1161. </td>
  1162. <td>
  1163. <em>(Optional)</em>
  1164. <p>Role is a Role ARN which the provider will assume</p>
  1165. </td>
  1166. </tr>
  1167. <tr>
  1168. <td>
  1169. <code>region</code></br>
  1170. <em>
  1171. string
  1172. </em>
  1173. </td>
  1174. <td>
  1175. <p>AWS Region to be used for the provider</p>
  1176. </td>
  1177. </tr>
  1178. <tr>
  1179. <td>
  1180. <code>additionalRoles</code></br>
  1181. <em>
  1182. []string
  1183. </em>
  1184. </td>
  1185. <td>
  1186. <em>(Optional)</em>
  1187. <p>AdditionalRoles is a chained list of Role ARNs which the provider will sequentially assume before assuming the Role</p>
  1188. </td>
  1189. </tr>
  1190. <tr>
  1191. <td>
  1192. <code>externalID</code></br>
  1193. <em>
  1194. string
  1195. </em>
  1196. </td>
  1197. <td>
  1198. <p>AWS External ID set on assumed IAM roles</p>
  1199. </td>
  1200. </tr>
  1201. <tr>
  1202. <td>
  1203. <code>sessionTags</code></br>
  1204. <em>
  1205. <a href="#external-secrets.io/v1beta1.*github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1.Tag">
  1206. []*github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1.Tag
  1207. </a>
  1208. </em>
  1209. </td>
  1210. <td>
  1211. <em>(Optional)</em>
  1212. <p>AWS STS assume role session tags</p>
  1213. </td>
  1214. </tr>
  1215. <tr>
  1216. <td>
  1217. <code>secretsManager</code></br>
  1218. <em>
  1219. <a href="#external-secrets.io/v1beta1.SecretsManager">
  1220. SecretsManager
  1221. </a>
  1222. </em>
  1223. </td>
  1224. <td>
  1225. <em>(Optional)</em>
  1226. <p>SecretsManager defines how the provider behaves when interacting with AWS SecretsManager</p>
  1227. </td>
  1228. </tr>
  1229. <tr>
  1230. <td>
  1231. <code>transitiveTagKeys</code></br>
  1232. <em>
  1233. []*string
  1234. </em>
  1235. </td>
  1236. <td>
  1237. <em>(Optional)</em>
  1238. <p>AWS STS assume role transitive session tags. Required when multiple rules are used with the provider</p>
  1239. </td>
  1240. </tr>
  1241. </tbody>
  1242. </table>
  1243. <h3 id="external-secrets.io/v1beta1.AWSServiceType">AWSServiceType
  1244. (<code>string</code> alias)</p></h3>
  1245. <p>
  1246. (<em>Appears on:</em>
  1247. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  1248. </p>
  1249. <p>
  1250. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  1251. </p>
  1252. <table>
  1253. <thead>
  1254. <tr>
  1255. <th>Value</th>
  1256. <th>Description</th>
  1257. </tr>
  1258. </thead>
  1259. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  1260. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore service.
  1261. 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>
  1262. </td>
  1263. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  1264. <td><p>AWSServiceSecretsManager is the AWS SecretsManager service.
  1265. 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>
  1266. </td>
  1267. </tr></tbody>
  1268. </table>
  1269. <h3 id="external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth
  1270. </h3>
  1271. <p>
  1272. (<em>Appears on:</em>
  1273. <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>)
  1274. </p>
  1275. <p>
  1276. </p>
  1277. <table>
  1278. <thead>
  1279. <tr>
  1280. <th>Field</th>
  1281. <th>Description</th>
  1282. </tr>
  1283. </thead>
  1284. <tbody>
  1285. <tr>
  1286. <td>
  1287. <code>secretRef</code></br>
  1288. <em>
  1289. <a href="#external-secrets.io/v1beta1.AkeylessAuthSecretRef">
  1290. AkeylessAuthSecretRef
  1291. </a>
  1292. </em>
  1293. </td>
  1294. <td>
  1295. <em>(Optional)</em>
  1296. <p>Reference to a Secret that contains the details
  1297. to authenticate with Akeyless.</p>
  1298. </td>
  1299. </tr>
  1300. <tr>
  1301. <td>
  1302. <code>kubernetesAuth</code></br>
  1303. <em>
  1304. <a href="#external-secrets.io/v1beta1.AkeylessKubernetesAuth">
  1305. AkeylessKubernetesAuth
  1306. </a>
  1307. </em>
  1308. </td>
  1309. <td>
  1310. <em>(Optional)</em>
  1311. <p>Kubernetes authenticates with Akeyless by passing the ServiceAccount
  1312. token stored in the named Secret resource.</p>
  1313. </td>
  1314. </tr>
  1315. </tbody>
  1316. </table>
  1317. <h3 id="external-secrets.io/v1beta1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
  1318. </h3>
  1319. <p>
  1320. (<em>Appears on:</em>
  1321. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  1322. </p>
  1323. <p>
  1324. <p>AkeylessAuthSecretRef
  1325. AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
  1326. </p>
  1327. <table>
  1328. <thead>
  1329. <tr>
  1330. <th>Field</th>
  1331. <th>Description</th>
  1332. </tr>
  1333. </thead>
  1334. <tbody>
  1335. <tr>
  1336. <td>
  1337. <code>accessID</code></br>
  1338. <em>
  1339. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1340. External Secrets meta/v1.SecretKeySelector
  1341. </a>
  1342. </em>
  1343. </td>
  1344. <td>
  1345. <p>The SecretAccessID is used for authentication</p>
  1346. </td>
  1347. </tr>
  1348. <tr>
  1349. <td>
  1350. <code>accessType</code></br>
  1351. <em>
  1352. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1353. External Secrets meta/v1.SecretKeySelector
  1354. </a>
  1355. </em>
  1356. </td>
  1357. <td>
  1358. </td>
  1359. </tr>
  1360. <tr>
  1361. <td>
  1362. <code>accessTypeParam</code></br>
  1363. <em>
  1364. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1365. External Secrets meta/v1.SecretKeySelector
  1366. </a>
  1367. </em>
  1368. </td>
  1369. <td>
  1370. </td>
  1371. </tr>
  1372. </tbody>
  1373. </table>
  1374. <h3 id="external-secrets.io/v1beta1.AkeylessKubernetesAuth">AkeylessKubernetesAuth
  1375. </h3>
  1376. <p>
  1377. (<em>Appears on:</em>
  1378. <a href="#external-secrets.io/v1beta1.AkeylessAuth">AkeylessAuth</a>)
  1379. </p>
  1380. <p>
  1381. <p>Authenticate with Kubernetes ServiceAccount token stored.</p>
  1382. </p>
  1383. <table>
  1384. <thead>
  1385. <tr>
  1386. <th>Field</th>
  1387. <th>Description</th>
  1388. </tr>
  1389. </thead>
  1390. <tbody>
  1391. <tr>
  1392. <td>
  1393. <code>accessID</code></br>
  1394. <em>
  1395. string
  1396. </em>
  1397. </td>
  1398. <td>
  1399. <p>the Akeyless Kubernetes auth-method access-id</p>
  1400. </td>
  1401. </tr>
  1402. <tr>
  1403. <td>
  1404. <code>k8sConfName</code></br>
  1405. <em>
  1406. string
  1407. </em>
  1408. </td>
  1409. <td>
  1410. <p>Kubernetes-auth configuration name in Akeyless-Gateway</p>
  1411. </td>
  1412. </tr>
  1413. <tr>
  1414. <td>
  1415. <code>serviceAccountRef</code></br>
  1416. <em>
  1417. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  1418. External Secrets meta/v1.ServiceAccountSelector
  1419. </a>
  1420. </em>
  1421. </td>
  1422. <td>
  1423. <em>(Optional)</em>
  1424. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  1425. If the service account is specified, the service account secret token JWT will be used
  1426. for authenticating with Akeyless. If the service account selector is not supplied,
  1427. the secretRef will be used instead.</p>
  1428. </td>
  1429. </tr>
  1430. <tr>
  1431. <td>
  1432. <code>secretRef</code></br>
  1433. <em>
  1434. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1435. External Secrets meta/v1.SecretKeySelector
  1436. </a>
  1437. </em>
  1438. </td>
  1439. <td>
  1440. <em>(Optional)</em>
  1441. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  1442. for authenticating with Akeyless. If a name is specified without a key,
  1443. <code>token</code> is the default. If one is not specified, the one bound to
  1444. the controller will be used.</p>
  1445. </td>
  1446. </tr>
  1447. </tbody>
  1448. </table>
  1449. <h3 id="external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider
  1450. </h3>
  1451. <p>
  1452. (<em>Appears on:</em>
  1453. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1454. </p>
  1455. <p>
  1456. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  1457. </p>
  1458. <table>
  1459. <thead>
  1460. <tr>
  1461. <th>Field</th>
  1462. <th>Description</th>
  1463. </tr>
  1464. </thead>
  1465. <tbody>
  1466. <tr>
  1467. <td>
  1468. <code>akeylessGWApiURL</code></br>
  1469. <em>
  1470. string
  1471. </em>
  1472. </td>
  1473. <td>
  1474. <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
  1475. </td>
  1476. </tr>
  1477. <tr>
  1478. <td>
  1479. <code>authSecretRef</code></br>
  1480. <em>
  1481. <a href="#external-secrets.io/v1beta1.AkeylessAuth">
  1482. AkeylessAuth
  1483. </a>
  1484. </em>
  1485. </td>
  1486. <td>
  1487. <p>Auth configures how the operator authenticates with Akeyless.</p>
  1488. </td>
  1489. </tr>
  1490. <tr>
  1491. <td>
  1492. <code>caBundle</code></br>
  1493. <em>
  1494. []byte
  1495. </em>
  1496. </td>
  1497. <td>
  1498. <em>(Optional)</em>
  1499. <p>PEM/base64 encoded CA bundle used to validate Akeyless Gateway certificate. Only used
  1500. if the AkeylessGWApiURL URL is using HTTPS protocol. If not set the system root certificates
  1501. are used to validate the TLS connection.</p>
  1502. </td>
  1503. </tr>
  1504. <tr>
  1505. <td>
  1506. <code>caProvider</code></br>
  1507. <em>
  1508. <a href="#external-secrets.io/v1beta1.CAProvider">
  1509. CAProvider
  1510. </a>
  1511. </em>
  1512. </td>
  1513. <td>
  1514. <em>(Optional)</em>
  1515. <p>The provider for the CA bundle to use to validate Akeyless Gateway certificate.</p>
  1516. </td>
  1517. </tr>
  1518. </tbody>
  1519. </table>
  1520. <h3 id="external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth
  1521. </h3>
  1522. <p>
  1523. (<em>Appears on:</em>
  1524. <a href="#external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider</a>)
  1525. </p>
  1526. <p>
  1527. <p>AlibabaAuth contains a secretRef for credentials.</p>
  1528. </p>
  1529. <table>
  1530. <thead>
  1531. <tr>
  1532. <th>Field</th>
  1533. <th>Description</th>
  1534. </tr>
  1535. </thead>
  1536. <tbody>
  1537. <tr>
  1538. <td>
  1539. <code>secretRef</code></br>
  1540. <em>
  1541. <a href="#external-secrets.io/v1beta1.AlibabaAuthSecretRef">
  1542. AlibabaAuthSecretRef
  1543. </a>
  1544. </em>
  1545. </td>
  1546. <td>
  1547. <em>(Optional)</em>
  1548. </td>
  1549. </tr>
  1550. <tr>
  1551. <td>
  1552. <code>rrsa</code></br>
  1553. <em>
  1554. <a href="#external-secrets.io/v1beta1.AlibabaRRSAAuth">
  1555. AlibabaRRSAAuth
  1556. </a>
  1557. </em>
  1558. </td>
  1559. <td>
  1560. <em>(Optional)</em>
  1561. </td>
  1562. </tr>
  1563. </tbody>
  1564. </table>
  1565. <h3 id="external-secrets.io/v1beta1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
  1566. </h3>
  1567. <p>
  1568. (<em>Appears on:</em>
  1569. <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
  1570. </p>
  1571. <p>
  1572. <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
  1573. </p>
  1574. <table>
  1575. <thead>
  1576. <tr>
  1577. <th>Field</th>
  1578. <th>Description</th>
  1579. </tr>
  1580. </thead>
  1581. <tbody>
  1582. <tr>
  1583. <td>
  1584. <code>accessKeyIDSecretRef</code></br>
  1585. <em>
  1586. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1587. External Secrets meta/v1.SecretKeySelector
  1588. </a>
  1589. </em>
  1590. </td>
  1591. <td>
  1592. <p>The AccessKeyID is used for authentication</p>
  1593. </td>
  1594. </tr>
  1595. <tr>
  1596. <td>
  1597. <code>accessKeySecretSecretRef</code></br>
  1598. <em>
  1599. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1600. External Secrets meta/v1.SecretKeySelector
  1601. </a>
  1602. </em>
  1603. </td>
  1604. <td>
  1605. <p>The AccessKeySecret is used for authentication</p>
  1606. </td>
  1607. </tr>
  1608. </tbody>
  1609. </table>
  1610. <h3 id="external-secrets.io/v1beta1.AlibabaProvider">AlibabaProvider
  1611. </h3>
  1612. <p>
  1613. (<em>Appears on:</em>
  1614. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1615. </p>
  1616. <p>
  1617. <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
  1618. </p>
  1619. <table>
  1620. <thead>
  1621. <tr>
  1622. <th>Field</th>
  1623. <th>Description</th>
  1624. </tr>
  1625. </thead>
  1626. <tbody>
  1627. <tr>
  1628. <td>
  1629. <code>auth</code></br>
  1630. <em>
  1631. <a href="#external-secrets.io/v1beta1.AlibabaAuth">
  1632. AlibabaAuth
  1633. </a>
  1634. </em>
  1635. </td>
  1636. <td>
  1637. </td>
  1638. </tr>
  1639. <tr>
  1640. <td>
  1641. <code>regionID</code></br>
  1642. <em>
  1643. string
  1644. </em>
  1645. </td>
  1646. <td>
  1647. <p>Alibaba Region to be used for the provider</p>
  1648. </td>
  1649. </tr>
  1650. </tbody>
  1651. </table>
  1652. <h3 id="external-secrets.io/v1beta1.AlibabaRRSAAuth">AlibabaRRSAAuth
  1653. </h3>
  1654. <p>
  1655. (<em>Appears on:</em>
  1656. <a href="#external-secrets.io/v1beta1.AlibabaAuth">AlibabaAuth</a>)
  1657. </p>
  1658. <p>
  1659. <p>Authenticate against Alibaba using RRSA.</p>
  1660. </p>
  1661. <table>
  1662. <thead>
  1663. <tr>
  1664. <th>Field</th>
  1665. <th>Description</th>
  1666. </tr>
  1667. </thead>
  1668. <tbody>
  1669. <tr>
  1670. <td>
  1671. <code>oidcProviderArn</code></br>
  1672. <em>
  1673. string
  1674. </em>
  1675. </td>
  1676. <td>
  1677. </td>
  1678. </tr>
  1679. <tr>
  1680. <td>
  1681. <code>oidcTokenFilePath</code></br>
  1682. <em>
  1683. string
  1684. </em>
  1685. </td>
  1686. <td>
  1687. </td>
  1688. </tr>
  1689. <tr>
  1690. <td>
  1691. <code>roleArn</code></br>
  1692. <em>
  1693. string
  1694. </em>
  1695. </td>
  1696. <td>
  1697. </td>
  1698. </tr>
  1699. <tr>
  1700. <td>
  1701. <code>sessionName</code></br>
  1702. <em>
  1703. string
  1704. </em>
  1705. </td>
  1706. <td>
  1707. </td>
  1708. </tr>
  1709. </tbody>
  1710. </table>
  1711. <h3 id="external-secrets.io/v1beta1.AzureAuthType">AzureAuthType
  1712. (<code>string</code> alias)</p></h3>
  1713. <p>
  1714. (<em>Appears on:</em>
  1715. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1716. </p>
  1717. <p>
  1718. <p>AuthType describes how to authenticate to the Azure Keyvault
  1719. Only one of the following auth types may be specified.
  1720. If none of the following auth type is specified, the default one
  1721. is ServicePrincipal.</p>
  1722. </p>
  1723. <table>
  1724. <thead>
  1725. <tr>
  1726. <th>Value</th>
  1727. <th>Description</th>
  1728. </tr>
  1729. </thead>
  1730. <tbody><tr><td><p>&#34;ManagedIdentity&#34;</p></td>
  1731. <td><p>Using Managed Identity to authenticate. Used with aad-pod-identity installed in the cluster.</p>
  1732. </td>
  1733. </tr><tr><td><p>&#34;ServicePrincipal&#34;</p></td>
  1734. <td><p>Using service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.</p>
  1735. </td>
  1736. </tr><tr><td><p>&#34;WorkloadIdentity&#34;</p></td>
  1737. <td><p>Using Workload Identity service accounts to authenticate.</p>
  1738. </td>
  1739. </tr></tbody>
  1740. </table>
  1741. <h3 id="external-secrets.io/v1beta1.AzureEnvironmentType">AzureEnvironmentType
  1742. (<code>string</code> alias)</p></h3>
  1743. <p>
  1744. (<em>Appears on:</em>
  1745. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1746. </p>
  1747. <p>
  1748. <p>AzureEnvironmentType specifies the Azure cloud environment endpoints to use for
  1749. connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
  1750. 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>
  1751. PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
  1752. </p>
  1753. <table>
  1754. <thead>
  1755. <tr>
  1756. <th>Value</th>
  1757. <th>Description</th>
  1758. </tr>
  1759. </thead>
  1760. <tbody><tr><td><p>&#34;ChinaCloud&#34;</p></td>
  1761. <td></td>
  1762. </tr><tr><td><p>&#34;GermanCloud&#34;</p></td>
  1763. <td></td>
  1764. </tr><tr><td><p>&#34;PublicCloud&#34;</p></td>
  1765. <td></td>
  1766. </tr><tr><td><p>&#34;USGovernmentCloud&#34;</p></td>
  1767. <td></td>
  1768. </tr></tbody>
  1769. </table>
  1770. <h3 id="external-secrets.io/v1beta1.AzureKVAuth">AzureKVAuth
  1771. </h3>
  1772. <p>
  1773. (<em>Appears on:</em>
  1774. <a href="#external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider</a>)
  1775. </p>
  1776. <p>
  1777. <p>Configuration used to authenticate with Azure.</p>
  1778. </p>
  1779. <table>
  1780. <thead>
  1781. <tr>
  1782. <th>Field</th>
  1783. <th>Description</th>
  1784. </tr>
  1785. </thead>
  1786. <tbody>
  1787. <tr>
  1788. <td>
  1789. <code>clientId</code></br>
  1790. <em>
  1791. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1792. External Secrets meta/v1.SecretKeySelector
  1793. </a>
  1794. </em>
  1795. </td>
  1796. <td>
  1797. <em>(Optional)</em>
  1798. <p>The Azure clientId of the service principle used for authentication.</p>
  1799. </td>
  1800. </tr>
  1801. <tr>
  1802. <td>
  1803. <code>clientSecret</code></br>
  1804. <em>
  1805. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  1806. External Secrets meta/v1.SecretKeySelector
  1807. </a>
  1808. </em>
  1809. </td>
  1810. <td>
  1811. <em>(Optional)</em>
  1812. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  1813. </td>
  1814. </tr>
  1815. </tbody>
  1816. </table>
  1817. <h3 id="external-secrets.io/v1beta1.AzureKVProvider">AzureKVProvider
  1818. </h3>
  1819. <p>
  1820. (<em>Appears on:</em>
  1821. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  1822. </p>
  1823. <p>
  1824. <p>Configures an store to sync secrets using Azure KV.</p>
  1825. </p>
  1826. <table>
  1827. <thead>
  1828. <tr>
  1829. <th>Field</th>
  1830. <th>Description</th>
  1831. </tr>
  1832. </thead>
  1833. <tbody>
  1834. <tr>
  1835. <td>
  1836. <code>authType</code></br>
  1837. <em>
  1838. <a href="#external-secrets.io/v1beta1.AzureAuthType">
  1839. AzureAuthType
  1840. </a>
  1841. </em>
  1842. </td>
  1843. <td>
  1844. <em>(Optional)</em>
  1845. <p>Auth type defines how to authenticate to the keyvault service.
  1846. Valid values are:
  1847. - &ldquo;ServicePrincipal&rdquo; (default): Using a service principal (tenantId, clientId, clientSecret)
  1848. - &ldquo;ManagedIdentity&rdquo;: Using Managed Identity assigned to the pod (see aad-pod-identity)</p>
  1849. </td>
  1850. </tr>
  1851. <tr>
  1852. <td>
  1853. <code>vaultUrl</code></br>
  1854. <em>
  1855. string
  1856. </em>
  1857. </td>
  1858. <td>
  1859. <p>Vault Url from which the secrets to be fetched from.</p>
  1860. </td>
  1861. </tr>
  1862. <tr>
  1863. <td>
  1864. <code>tenantId</code></br>
  1865. <em>
  1866. string
  1867. </em>
  1868. </td>
  1869. <td>
  1870. <em>(Optional)</em>
  1871. <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type.</p>
  1872. </td>
  1873. </tr>
  1874. <tr>
  1875. <td>
  1876. <code>environmentType</code></br>
  1877. <em>
  1878. <a href="#external-secrets.io/v1beta1.AzureEnvironmentType">
  1879. AzureEnvironmentType
  1880. </a>
  1881. </em>
  1882. </td>
  1883. <td>
  1884. <p>EnvironmentType specifies the Azure cloud environment endpoints to use for
  1885. connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint.
  1886. 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>
  1887. PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud</p>
  1888. </td>
  1889. </tr>
  1890. <tr>
  1891. <td>
  1892. <code>authSecretRef</code></br>
  1893. <em>
  1894. <a href="#external-secrets.io/v1beta1.AzureKVAuth">
  1895. AzureKVAuth
  1896. </a>
  1897. </em>
  1898. </td>
  1899. <td>
  1900. <em>(Optional)</em>
  1901. <p>Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type.</p>
  1902. </td>
  1903. </tr>
  1904. <tr>
  1905. <td>
  1906. <code>serviceAccountRef</code></br>
  1907. <em>
  1908. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  1909. External Secrets meta/v1.ServiceAccountSelector
  1910. </a>
  1911. </em>
  1912. </td>
  1913. <td>
  1914. <em>(Optional)</em>
  1915. <p>ServiceAccountRef specified the service account
  1916. that should be used when authenticating with WorkloadIdentity.</p>
  1917. </td>
  1918. </tr>
  1919. <tr>
  1920. <td>
  1921. <code>identityId</code></br>
  1922. <em>
  1923. string
  1924. </em>
  1925. </td>
  1926. <td>
  1927. <em>(Optional)</em>
  1928. <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
  1929. </td>
  1930. </tr>
  1931. </tbody>
  1932. </table>
  1933. <h3 id="external-secrets.io/v1beta1.CAProvider">CAProvider
  1934. </h3>
  1935. <p>
  1936. (<em>Appears on:</em>
  1937. <a href="#external-secrets.io/v1beta1.AkeylessProvider">AkeylessProvider</a>,
  1938. <a href="#external-secrets.io/v1beta1.ConjurProvider">ConjurProvider</a>,
  1939. <a href="#external-secrets.io/v1beta1.KubernetesServer">KubernetesServer</a>,
  1940. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  1941. </p>
  1942. <p>
  1943. <p>Used to provide custom certificate authority (CA) certificates
  1944. for a secret store. The CAProvider points to a Secret or ConfigMap resource
  1945. that contains a PEM-encoded certificate.</p>
  1946. </p>
  1947. <table>
  1948. <thead>
  1949. <tr>
  1950. <th>Field</th>
  1951. <th>Description</th>
  1952. </tr>
  1953. </thead>
  1954. <tbody>
  1955. <tr>
  1956. <td>
  1957. <code>type</code></br>
  1958. <em>
  1959. <a href="#external-secrets.io/v1beta1.CAProviderType">
  1960. CAProviderType
  1961. </a>
  1962. </em>
  1963. </td>
  1964. <td>
  1965. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  1966. </td>
  1967. </tr>
  1968. <tr>
  1969. <td>
  1970. <code>name</code></br>
  1971. <em>
  1972. string
  1973. </em>
  1974. </td>
  1975. <td>
  1976. <p>The name of the object located at the provider type.</p>
  1977. </td>
  1978. </tr>
  1979. <tr>
  1980. <td>
  1981. <code>key</code></br>
  1982. <em>
  1983. string
  1984. </em>
  1985. </td>
  1986. <td>
  1987. <p>The key where the CA certificate can be found in the Secret or ConfigMap.</p>
  1988. </td>
  1989. </tr>
  1990. <tr>
  1991. <td>
  1992. <code>namespace</code></br>
  1993. <em>
  1994. string
  1995. </em>
  1996. </td>
  1997. <td>
  1998. <em>(Optional)</em>
  1999. <p>The namespace the Provider type is in.
  2000. Can only be defined when used in a ClusterSecretStore.</p>
  2001. </td>
  2002. </tr>
  2003. </tbody>
  2004. </table>
  2005. <h3 id="external-secrets.io/v1beta1.CAProviderType">CAProviderType
  2006. (<code>string</code> alias)</p></h3>
  2007. <p>
  2008. (<em>Appears on:</em>
  2009. <a href="#external-secrets.io/v1beta1.CAProvider">CAProvider</a>)
  2010. </p>
  2011. <p>
  2012. </p>
  2013. <table>
  2014. <thead>
  2015. <tr>
  2016. <th>Value</th>
  2017. <th>Description</th>
  2018. </tr>
  2019. </thead>
  2020. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  2021. <td></td>
  2022. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  2023. <td></td>
  2024. </tr></tbody>
  2025. </table>
  2026. <h3 id="external-secrets.io/v1beta1.CertAuth">CertAuth
  2027. </h3>
  2028. <p>
  2029. (<em>Appears on:</em>
  2030. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  2031. </p>
  2032. <p>
  2033. </p>
  2034. <table>
  2035. <thead>
  2036. <tr>
  2037. <th>Field</th>
  2038. <th>Description</th>
  2039. </tr>
  2040. </thead>
  2041. <tbody>
  2042. <tr>
  2043. <td>
  2044. <code>clientCert</code></br>
  2045. <em>
  2046. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2047. External Secrets meta/v1.SecretKeySelector
  2048. </a>
  2049. </em>
  2050. </td>
  2051. <td>
  2052. </td>
  2053. </tr>
  2054. <tr>
  2055. <td>
  2056. <code>clientKey</code></br>
  2057. <em>
  2058. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2059. External Secrets meta/v1.SecretKeySelector
  2060. </a>
  2061. </em>
  2062. </td>
  2063. <td>
  2064. </td>
  2065. </tr>
  2066. </tbody>
  2067. </table>
  2068. <h3 id="external-secrets.io/v1beta1.ChefAuth">ChefAuth
  2069. </h3>
  2070. <p>
  2071. (<em>Appears on:</em>
  2072. <a href="#external-secrets.io/v1beta1.ChefProvider">ChefProvider</a>)
  2073. </p>
  2074. <p>
  2075. <p>ChefAuth contains a secretRef for credentials.</p>
  2076. </p>
  2077. <table>
  2078. <thead>
  2079. <tr>
  2080. <th>Field</th>
  2081. <th>Description</th>
  2082. </tr>
  2083. </thead>
  2084. <tbody>
  2085. <tr>
  2086. <td>
  2087. <code>secretRef</code></br>
  2088. <em>
  2089. <a href="#external-secrets.io/v1beta1.ChefAuthSecretRef">
  2090. ChefAuthSecretRef
  2091. </a>
  2092. </em>
  2093. </td>
  2094. <td>
  2095. </td>
  2096. </tr>
  2097. </tbody>
  2098. </table>
  2099. <h3 id="external-secrets.io/v1beta1.ChefAuthSecretRef">ChefAuthSecretRef
  2100. </h3>
  2101. <p>
  2102. (<em>Appears on:</em>
  2103. <a href="#external-secrets.io/v1beta1.ChefAuth">ChefAuth</a>)
  2104. </p>
  2105. <p>
  2106. <p>ChefAuthSecretRef holds secret references for chef server login credentials.</p>
  2107. </p>
  2108. <table>
  2109. <thead>
  2110. <tr>
  2111. <th>Field</th>
  2112. <th>Description</th>
  2113. </tr>
  2114. </thead>
  2115. <tbody>
  2116. <tr>
  2117. <td>
  2118. <code>privateKeySecretRef</code></br>
  2119. <em>
  2120. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2121. External Secrets meta/v1.SecretKeySelector
  2122. </a>
  2123. </em>
  2124. </td>
  2125. <td>
  2126. <p>SecretKey is the Signing Key in PEM format, used for authentication.</p>
  2127. </td>
  2128. </tr>
  2129. </tbody>
  2130. </table>
  2131. <h3 id="external-secrets.io/v1beta1.ChefProvider">ChefProvider
  2132. </h3>
  2133. <p>
  2134. (<em>Appears on:</em>
  2135. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2136. </p>
  2137. <p>
  2138. <p>ChefProvider configures a store to sync secrets using basic chef server connection credentials.</p>
  2139. </p>
  2140. <table>
  2141. <thead>
  2142. <tr>
  2143. <th>Field</th>
  2144. <th>Description</th>
  2145. </tr>
  2146. </thead>
  2147. <tbody>
  2148. <tr>
  2149. <td>
  2150. <code>auth</code></br>
  2151. <em>
  2152. <a href="#external-secrets.io/v1beta1.ChefAuth">
  2153. ChefAuth
  2154. </a>
  2155. </em>
  2156. </td>
  2157. <td>
  2158. <p>Auth defines the information necessary to authenticate against chef Server</p>
  2159. </td>
  2160. </tr>
  2161. <tr>
  2162. <td>
  2163. <code>username</code></br>
  2164. <em>
  2165. string
  2166. </em>
  2167. </td>
  2168. <td>
  2169. <p>UserName should be the user ID on the chef server</p>
  2170. </td>
  2171. </tr>
  2172. <tr>
  2173. <td>
  2174. <code>serverUrl</code></br>
  2175. <em>
  2176. string
  2177. </em>
  2178. </td>
  2179. <td>
  2180. <p>ServerURL is the chef server URL used to connect to. If using orgs you should include your org in the url and terminate the url with a &ldquo;/&rdquo;</p>
  2181. </td>
  2182. </tr>
  2183. </tbody>
  2184. </table>
  2185. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret
  2186. </h3>
  2187. <p>
  2188. <p>ClusterExternalSecret is the Schema for the clusterexternalsecrets API.</p>
  2189. </p>
  2190. <table>
  2191. <thead>
  2192. <tr>
  2193. <th>Field</th>
  2194. <th>Description</th>
  2195. </tr>
  2196. </thead>
  2197. <tbody>
  2198. <tr>
  2199. <td>
  2200. <code>metadata</code></br>
  2201. <em>
  2202. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  2203. Kubernetes meta/v1.ObjectMeta
  2204. </a>
  2205. </em>
  2206. </td>
  2207. <td>
  2208. Refer to the Kubernetes API documentation for the fields of the
  2209. <code>metadata</code> field.
  2210. </td>
  2211. </tr>
  2212. <tr>
  2213. <td>
  2214. <code>spec</code></br>
  2215. <em>
  2216. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">
  2217. ClusterExternalSecretSpec
  2218. </a>
  2219. </em>
  2220. </td>
  2221. <td>
  2222. <br/>
  2223. <br/>
  2224. <table>
  2225. <tr>
  2226. <td>
  2227. <code>externalSecretSpec</code></br>
  2228. <em>
  2229. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  2230. ExternalSecretSpec
  2231. </a>
  2232. </em>
  2233. </td>
  2234. <td>
  2235. <p>The spec for the ExternalSecrets to be created</p>
  2236. </td>
  2237. </tr>
  2238. <tr>
  2239. <td>
  2240. <code>externalSecretName</code></br>
  2241. <em>
  2242. string
  2243. </em>
  2244. </td>
  2245. <td>
  2246. <em>(Optional)</em>
  2247. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  2248. </td>
  2249. </tr>
  2250. <tr>
  2251. <td>
  2252. <code>externalSecretMetadata</code></br>
  2253. <em>
  2254. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadata">
  2255. ExternalSecretMetadata
  2256. </a>
  2257. </em>
  2258. </td>
  2259. <td>
  2260. <em>(Optional)</em>
  2261. <p>The metadata of the external secrets to be created</p>
  2262. </td>
  2263. </tr>
  2264. <tr>
  2265. <td>
  2266. <code>namespaceSelector</code></br>
  2267. <em>
  2268. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  2269. Kubernetes meta/v1.LabelSelector
  2270. </a>
  2271. </em>
  2272. </td>
  2273. <td>
  2274. <em>(Optional)</em>
  2275. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
  2276. </td>
  2277. </tr>
  2278. <tr>
  2279. <td>
  2280. <code>namespaces</code></br>
  2281. <em>
  2282. []string
  2283. </em>
  2284. </td>
  2285. <td>
  2286. <em>(Optional)</em>
  2287. <p>Choose namespaces by name. This field is ORed with anything that NamespaceSelector ends up choosing.</p>
  2288. </td>
  2289. </tr>
  2290. <tr>
  2291. <td>
  2292. <code>refreshTime</code></br>
  2293. <em>
  2294. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  2295. Kubernetes meta/v1.Duration
  2296. </a>
  2297. </em>
  2298. </td>
  2299. <td>
  2300. <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
  2301. </td>
  2302. </tr>
  2303. </table>
  2304. </td>
  2305. </tr>
  2306. <tr>
  2307. <td>
  2308. <code>status</code></br>
  2309. <em>
  2310. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">
  2311. ClusterExternalSecretStatus
  2312. </a>
  2313. </em>
  2314. </td>
  2315. <td>
  2316. </td>
  2317. </tr>
  2318. </tbody>
  2319. </table>
  2320. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretConditionType">ClusterExternalSecretConditionType
  2321. (<code>string</code> alias)</p></h3>
  2322. <p>
  2323. (<em>Appears on:</em>
  2324. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition</a>)
  2325. </p>
  2326. <p>
  2327. </p>
  2328. <table>
  2329. <thead>
  2330. <tr>
  2331. <th>Value</th>
  2332. <th>Description</th>
  2333. </tr>
  2334. </thead>
  2335. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  2336. <td></td>
  2337. </tr></tbody>
  2338. </table>
  2339. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">ClusterExternalSecretNamespaceFailure
  2340. </h3>
  2341. <p>
  2342. (<em>Appears on:</em>
  2343. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  2344. </p>
  2345. <p>
  2346. <p>ClusterExternalSecretNamespaceFailure represents a failed namespace deployment and it&rsquo;s reason.</p>
  2347. </p>
  2348. <table>
  2349. <thead>
  2350. <tr>
  2351. <th>Field</th>
  2352. <th>Description</th>
  2353. </tr>
  2354. </thead>
  2355. <tbody>
  2356. <tr>
  2357. <td>
  2358. <code>namespace</code></br>
  2359. <em>
  2360. string
  2361. </em>
  2362. </td>
  2363. <td>
  2364. <p>Namespace is the namespace that failed when trying to apply an ExternalSecret</p>
  2365. </td>
  2366. </tr>
  2367. <tr>
  2368. <td>
  2369. <code>reason</code></br>
  2370. <em>
  2371. string
  2372. </em>
  2373. </td>
  2374. <td>
  2375. <em>(Optional)</em>
  2376. <p>Reason is why the ExternalSecret failed to apply to the namespace</p>
  2377. </td>
  2378. </tr>
  2379. </tbody>
  2380. </table>
  2381. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec
  2382. </h3>
  2383. <p>
  2384. (<em>Appears on:</em>
  2385. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  2386. </p>
  2387. <p>
  2388. <p>ClusterExternalSecretSpec defines the desired state of ClusterExternalSecret.</p>
  2389. </p>
  2390. <table>
  2391. <thead>
  2392. <tr>
  2393. <th>Field</th>
  2394. <th>Description</th>
  2395. </tr>
  2396. </thead>
  2397. <tbody>
  2398. <tr>
  2399. <td>
  2400. <code>externalSecretSpec</code></br>
  2401. <em>
  2402. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  2403. ExternalSecretSpec
  2404. </a>
  2405. </em>
  2406. </td>
  2407. <td>
  2408. <p>The spec for the ExternalSecrets to be created</p>
  2409. </td>
  2410. </tr>
  2411. <tr>
  2412. <td>
  2413. <code>externalSecretName</code></br>
  2414. <em>
  2415. string
  2416. </em>
  2417. </td>
  2418. <td>
  2419. <em>(Optional)</em>
  2420. <p>The name of the external secrets to be created defaults to the name of the ClusterExternalSecret</p>
  2421. </td>
  2422. </tr>
  2423. <tr>
  2424. <td>
  2425. <code>externalSecretMetadata</code></br>
  2426. <em>
  2427. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadata">
  2428. ExternalSecretMetadata
  2429. </a>
  2430. </em>
  2431. </td>
  2432. <td>
  2433. <em>(Optional)</em>
  2434. <p>The metadata of the external secrets to be created</p>
  2435. </td>
  2436. </tr>
  2437. <tr>
  2438. <td>
  2439. <code>namespaceSelector</code></br>
  2440. <em>
  2441. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  2442. Kubernetes meta/v1.LabelSelector
  2443. </a>
  2444. </em>
  2445. </td>
  2446. <td>
  2447. <em>(Optional)</em>
  2448. <p>The labels to select by to find the Namespaces to create the ExternalSecrets in.</p>
  2449. </td>
  2450. </tr>
  2451. <tr>
  2452. <td>
  2453. <code>namespaces</code></br>
  2454. <em>
  2455. []string
  2456. </em>
  2457. </td>
  2458. <td>
  2459. <em>(Optional)</em>
  2460. <p>Choose namespaces by name. This field is ORed with anything that NamespaceSelector ends up choosing.</p>
  2461. </td>
  2462. </tr>
  2463. <tr>
  2464. <td>
  2465. <code>refreshTime</code></br>
  2466. <em>
  2467. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  2468. Kubernetes meta/v1.Duration
  2469. </a>
  2470. </em>
  2471. </td>
  2472. <td>
  2473. <p>The time in which the controller should reconcile its objects and recheck namespaces for labels.</p>
  2474. </td>
  2475. </tr>
  2476. </tbody>
  2477. </table>
  2478. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus
  2479. </h3>
  2480. <p>
  2481. (<em>Appears on:</em>
  2482. <a href="#external-secrets.io/v1beta1.ClusterExternalSecret">ClusterExternalSecret</a>)
  2483. </p>
  2484. <p>
  2485. <p>ClusterExternalSecretStatus defines the observed state of ClusterExternalSecret.</p>
  2486. </p>
  2487. <table>
  2488. <thead>
  2489. <tr>
  2490. <th>Field</th>
  2491. <th>Description</th>
  2492. </tr>
  2493. </thead>
  2494. <tbody>
  2495. <tr>
  2496. <td>
  2497. <code>externalSecretName</code></br>
  2498. <em>
  2499. string
  2500. </em>
  2501. </td>
  2502. <td>
  2503. <p>ExternalSecretName is the name of the ExternalSecrets created by the ClusterExternalSecret</p>
  2504. </td>
  2505. </tr>
  2506. <tr>
  2507. <td>
  2508. <code>failedNamespaces</code></br>
  2509. <em>
  2510. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretNamespaceFailure">
  2511. []ClusterExternalSecretNamespaceFailure
  2512. </a>
  2513. </em>
  2514. </td>
  2515. <td>
  2516. <em>(Optional)</em>
  2517. <p>Failed namespaces are the namespaces that failed to apply an ExternalSecret</p>
  2518. </td>
  2519. </tr>
  2520. <tr>
  2521. <td>
  2522. <code>provisionedNamespaces</code></br>
  2523. <em>
  2524. []string
  2525. </em>
  2526. </td>
  2527. <td>
  2528. <em>(Optional)</em>
  2529. <p>ProvisionedNamespaces are the namespaces where the ClusterExternalSecret has secrets</p>
  2530. </td>
  2531. </tr>
  2532. <tr>
  2533. <td>
  2534. <code>conditions</code></br>
  2535. <em>
  2536. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">
  2537. []ClusterExternalSecretStatusCondition
  2538. </a>
  2539. </em>
  2540. </td>
  2541. <td>
  2542. <em>(Optional)</em>
  2543. </td>
  2544. </tr>
  2545. </tbody>
  2546. </table>
  2547. <h3 id="external-secrets.io/v1beta1.ClusterExternalSecretStatusCondition">ClusterExternalSecretStatusCondition
  2548. </h3>
  2549. <p>
  2550. (<em>Appears on:</em>
  2551. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretStatus">ClusterExternalSecretStatus</a>)
  2552. </p>
  2553. <p>
  2554. </p>
  2555. <table>
  2556. <thead>
  2557. <tr>
  2558. <th>Field</th>
  2559. <th>Description</th>
  2560. </tr>
  2561. </thead>
  2562. <tbody>
  2563. <tr>
  2564. <td>
  2565. <code>type</code></br>
  2566. <em>
  2567. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretConditionType">
  2568. ClusterExternalSecretConditionType
  2569. </a>
  2570. </em>
  2571. </td>
  2572. <td>
  2573. </td>
  2574. </tr>
  2575. <tr>
  2576. <td>
  2577. <code>status</code></br>
  2578. <em>
  2579. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  2580. Kubernetes core/v1.ConditionStatus
  2581. </a>
  2582. </em>
  2583. </td>
  2584. <td>
  2585. </td>
  2586. </tr>
  2587. <tr>
  2588. <td>
  2589. <code>message</code></br>
  2590. <em>
  2591. string
  2592. </em>
  2593. </td>
  2594. <td>
  2595. <em>(Optional)</em>
  2596. </td>
  2597. </tr>
  2598. </tbody>
  2599. </table>
  2600. <h3 id="external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore
  2601. </h3>
  2602. <p>
  2603. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  2604. </p>
  2605. <table>
  2606. <thead>
  2607. <tr>
  2608. <th>Field</th>
  2609. <th>Description</th>
  2610. </tr>
  2611. </thead>
  2612. <tbody>
  2613. <tr>
  2614. <td>
  2615. <code>metadata</code></br>
  2616. <em>
  2617. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  2618. Kubernetes meta/v1.ObjectMeta
  2619. </a>
  2620. </em>
  2621. </td>
  2622. <td>
  2623. Refer to the Kubernetes API documentation for the fields of the
  2624. <code>metadata</code> field.
  2625. </td>
  2626. </tr>
  2627. <tr>
  2628. <td>
  2629. <code>spec</code></br>
  2630. <em>
  2631. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  2632. SecretStoreSpec
  2633. </a>
  2634. </em>
  2635. </td>
  2636. <td>
  2637. <br/>
  2638. <br/>
  2639. <table>
  2640. <tr>
  2641. <td>
  2642. <code>controller</code></br>
  2643. <em>
  2644. string
  2645. </em>
  2646. </td>
  2647. <td>
  2648. <em>(Optional)</em>
  2649. <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
  2650. The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
  2651. </td>
  2652. </tr>
  2653. <tr>
  2654. <td>
  2655. <code>provider</code></br>
  2656. <em>
  2657. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  2658. SecretStoreProvider
  2659. </a>
  2660. </em>
  2661. </td>
  2662. <td>
  2663. <p>Used to configure the provider. Only one provider may be set</p>
  2664. </td>
  2665. </tr>
  2666. <tr>
  2667. <td>
  2668. <code>retrySettings</code></br>
  2669. <em>
  2670. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  2671. SecretStoreRetrySettings
  2672. </a>
  2673. </em>
  2674. </td>
  2675. <td>
  2676. <em>(Optional)</em>
  2677. <p>Used to configure http retries if failed</p>
  2678. </td>
  2679. </tr>
  2680. <tr>
  2681. <td>
  2682. <code>refreshInterval</code></br>
  2683. <em>
  2684. int
  2685. </em>
  2686. </td>
  2687. <td>
  2688. <em>(Optional)</em>
  2689. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  2690. </td>
  2691. </tr>
  2692. <tr>
  2693. <td>
  2694. <code>conditions</code></br>
  2695. <em>
  2696. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  2697. []ClusterSecretStoreCondition
  2698. </a>
  2699. </em>
  2700. </td>
  2701. <td>
  2702. <em>(Optional)</em>
  2703. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  2704. </td>
  2705. </tr>
  2706. </table>
  2707. </td>
  2708. </tr>
  2709. <tr>
  2710. <td>
  2711. <code>status</code></br>
  2712. <em>
  2713. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  2714. SecretStoreStatus
  2715. </a>
  2716. </em>
  2717. </td>
  2718. <td>
  2719. </td>
  2720. </tr>
  2721. </tbody>
  2722. </table>
  2723. <h3 id="external-secrets.io/v1beta1.ClusterSecretStoreCondition">ClusterSecretStoreCondition
  2724. </h3>
  2725. <p>
  2726. (<em>Appears on:</em>
  2727. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  2728. </p>
  2729. <p>
  2730. <p>ClusterSecretStoreCondition describes a condition by which to choose namespaces to process ExternalSecrets in
  2731. for a ClusterSecretStore instance.</p>
  2732. </p>
  2733. <table>
  2734. <thead>
  2735. <tr>
  2736. <th>Field</th>
  2737. <th>Description</th>
  2738. </tr>
  2739. </thead>
  2740. <tbody>
  2741. <tr>
  2742. <td>
  2743. <code>namespaceSelector</code></br>
  2744. <em>
  2745. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
  2746. Kubernetes meta/v1.LabelSelector
  2747. </a>
  2748. </em>
  2749. </td>
  2750. <td>
  2751. <em>(Optional)</em>
  2752. <p>Choose namespace using a labelSelector</p>
  2753. </td>
  2754. </tr>
  2755. <tr>
  2756. <td>
  2757. <code>namespaces</code></br>
  2758. <em>
  2759. []string
  2760. </em>
  2761. </td>
  2762. <td>
  2763. <p>Choose namespaces by name</p>
  2764. </td>
  2765. </tr>
  2766. </tbody>
  2767. </table>
  2768. <h3 id="external-secrets.io/v1beta1.ConjurAPIKey">ConjurAPIKey
  2769. </h3>
  2770. <p>
  2771. (<em>Appears on:</em>
  2772. <a href="#external-secrets.io/v1beta1.ConjurAuth">ConjurAuth</a>)
  2773. </p>
  2774. <p>
  2775. </p>
  2776. <table>
  2777. <thead>
  2778. <tr>
  2779. <th>Field</th>
  2780. <th>Description</th>
  2781. </tr>
  2782. </thead>
  2783. <tbody>
  2784. <tr>
  2785. <td>
  2786. <code>account</code></br>
  2787. <em>
  2788. string
  2789. </em>
  2790. </td>
  2791. <td>
  2792. </td>
  2793. </tr>
  2794. <tr>
  2795. <td>
  2796. <code>userRef</code></br>
  2797. <em>
  2798. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2799. External Secrets meta/v1.SecretKeySelector
  2800. </a>
  2801. </em>
  2802. </td>
  2803. <td>
  2804. </td>
  2805. </tr>
  2806. <tr>
  2807. <td>
  2808. <code>apiKeyRef</code></br>
  2809. <em>
  2810. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2811. External Secrets meta/v1.SecretKeySelector
  2812. </a>
  2813. </em>
  2814. </td>
  2815. <td>
  2816. </td>
  2817. </tr>
  2818. </tbody>
  2819. </table>
  2820. <h3 id="external-secrets.io/v1beta1.ConjurAuth">ConjurAuth
  2821. </h3>
  2822. <p>
  2823. (<em>Appears on:</em>
  2824. <a href="#external-secrets.io/v1beta1.ConjurProvider">ConjurProvider</a>)
  2825. </p>
  2826. <p>
  2827. </p>
  2828. <table>
  2829. <thead>
  2830. <tr>
  2831. <th>Field</th>
  2832. <th>Description</th>
  2833. </tr>
  2834. </thead>
  2835. <tbody>
  2836. <tr>
  2837. <td>
  2838. <code>apikey</code></br>
  2839. <em>
  2840. <a href="#external-secrets.io/v1beta1.ConjurAPIKey">
  2841. ConjurAPIKey
  2842. </a>
  2843. </em>
  2844. </td>
  2845. <td>
  2846. <em>(Optional)</em>
  2847. </td>
  2848. </tr>
  2849. <tr>
  2850. <td>
  2851. <code>jwt</code></br>
  2852. <em>
  2853. <a href="#external-secrets.io/v1beta1.ConjurJWT">
  2854. ConjurJWT
  2855. </a>
  2856. </em>
  2857. </td>
  2858. <td>
  2859. <em>(Optional)</em>
  2860. </td>
  2861. </tr>
  2862. </tbody>
  2863. </table>
  2864. <h3 id="external-secrets.io/v1beta1.ConjurJWT">ConjurJWT
  2865. </h3>
  2866. <p>
  2867. (<em>Appears on:</em>
  2868. <a href="#external-secrets.io/v1beta1.ConjurAuth">ConjurAuth</a>)
  2869. </p>
  2870. <p>
  2871. </p>
  2872. <table>
  2873. <thead>
  2874. <tr>
  2875. <th>Field</th>
  2876. <th>Description</th>
  2877. </tr>
  2878. </thead>
  2879. <tbody>
  2880. <tr>
  2881. <td>
  2882. <code>account</code></br>
  2883. <em>
  2884. string
  2885. </em>
  2886. </td>
  2887. <td>
  2888. </td>
  2889. </tr>
  2890. <tr>
  2891. <td>
  2892. <code>serviceID</code></br>
  2893. <em>
  2894. string
  2895. </em>
  2896. </td>
  2897. <td>
  2898. <p>The conjur authn jwt webservice id</p>
  2899. </td>
  2900. </tr>
  2901. <tr>
  2902. <td>
  2903. <code>secretRef</code></br>
  2904. <em>
  2905. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  2906. External Secrets meta/v1.SecretKeySelector
  2907. </a>
  2908. </em>
  2909. </td>
  2910. <td>
  2911. <em>(Optional)</em>
  2912. <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  2913. authenticate with Conjur using the JWT authentication method.</p>
  2914. </td>
  2915. </tr>
  2916. <tr>
  2917. <td>
  2918. <code>serviceAccountRef</code></br>
  2919. <em>
  2920. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  2921. External Secrets meta/v1.ServiceAccountSelector
  2922. </a>
  2923. </em>
  2924. </td>
  2925. <td>
  2926. <em>(Optional)</em>
  2927. <p>Optional ServiceAccountRef specifies the Kubernetes service account for which to request
  2928. a token for with the <code>TokenRequest</code> API.</p>
  2929. </td>
  2930. </tr>
  2931. </tbody>
  2932. </table>
  2933. <h3 id="external-secrets.io/v1beta1.ConjurProvider">ConjurProvider
  2934. </h3>
  2935. <p>
  2936. (<em>Appears on:</em>
  2937. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  2938. </p>
  2939. <p>
  2940. </p>
  2941. <table>
  2942. <thead>
  2943. <tr>
  2944. <th>Field</th>
  2945. <th>Description</th>
  2946. </tr>
  2947. </thead>
  2948. <tbody>
  2949. <tr>
  2950. <td>
  2951. <code>url</code></br>
  2952. <em>
  2953. string
  2954. </em>
  2955. </td>
  2956. <td>
  2957. </td>
  2958. </tr>
  2959. <tr>
  2960. <td>
  2961. <code>caBundle</code></br>
  2962. <em>
  2963. string
  2964. </em>
  2965. </td>
  2966. <td>
  2967. <em>(Optional)</em>
  2968. </td>
  2969. </tr>
  2970. <tr>
  2971. <td>
  2972. <code>caProvider</code></br>
  2973. <em>
  2974. <a href="#external-secrets.io/v1beta1.CAProvider">
  2975. CAProvider
  2976. </a>
  2977. </em>
  2978. </td>
  2979. <td>
  2980. <em>(Optional)</em>
  2981. </td>
  2982. </tr>
  2983. <tr>
  2984. <td>
  2985. <code>auth</code></br>
  2986. <em>
  2987. <a href="#external-secrets.io/v1beta1.ConjurAuth">
  2988. ConjurAuth
  2989. </a>
  2990. </em>
  2991. </td>
  2992. <td>
  2993. </td>
  2994. </tr>
  2995. </tbody>
  2996. </table>
  2997. <h3 id="external-secrets.io/v1beta1.DelineaProvider">DelineaProvider
  2998. </h3>
  2999. <p>
  3000. (<em>Appears on:</em>
  3001. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3002. </p>
  3003. <p>
  3004. <p>See <a href="https://github.com/DelineaXPM/dsv-sdk-go/blob/main/vault/vault.go">https://github.com/DelineaXPM/dsv-sdk-go/blob/main/vault/vault.go</a>.</p>
  3005. </p>
  3006. <table>
  3007. <thead>
  3008. <tr>
  3009. <th>Field</th>
  3010. <th>Description</th>
  3011. </tr>
  3012. </thead>
  3013. <tbody>
  3014. <tr>
  3015. <td>
  3016. <code>clientId</code></br>
  3017. <em>
  3018. <a href="#external-secrets.io/v1beta1.DelineaProviderSecretRef">
  3019. DelineaProviderSecretRef
  3020. </a>
  3021. </em>
  3022. </td>
  3023. <td>
  3024. <p>ClientID is the non-secret part of the credential.</p>
  3025. </td>
  3026. </tr>
  3027. <tr>
  3028. <td>
  3029. <code>clientSecret</code></br>
  3030. <em>
  3031. <a href="#external-secrets.io/v1beta1.DelineaProviderSecretRef">
  3032. DelineaProviderSecretRef
  3033. </a>
  3034. </em>
  3035. </td>
  3036. <td>
  3037. <p>ClientSecret is the secret part of the credential.</p>
  3038. </td>
  3039. </tr>
  3040. <tr>
  3041. <td>
  3042. <code>tenant</code></br>
  3043. <em>
  3044. string
  3045. </em>
  3046. </td>
  3047. <td>
  3048. <p>Tenant is the chosen hostname / site name.</p>
  3049. </td>
  3050. </tr>
  3051. <tr>
  3052. <td>
  3053. <code>urlTemplate</code></br>
  3054. <em>
  3055. string
  3056. </em>
  3057. </td>
  3058. <td>
  3059. <em>(Optional)</em>
  3060. <p>URLTemplate
  3061. If unset, defaults to &ldquo;https://%s.secretsvaultcloud.%s/v1/%s%s&rdquo;.</p>
  3062. </td>
  3063. </tr>
  3064. <tr>
  3065. <td>
  3066. <code>tld</code></br>
  3067. <em>
  3068. string
  3069. </em>
  3070. </td>
  3071. <td>
  3072. <em>(Optional)</em>
  3073. <p>TLD is based on the server location that was chosen during provisioning.
  3074. If unset, defaults to &ldquo;com&rdquo;.</p>
  3075. </td>
  3076. </tr>
  3077. </tbody>
  3078. </table>
  3079. <h3 id="external-secrets.io/v1beta1.DelineaProviderSecretRef">DelineaProviderSecretRef
  3080. </h3>
  3081. <p>
  3082. (<em>Appears on:</em>
  3083. <a href="#external-secrets.io/v1beta1.DelineaProvider">DelineaProvider</a>)
  3084. </p>
  3085. <p>
  3086. </p>
  3087. <table>
  3088. <thead>
  3089. <tr>
  3090. <th>Field</th>
  3091. <th>Description</th>
  3092. </tr>
  3093. </thead>
  3094. <tbody>
  3095. <tr>
  3096. <td>
  3097. <code>value</code></br>
  3098. <em>
  3099. string
  3100. </em>
  3101. </td>
  3102. <td>
  3103. <em>(Optional)</em>
  3104. <p>Value can be specified directly to set a value without using a secret.</p>
  3105. </td>
  3106. </tr>
  3107. <tr>
  3108. <td>
  3109. <code>secretRef</code></br>
  3110. <em>
  3111. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3112. External Secrets meta/v1.SecretKeySelector
  3113. </a>
  3114. </em>
  3115. </td>
  3116. <td>
  3117. <em>(Optional)</em>
  3118. <p>SecretRef references a key in a secret that will be used as value.</p>
  3119. </td>
  3120. </tr>
  3121. </tbody>
  3122. </table>
  3123. <h3 id="external-secrets.io/v1beta1.DopplerAuth">DopplerAuth
  3124. </h3>
  3125. <p>
  3126. (<em>Appears on:</em>
  3127. <a href="#external-secrets.io/v1beta1.DopplerProvider">DopplerProvider</a>)
  3128. </p>
  3129. <p>
  3130. </p>
  3131. <table>
  3132. <thead>
  3133. <tr>
  3134. <th>Field</th>
  3135. <th>Description</th>
  3136. </tr>
  3137. </thead>
  3138. <tbody>
  3139. <tr>
  3140. <td>
  3141. <code>secretRef</code></br>
  3142. <em>
  3143. <a href="#external-secrets.io/v1beta1.DopplerAuthSecretRef">
  3144. DopplerAuthSecretRef
  3145. </a>
  3146. </em>
  3147. </td>
  3148. <td>
  3149. </td>
  3150. </tr>
  3151. </tbody>
  3152. </table>
  3153. <h3 id="external-secrets.io/v1beta1.DopplerAuthSecretRef">DopplerAuthSecretRef
  3154. </h3>
  3155. <p>
  3156. (<em>Appears on:</em>
  3157. <a href="#external-secrets.io/v1beta1.DopplerAuth">DopplerAuth</a>)
  3158. </p>
  3159. <p>
  3160. </p>
  3161. <table>
  3162. <thead>
  3163. <tr>
  3164. <th>Field</th>
  3165. <th>Description</th>
  3166. </tr>
  3167. </thead>
  3168. <tbody>
  3169. <tr>
  3170. <td>
  3171. <code>dopplerToken</code></br>
  3172. <em>
  3173. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  3174. External Secrets meta/v1.SecretKeySelector
  3175. </a>
  3176. </em>
  3177. </td>
  3178. <td>
  3179. <p>The DopplerToken is used for authentication.
  3180. See <a href="https://docs.doppler.com/reference/api#authentication">https://docs.doppler.com/reference/api#authentication</a> for auth token types.
  3181. The Key attribute defaults to dopplerToken if not specified.</p>
  3182. </td>
  3183. </tr>
  3184. </tbody>
  3185. </table>
  3186. <h3 id="external-secrets.io/v1beta1.DopplerProvider">DopplerProvider
  3187. </h3>
  3188. <p>
  3189. (<em>Appears on:</em>
  3190. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  3191. </p>
  3192. <p>
  3193. <p>DopplerProvider configures a store to sync secrets using the Doppler provider.
  3194. Project and Config are required if not using a Service Token.</p>
  3195. </p>
  3196. <table>
  3197. <thead>
  3198. <tr>
  3199. <th>Field</th>
  3200. <th>Description</th>
  3201. </tr>
  3202. </thead>
  3203. <tbody>
  3204. <tr>
  3205. <td>
  3206. <code>auth</code></br>
  3207. <em>
  3208. <a href="#external-secrets.io/v1beta1.DopplerAuth">
  3209. DopplerAuth
  3210. </a>
  3211. </em>
  3212. </td>
  3213. <td>
  3214. <p>Auth configures how the Operator authenticates with the Doppler API</p>
  3215. </td>
  3216. </tr>
  3217. <tr>
  3218. <td>
  3219. <code>project</code></br>
  3220. <em>
  3221. string
  3222. </em>
  3223. </td>
  3224. <td>
  3225. <em>(Optional)</em>
  3226. <p>Doppler project (required if not using a Service Token)</p>
  3227. </td>
  3228. </tr>
  3229. <tr>
  3230. <td>
  3231. <code>config</code></br>
  3232. <em>
  3233. string
  3234. </em>
  3235. </td>
  3236. <td>
  3237. <em>(Optional)</em>
  3238. <p>Doppler config (required if not using a Service Token)</p>
  3239. </td>
  3240. </tr>
  3241. <tr>
  3242. <td>
  3243. <code>nameTransformer</code></br>
  3244. <em>
  3245. string
  3246. </em>
  3247. </td>
  3248. <td>
  3249. <em>(Optional)</em>
  3250. <p>Environment variable compatible name transforms that change secret names to a different format</p>
  3251. </td>
  3252. </tr>
  3253. <tr>
  3254. <td>
  3255. <code>format</code></br>
  3256. <em>
  3257. string
  3258. </em>
  3259. </td>
  3260. <td>
  3261. <em>(Optional)</em>
  3262. <p>Format enables the downloading of secrets as a file (string)</p>
  3263. </td>
  3264. </tr>
  3265. </tbody>
  3266. </table>
  3267. <h3 id="external-secrets.io/v1beta1.ExternalSecret">ExternalSecret
  3268. </h3>
  3269. <p>
  3270. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  3271. </p>
  3272. <table>
  3273. <thead>
  3274. <tr>
  3275. <th>Field</th>
  3276. <th>Description</th>
  3277. </tr>
  3278. </thead>
  3279. <tbody>
  3280. <tr>
  3281. <td>
  3282. <code>metadata</code></br>
  3283. <em>
  3284. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  3285. Kubernetes meta/v1.ObjectMeta
  3286. </a>
  3287. </em>
  3288. </td>
  3289. <td>
  3290. Refer to the Kubernetes API documentation for the fields of the
  3291. <code>metadata</code> field.
  3292. </td>
  3293. </tr>
  3294. <tr>
  3295. <td>
  3296. <code>spec</code></br>
  3297. <em>
  3298. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">
  3299. ExternalSecretSpec
  3300. </a>
  3301. </em>
  3302. </td>
  3303. <td>
  3304. <br/>
  3305. <br/>
  3306. <table>
  3307. <tr>
  3308. <td>
  3309. <code>secretStoreRef</code></br>
  3310. <em>
  3311. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  3312. SecretStoreRef
  3313. </a>
  3314. </em>
  3315. </td>
  3316. <td>
  3317. <em>(Optional)</em>
  3318. </td>
  3319. </tr>
  3320. <tr>
  3321. <td>
  3322. <code>target</code></br>
  3323. <em>
  3324. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  3325. ExternalSecretTarget
  3326. </a>
  3327. </em>
  3328. </td>
  3329. <td>
  3330. <em>(Optional)</em>
  3331. </td>
  3332. </tr>
  3333. <tr>
  3334. <td>
  3335. <code>refreshInterval</code></br>
  3336. <em>
  3337. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  3338. Kubernetes meta/v1.Duration
  3339. </a>
  3340. </em>
  3341. </td>
  3342. <td>
  3343. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  3344. 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;
  3345. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  3346. </td>
  3347. </tr>
  3348. <tr>
  3349. <td>
  3350. <code>data</code></br>
  3351. <em>
  3352. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  3353. []ExternalSecretData
  3354. </a>
  3355. </em>
  3356. </td>
  3357. <td>
  3358. <em>(Optional)</em>
  3359. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  3360. </td>
  3361. </tr>
  3362. <tr>
  3363. <td>
  3364. <code>dataFrom</code></br>
  3365. <em>
  3366. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  3367. []ExternalSecretDataFromRemoteRef
  3368. </a>
  3369. </em>
  3370. </td>
  3371. <td>
  3372. <em>(Optional)</em>
  3373. <p>DataFrom is used to fetch all properties from a specific Provider data
  3374. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  3375. </td>
  3376. </tr>
  3377. </table>
  3378. </td>
  3379. </tr>
  3380. <tr>
  3381. <td>
  3382. <code>status</code></br>
  3383. <em>
  3384. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">
  3385. ExternalSecretStatus
  3386. </a>
  3387. </em>
  3388. </td>
  3389. <td>
  3390. </td>
  3391. </tr>
  3392. </tbody>
  3393. </table>
  3394. <h3 id="external-secrets.io/v1beta1.ExternalSecretConditionType">ExternalSecretConditionType
  3395. (<code>string</code> alias)</p></h3>
  3396. <p>
  3397. (<em>Appears on:</em>
  3398. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  3399. </p>
  3400. <p>
  3401. </p>
  3402. <table>
  3403. <thead>
  3404. <tr>
  3405. <th>Value</th>
  3406. <th>Description</th>
  3407. </tr>
  3408. </thead>
  3409. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
  3410. <td></td>
  3411. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  3412. <td></td>
  3413. </tr></tbody>
  3414. </table>
  3415. <h3 id="external-secrets.io/v1beta1.ExternalSecretConversionStrategy">ExternalSecretConversionStrategy
  3416. (<code>string</code> alias)</p></h3>
  3417. <p>
  3418. (<em>Appears on:</em>
  3419. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  3420. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  3421. </p>
  3422. <p>
  3423. </p>
  3424. <table>
  3425. <thead>
  3426. <tr>
  3427. <th>Value</th>
  3428. <th>Description</th>
  3429. </tr>
  3430. </thead>
  3431. <tbody><tr><td><p>&#34;Default&#34;</p></td>
  3432. <td></td>
  3433. </tr><tr><td><p>&#34;Unicode&#34;</p></td>
  3434. <td></td>
  3435. </tr></tbody>
  3436. </table>
  3437. <h3 id="external-secrets.io/v1beta1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  3438. (<code>string</code> alias)</p></h3>
  3439. <p>
  3440. (<em>Appears on:</em>
  3441. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  3442. </p>
  3443. <p>
  3444. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  3445. </p>
  3446. <table>
  3447. <thead>
  3448. <tr>
  3449. <th>Value</th>
  3450. <th>Description</th>
  3451. </tr>
  3452. </thead>
  3453. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  3454. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  3455. </td>
  3456. </tr><tr><td><p>&#34;None&#34;</p></td>
  3457. <td><p>None does not create a Secret (future use with injector).</p>
  3458. </td>
  3459. </tr><tr><td><p>&#34;Orphan&#34;</p></td>
  3460. <td><p>Orphan creates the Secret and does not set the ownerReference.
  3461. I.e. it will be orphaned after the deletion of the ExternalSecret.</p>
  3462. </td>
  3463. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  3464. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  3465. </td>
  3466. </tr></tbody>
  3467. </table>
  3468. <h3 id="external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData
  3469. </h3>
  3470. <p>
  3471. (<em>Appears on:</em>
  3472. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  3473. </p>
  3474. <p>
  3475. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  3476. </p>
  3477. <table>
  3478. <thead>
  3479. <tr>
  3480. <th>Field</th>
  3481. <th>Description</th>
  3482. </tr>
  3483. </thead>
  3484. <tbody>
  3485. <tr>
  3486. <td>
  3487. <code>secretKey</code></br>
  3488. <em>
  3489. string
  3490. </em>
  3491. </td>
  3492. <td>
  3493. <p>SecretKey defines the key in which the controller stores
  3494. the value. This is the key in the Kind=Secret</p>
  3495. </td>
  3496. </tr>
  3497. <tr>
  3498. <td>
  3499. <code>remoteRef</code></br>
  3500. <em>
  3501. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  3502. ExternalSecretDataRemoteRef
  3503. </a>
  3504. </em>
  3505. </td>
  3506. <td>
  3507. <p>RemoteRef points to the remote secret and defines
  3508. which secret (version/property/..) to fetch.</p>
  3509. </td>
  3510. </tr>
  3511. <tr>
  3512. <td>
  3513. <code>sourceRef</code></br>
  3514. <em>
  3515. <a href="#external-secrets.io/v1beta1.StoreSourceRef">
  3516. StoreSourceRef
  3517. </a>
  3518. </em>
  3519. </td>
  3520. <td>
  3521. <p>SourceRef allows you to override the source
  3522. from which the value will pulled from.</p>
  3523. </td>
  3524. </tr>
  3525. </tbody>
  3526. </table>
  3527. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef
  3528. </h3>
  3529. <p>
  3530. (<em>Appears on:</em>
  3531. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  3532. </p>
  3533. <p>
  3534. </p>
  3535. <table>
  3536. <thead>
  3537. <tr>
  3538. <th>Field</th>
  3539. <th>Description</th>
  3540. </tr>
  3541. </thead>
  3542. <tbody>
  3543. <tr>
  3544. <td>
  3545. <code>extract</code></br>
  3546. <em>
  3547. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">
  3548. ExternalSecretDataRemoteRef
  3549. </a>
  3550. </em>
  3551. </td>
  3552. <td>
  3553. <em>(Optional)</em>
  3554. <p>Used to extract multiple key/value pairs from one secret
  3555. Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
  3556. </td>
  3557. </tr>
  3558. <tr>
  3559. <td>
  3560. <code>find</code></br>
  3561. <em>
  3562. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">
  3563. ExternalSecretFind
  3564. </a>
  3565. </em>
  3566. </td>
  3567. <td>
  3568. <em>(Optional)</em>
  3569. <p>Used to find secrets based on tags or regular expressions
  3570. Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.</p>
  3571. </td>
  3572. </tr>
  3573. <tr>
  3574. <td>
  3575. <code>rewrite</code></br>
  3576. <em>
  3577. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">
  3578. []ExternalSecretRewrite
  3579. </a>
  3580. </em>
  3581. </td>
  3582. <td>
  3583. <em>(Optional)</em>
  3584. <p>Used to rewrite secret Keys after getting them from the secret Provider
  3585. Multiple Rewrite operations can be provided. They are applied in a layered order (first to last)</p>
  3586. </td>
  3587. </tr>
  3588. <tr>
  3589. <td>
  3590. <code>sourceRef</code></br>
  3591. <em>
  3592. <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">
  3593. StoreGeneratorSourceRef
  3594. </a>
  3595. </em>
  3596. </td>
  3597. <td>
  3598. <p>SourceRef points to a store or generator
  3599. which contains secret values ready to use.
  3600. Use this in combination with Extract or Find pull values out of
  3601. a specific SecretStore.
  3602. When sourceRef points to a generator Extract or Find is not supported.
  3603. The generator returns a static map of values</p>
  3604. </td>
  3605. </tr>
  3606. </tbody>
  3607. </table>
  3608. <h3 id="external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  3609. </h3>
  3610. <p>
  3611. (<em>Appears on:</em>
  3612. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>,
  3613. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  3614. </p>
  3615. <p>
  3616. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  3617. </p>
  3618. <table>
  3619. <thead>
  3620. <tr>
  3621. <th>Field</th>
  3622. <th>Description</th>
  3623. </tr>
  3624. </thead>
  3625. <tbody>
  3626. <tr>
  3627. <td>
  3628. <code>key</code></br>
  3629. <em>
  3630. string
  3631. </em>
  3632. </td>
  3633. <td>
  3634. <p>Key is the key used in the Provider, mandatory</p>
  3635. </td>
  3636. </tr>
  3637. <tr>
  3638. <td>
  3639. <code>metadataPolicy</code></br>
  3640. <em>
  3641. <a href="#external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">
  3642. ExternalSecretMetadataPolicy
  3643. </a>
  3644. </em>
  3645. </td>
  3646. <td>
  3647. <em>(Optional)</em>
  3648. <p>Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None</p>
  3649. </td>
  3650. </tr>
  3651. <tr>
  3652. <td>
  3653. <code>property</code></br>
  3654. <em>
  3655. string
  3656. </em>
  3657. </td>
  3658. <td>
  3659. <em>(Optional)</em>
  3660. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  3661. </td>
  3662. </tr>
  3663. <tr>
  3664. <td>
  3665. <code>version</code></br>
  3666. <em>
  3667. string
  3668. </em>
  3669. </td>
  3670. <td>
  3671. <em>(Optional)</em>
  3672. <p>Used to select a specific version of the Provider value, if supported</p>
  3673. </td>
  3674. </tr>
  3675. <tr>
  3676. <td>
  3677. <code>conversionStrategy</code></br>
  3678. <em>
  3679. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  3680. ExternalSecretConversionStrategy
  3681. </a>
  3682. </em>
  3683. </td>
  3684. <td>
  3685. <em>(Optional)</em>
  3686. <p>Used to define a conversion Strategy</p>
  3687. </td>
  3688. </tr>
  3689. <tr>
  3690. <td>
  3691. <code>decodingStrategy</code></br>
  3692. <em>
  3693. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  3694. ExternalSecretDecodingStrategy
  3695. </a>
  3696. </em>
  3697. </td>
  3698. <td>
  3699. <em>(Optional)</em>
  3700. <p>Used to define a decoding Strategy</p>
  3701. </td>
  3702. </tr>
  3703. </tbody>
  3704. </table>
  3705. <h3 id="external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">ExternalSecretDecodingStrategy
  3706. (<code>string</code> alias)</p></h3>
  3707. <p>
  3708. (<em>Appears on:</em>
  3709. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>,
  3710. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  3711. </p>
  3712. <p>
  3713. </p>
  3714. <table>
  3715. <thead>
  3716. <tr>
  3717. <th>Value</th>
  3718. <th>Description</th>
  3719. </tr>
  3720. </thead>
  3721. <tbody><tr><td><p>&#34;Auto&#34;</p></td>
  3722. <td></td>
  3723. </tr><tr><td><p>&#34;Base64&#34;</p></td>
  3724. <td></td>
  3725. </tr><tr><td><p>&#34;Base64URL&#34;</p></td>
  3726. <td></td>
  3727. </tr><tr><td><p>&#34;None&#34;</p></td>
  3728. <td></td>
  3729. </tr></tbody>
  3730. </table>
  3731. <h3 id="external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">ExternalSecretDeletionPolicy
  3732. (<code>string</code> alias)</p></h3>
  3733. <p>
  3734. (<em>Appears on:</em>
  3735. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  3736. </p>
  3737. <p>
  3738. <p>ExternalSecretDeletionPolicy defines rules on how to delete the resulting Secret.</p>
  3739. </p>
  3740. <table>
  3741. <thead>
  3742. <tr>
  3743. <th>Value</th>
  3744. <th>Description</th>
  3745. </tr>
  3746. </thead>
  3747. <tbody><tr><td><p>&#34;Delete&#34;</p></td>
  3748. <td><p>Delete deletes the secret if all provider secrets are deleted.
  3749. If a secret gets deleted on the provider side and is not accessible
  3750. anymore this is not considered an error and the ExternalSecret
  3751. does not go into SecretSyncedError status.</p>
  3752. </td>
  3753. </tr><tr><td><p>&#34;Merge&#34;</p></td>
  3754. <td><p>Merge removes keys in the secret, but not the secret itself.
  3755. If a secret gets deleted on the provider side and is not accessible
  3756. anymore this is not considered an error and the ExternalSecret
  3757. does not go into SecretSyncedError status.</p>
  3758. </td>
  3759. </tr><tr><td><p>&#34;Retain&#34;</p></td>
  3760. <td><p>Retain will retain the secret if all provider secrets have been deleted.
  3761. If a provider secret does not exist the ExternalSecret gets into the
  3762. SecretSyncedError status.</p>
  3763. </td>
  3764. </tr></tbody>
  3765. </table>
  3766. <h3 id="external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind
  3767. </h3>
  3768. <p>
  3769. (<em>Appears on:</em>
  3770. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  3771. </p>
  3772. <p>
  3773. </p>
  3774. <table>
  3775. <thead>
  3776. <tr>
  3777. <th>Field</th>
  3778. <th>Description</th>
  3779. </tr>
  3780. </thead>
  3781. <tbody>
  3782. <tr>
  3783. <td>
  3784. <code>path</code></br>
  3785. <em>
  3786. string
  3787. </em>
  3788. </td>
  3789. <td>
  3790. <em>(Optional)</em>
  3791. <p>A root path to start the find operations.</p>
  3792. </td>
  3793. </tr>
  3794. <tr>
  3795. <td>
  3796. <code>name</code></br>
  3797. <em>
  3798. <a href="#external-secrets.io/v1beta1.FindName">
  3799. FindName
  3800. </a>
  3801. </em>
  3802. </td>
  3803. <td>
  3804. <em>(Optional)</em>
  3805. <p>Finds secrets based on the name.</p>
  3806. </td>
  3807. </tr>
  3808. <tr>
  3809. <td>
  3810. <code>tags</code></br>
  3811. <em>
  3812. map[string]string
  3813. </em>
  3814. </td>
  3815. <td>
  3816. <em>(Optional)</em>
  3817. <p>Find secrets based on tags.</p>
  3818. </td>
  3819. </tr>
  3820. <tr>
  3821. <td>
  3822. <code>conversionStrategy</code></br>
  3823. <em>
  3824. <a href="#external-secrets.io/v1beta1.ExternalSecretConversionStrategy">
  3825. ExternalSecretConversionStrategy
  3826. </a>
  3827. </em>
  3828. </td>
  3829. <td>
  3830. <em>(Optional)</em>
  3831. <p>Used to define a conversion Strategy</p>
  3832. </td>
  3833. </tr>
  3834. <tr>
  3835. <td>
  3836. <code>decodingStrategy</code></br>
  3837. <em>
  3838. <a href="#external-secrets.io/v1beta1.ExternalSecretDecodingStrategy">
  3839. ExternalSecretDecodingStrategy
  3840. </a>
  3841. </em>
  3842. </td>
  3843. <td>
  3844. <em>(Optional)</em>
  3845. <p>Used to define a decoding Strategy</p>
  3846. </td>
  3847. </tr>
  3848. </tbody>
  3849. </table>
  3850. <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadata">ExternalSecretMetadata
  3851. </h3>
  3852. <p>
  3853. (<em>Appears on:</em>
  3854. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>)
  3855. </p>
  3856. <p>
  3857. <p>ExternalSecretMetadata defines metadata fields for the ExternalSecret generated by the ClusterExternalSecret.</p>
  3858. </p>
  3859. <table>
  3860. <thead>
  3861. <tr>
  3862. <th>Field</th>
  3863. <th>Description</th>
  3864. </tr>
  3865. </thead>
  3866. <tbody>
  3867. <tr>
  3868. <td>
  3869. <code>annotations</code></br>
  3870. <em>
  3871. map[string]string
  3872. </em>
  3873. </td>
  3874. <td>
  3875. <em>(Optional)</em>
  3876. </td>
  3877. </tr>
  3878. <tr>
  3879. <td>
  3880. <code>labels</code></br>
  3881. <em>
  3882. map[string]string
  3883. </em>
  3884. </td>
  3885. <td>
  3886. <em>(Optional)</em>
  3887. </td>
  3888. </tr>
  3889. </tbody>
  3890. </table>
  3891. <h3 id="external-secrets.io/v1beta1.ExternalSecretMetadataPolicy">ExternalSecretMetadataPolicy
  3892. (<code>string</code> alias)</p></h3>
  3893. <p>
  3894. (<em>Appears on:</em>
  3895. <a href="#external-secrets.io/v1beta1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>)
  3896. </p>
  3897. <p>
  3898. </p>
  3899. <table>
  3900. <thead>
  3901. <tr>
  3902. <th>Value</th>
  3903. <th>Description</th>
  3904. </tr>
  3905. </thead>
  3906. <tbody><tr><td><p>&#34;Fetch&#34;</p></td>
  3907. <td></td>
  3908. </tr><tr><td><p>&#34;None&#34;</p></td>
  3909. <td></td>
  3910. </tr></tbody>
  3911. </table>
  3912. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite
  3913. </h3>
  3914. <p>
  3915. (<em>Appears on:</em>
  3916. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  3917. </p>
  3918. <p>
  3919. </p>
  3920. <table>
  3921. <thead>
  3922. <tr>
  3923. <th>Field</th>
  3924. <th>Description</th>
  3925. </tr>
  3926. </thead>
  3927. <tbody>
  3928. <tr>
  3929. <td>
  3930. <code>regexp</code></br>
  3931. <em>
  3932. <a href="#external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">
  3933. ExternalSecretRewriteRegexp
  3934. </a>
  3935. </em>
  3936. </td>
  3937. <td>
  3938. <em>(Optional)</em>
  3939. <p>Used to rewrite with regular expressions.
  3940. The resulting key will be the output of a regexp.ReplaceAll operation.</p>
  3941. </td>
  3942. </tr>
  3943. <tr>
  3944. <td>
  3945. <code>transform</code></br>
  3946. <em>
  3947. <a href="#external-secrets.io/v1beta1.ExternalSecretRewriteTransform">
  3948. ExternalSecretRewriteTransform
  3949. </a>
  3950. </em>
  3951. </td>
  3952. <td>
  3953. <em>(Optional)</em>
  3954. <p>Used to apply string transformation on the secrets.
  3955. The resulting key will be the output of the template applied by the operation.</p>
  3956. </td>
  3957. </tr>
  3958. </tbody>
  3959. </table>
  3960. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewriteRegexp">ExternalSecretRewriteRegexp
  3961. </h3>
  3962. <p>
  3963. (<em>Appears on:</em>
  3964. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
  3965. </p>
  3966. <p>
  3967. </p>
  3968. <table>
  3969. <thead>
  3970. <tr>
  3971. <th>Field</th>
  3972. <th>Description</th>
  3973. </tr>
  3974. </thead>
  3975. <tbody>
  3976. <tr>
  3977. <td>
  3978. <code>source</code></br>
  3979. <em>
  3980. string
  3981. </em>
  3982. </td>
  3983. <td>
  3984. <p>Used to define the regular expression of a re.Compiler.</p>
  3985. </td>
  3986. </tr>
  3987. <tr>
  3988. <td>
  3989. <code>target</code></br>
  3990. <em>
  3991. string
  3992. </em>
  3993. </td>
  3994. <td>
  3995. <p>Used to define the target pattern of a ReplaceAll operation.</p>
  3996. </td>
  3997. </tr>
  3998. </tbody>
  3999. </table>
  4000. <h3 id="external-secrets.io/v1beta1.ExternalSecretRewriteTransform">ExternalSecretRewriteTransform
  4001. </h3>
  4002. <p>
  4003. (<em>Appears on:</em>
  4004. <a href="#external-secrets.io/v1beta1.ExternalSecretRewrite">ExternalSecretRewrite</a>)
  4005. </p>
  4006. <p>
  4007. </p>
  4008. <table>
  4009. <thead>
  4010. <tr>
  4011. <th>Field</th>
  4012. <th>Description</th>
  4013. </tr>
  4014. </thead>
  4015. <tbody>
  4016. <tr>
  4017. <td>
  4018. <code>template</code></br>
  4019. <em>
  4020. string
  4021. </em>
  4022. </td>
  4023. <td>
  4024. <p>Used to define the template to apply on the secret name.
  4025. <code>.value</code> will specify the secret name in the template.</p>
  4026. </td>
  4027. </tr>
  4028. </tbody>
  4029. </table>
  4030. <h3 id="external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec
  4031. </h3>
  4032. <p>
  4033. (<em>Appears on:</em>
  4034. <a href="#external-secrets.io/v1beta1.ClusterExternalSecretSpec">ClusterExternalSecretSpec</a>,
  4035. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  4036. </p>
  4037. <p>
  4038. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  4039. </p>
  4040. <table>
  4041. <thead>
  4042. <tr>
  4043. <th>Field</th>
  4044. <th>Description</th>
  4045. </tr>
  4046. </thead>
  4047. <tbody>
  4048. <tr>
  4049. <td>
  4050. <code>secretStoreRef</code></br>
  4051. <em>
  4052. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  4053. SecretStoreRef
  4054. </a>
  4055. </em>
  4056. </td>
  4057. <td>
  4058. <em>(Optional)</em>
  4059. </td>
  4060. </tr>
  4061. <tr>
  4062. <td>
  4063. <code>target</code></br>
  4064. <em>
  4065. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">
  4066. ExternalSecretTarget
  4067. </a>
  4068. </em>
  4069. </td>
  4070. <td>
  4071. <em>(Optional)</em>
  4072. </td>
  4073. </tr>
  4074. <tr>
  4075. <td>
  4076. <code>refreshInterval</code></br>
  4077. <em>
  4078. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  4079. Kubernetes meta/v1.Duration
  4080. </a>
  4081. </em>
  4082. </td>
  4083. <td>
  4084. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  4085. 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;
  4086. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  4087. </td>
  4088. </tr>
  4089. <tr>
  4090. <td>
  4091. <code>data</code></br>
  4092. <em>
  4093. <a href="#external-secrets.io/v1beta1.ExternalSecretData">
  4094. []ExternalSecretData
  4095. </a>
  4096. </em>
  4097. </td>
  4098. <td>
  4099. <em>(Optional)</em>
  4100. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  4101. </td>
  4102. </tr>
  4103. <tr>
  4104. <td>
  4105. <code>dataFrom</code></br>
  4106. <em>
  4107. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">
  4108. []ExternalSecretDataFromRemoteRef
  4109. </a>
  4110. </em>
  4111. </td>
  4112. <td>
  4113. <em>(Optional)</em>
  4114. <p>DataFrom is used to fetch all properties from a specific Provider data
  4115. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  4116. </td>
  4117. </tr>
  4118. </tbody>
  4119. </table>
  4120. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus
  4121. </h3>
  4122. <p>
  4123. (<em>Appears on:</em>
  4124. <a href="#external-secrets.io/v1beta1.ExternalSecret">ExternalSecret</a>)
  4125. </p>
  4126. <p>
  4127. </p>
  4128. <table>
  4129. <thead>
  4130. <tr>
  4131. <th>Field</th>
  4132. <th>Description</th>
  4133. </tr>
  4134. </thead>
  4135. <tbody>
  4136. <tr>
  4137. <td>
  4138. <code>refreshTime</code></br>
  4139. <em>
  4140. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  4141. Kubernetes meta/v1.Time
  4142. </a>
  4143. </em>
  4144. </td>
  4145. <td>
  4146. <p>refreshTime is the time and date the external secret was fetched and
  4147. the target secret updated</p>
  4148. </td>
  4149. </tr>
  4150. <tr>
  4151. <td>
  4152. <code>syncedResourceVersion</code></br>
  4153. <em>
  4154. string
  4155. </em>
  4156. </td>
  4157. <td>
  4158. <p>SyncedResourceVersion keeps track of the last synced version</p>
  4159. </td>
  4160. </tr>
  4161. <tr>
  4162. <td>
  4163. <code>conditions</code></br>
  4164. <em>
  4165. <a href="#external-secrets.io/v1beta1.ExternalSecretStatusCondition">
  4166. []ExternalSecretStatusCondition
  4167. </a>
  4168. </em>
  4169. </td>
  4170. <td>
  4171. <em>(Optional)</em>
  4172. </td>
  4173. </tr>
  4174. <tr>
  4175. <td>
  4176. <code>binding</code></br>
  4177. <em>
  4178. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#localobjectreference-v1-core">
  4179. Kubernetes core/v1.LocalObjectReference
  4180. </a>
  4181. </em>
  4182. </td>
  4183. <td>
  4184. <p>Binding represents a servicebinding.io Provisioned Service reference to the secret</p>
  4185. </td>
  4186. </tr>
  4187. </tbody>
  4188. </table>
  4189. <h3 id="external-secrets.io/v1beta1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  4190. </h3>
  4191. <p>
  4192. (<em>Appears on:</em>
  4193. <a href="#external-secrets.io/v1beta1.ExternalSecretStatus">ExternalSecretStatus</a>)
  4194. </p>
  4195. <p>
  4196. </p>
  4197. <table>
  4198. <thead>
  4199. <tr>
  4200. <th>Field</th>
  4201. <th>Description</th>
  4202. </tr>
  4203. </thead>
  4204. <tbody>
  4205. <tr>
  4206. <td>
  4207. <code>type</code></br>
  4208. <em>
  4209. <a href="#external-secrets.io/v1beta1.ExternalSecretConditionType">
  4210. ExternalSecretConditionType
  4211. </a>
  4212. </em>
  4213. </td>
  4214. <td>
  4215. </td>
  4216. </tr>
  4217. <tr>
  4218. <td>
  4219. <code>status</code></br>
  4220. <em>
  4221. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  4222. Kubernetes core/v1.ConditionStatus
  4223. </a>
  4224. </em>
  4225. </td>
  4226. <td>
  4227. </td>
  4228. </tr>
  4229. <tr>
  4230. <td>
  4231. <code>reason</code></br>
  4232. <em>
  4233. string
  4234. </em>
  4235. </td>
  4236. <td>
  4237. <em>(Optional)</em>
  4238. </td>
  4239. </tr>
  4240. <tr>
  4241. <td>
  4242. <code>message</code></br>
  4243. <em>
  4244. string
  4245. </em>
  4246. </td>
  4247. <td>
  4248. <em>(Optional)</em>
  4249. </td>
  4250. </tr>
  4251. <tr>
  4252. <td>
  4253. <code>lastTransitionTime</code></br>
  4254. <em>
  4255. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  4256. Kubernetes meta/v1.Time
  4257. </a>
  4258. </em>
  4259. </td>
  4260. <td>
  4261. <em>(Optional)</em>
  4262. </td>
  4263. </tr>
  4264. </tbody>
  4265. </table>
  4266. <h3 id="external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget
  4267. </h3>
  4268. <p>
  4269. (<em>Appears on:</em>
  4270. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>)
  4271. </p>
  4272. <p>
  4273. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  4274. There can be only one target per ExternalSecret.</p>
  4275. </p>
  4276. <table>
  4277. <thead>
  4278. <tr>
  4279. <th>Field</th>
  4280. <th>Description</th>
  4281. </tr>
  4282. </thead>
  4283. <tbody>
  4284. <tr>
  4285. <td>
  4286. <code>name</code></br>
  4287. <em>
  4288. string
  4289. </em>
  4290. </td>
  4291. <td>
  4292. <em>(Optional)</em>
  4293. <p>Name defines the name of the Secret resource to be managed
  4294. This field is immutable
  4295. Defaults to the .metadata.name of the ExternalSecret resource</p>
  4296. </td>
  4297. </tr>
  4298. <tr>
  4299. <td>
  4300. <code>creationPolicy</code></br>
  4301. <em>
  4302. <a href="#external-secrets.io/v1beta1.ExternalSecretCreationPolicy">
  4303. ExternalSecretCreationPolicy
  4304. </a>
  4305. </em>
  4306. </td>
  4307. <td>
  4308. <em>(Optional)</em>
  4309. <p>CreationPolicy defines rules on how to create the resulting Secret
  4310. Defaults to &lsquo;Owner&rsquo;</p>
  4311. </td>
  4312. </tr>
  4313. <tr>
  4314. <td>
  4315. <code>deletionPolicy</code></br>
  4316. <em>
  4317. <a href="#external-secrets.io/v1beta1.ExternalSecretDeletionPolicy">
  4318. ExternalSecretDeletionPolicy
  4319. </a>
  4320. </em>
  4321. </td>
  4322. <td>
  4323. <em>(Optional)</em>
  4324. <p>DeletionPolicy defines rules on how to delete the resulting Secret
  4325. Defaults to &lsquo;Retain&rsquo;</p>
  4326. </td>
  4327. </tr>
  4328. <tr>
  4329. <td>
  4330. <code>template</code></br>
  4331. <em>
  4332. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">
  4333. ExternalSecretTemplate
  4334. </a>
  4335. </em>
  4336. </td>
  4337. <td>
  4338. <em>(Optional)</em>
  4339. <p>Template defines a blueprint for the created Secret resource.</p>
  4340. </td>
  4341. </tr>
  4342. <tr>
  4343. <td>
  4344. <code>immutable</code></br>
  4345. <em>
  4346. bool
  4347. </em>
  4348. </td>
  4349. <td>
  4350. <em>(Optional)</em>
  4351. <p>Immutable defines if the final secret will be immutable</p>
  4352. </td>
  4353. </tr>
  4354. </tbody>
  4355. </table>
  4356. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate
  4357. </h3>
  4358. <p>
  4359. (<em>Appears on:</em>
  4360. <a href="#external-secrets.io/v1beta1.ExternalSecretTarget">ExternalSecretTarget</a>)
  4361. </p>
  4362. <p>
  4363. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  4364. 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>
  4365. </p>
  4366. <table>
  4367. <thead>
  4368. <tr>
  4369. <th>Field</th>
  4370. <th>Description</th>
  4371. </tr>
  4372. </thead>
  4373. <tbody>
  4374. <tr>
  4375. <td>
  4376. <code>type</code></br>
  4377. <em>
  4378. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secrettype-v1-core">
  4379. Kubernetes core/v1.SecretType
  4380. </a>
  4381. </em>
  4382. </td>
  4383. <td>
  4384. <em>(Optional)</em>
  4385. </td>
  4386. </tr>
  4387. <tr>
  4388. <td>
  4389. <code>engineVersion</code></br>
  4390. <em>
  4391. <a href="#external-secrets.io/v1beta1.TemplateEngineVersion">
  4392. TemplateEngineVersion
  4393. </a>
  4394. </em>
  4395. </td>
  4396. <td>
  4397. <p>EngineVersion specifies the template engine version
  4398. that should be used to compile/execute the
  4399. template specified in .data and .templateFrom[].</p>
  4400. </td>
  4401. </tr>
  4402. <tr>
  4403. <td>
  4404. <code>metadata</code></br>
  4405. <em>
  4406. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">
  4407. ExternalSecretTemplateMetadata
  4408. </a>
  4409. </em>
  4410. </td>
  4411. <td>
  4412. <em>(Optional)</em>
  4413. </td>
  4414. </tr>
  4415. <tr>
  4416. <td>
  4417. <code>mergePolicy</code></br>
  4418. <em>
  4419. <a href="#external-secrets.io/v1beta1.TemplateMergePolicy">
  4420. TemplateMergePolicy
  4421. </a>
  4422. </em>
  4423. </td>
  4424. <td>
  4425. </td>
  4426. </tr>
  4427. <tr>
  4428. <td>
  4429. <code>data</code></br>
  4430. <em>
  4431. map[string]string
  4432. </em>
  4433. </td>
  4434. <td>
  4435. <em>(Optional)</em>
  4436. </td>
  4437. </tr>
  4438. <tr>
  4439. <td>
  4440. <code>templateFrom</code></br>
  4441. <em>
  4442. <a href="#external-secrets.io/v1beta1.TemplateFrom">
  4443. []TemplateFrom
  4444. </a>
  4445. </em>
  4446. </td>
  4447. <td>
  4448. <em>(Optional)</em>
  4449. </td>
  4450. </tr>
  4451. </tbody>
  4452. </table>
  4453. <h3 id="external-secrets.io/v1beta1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  4454. </h3>
  4455. <p>
  4456. (<em>Appears on:</em>
  4457. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  4458. </p>
  4459. <p>
  4460. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  4461. </p>
  4462. <table>
  4463. <thead>
  4464. <tr>
  4465. <th>Field</th>
  4466. <th>Description</th>
  4467. </tr>
  4468. </thead>
  4469. <tbody>
  4470. <tr>
  4471. <td>
  4472. <code>annotations</code></br>
  4473. <em>
  4474. map[string]string
  4475. </em>
  4476. </td>
  4477. <td>
  4478. <em>(Optional)</em>
  4479. </td>
  4480. </tr>
  4481. <tr>
  4482. <td>
  4483. <code>labels</code></br>
  4484. <em>
  4485. map[string]string
  4486. </em>
  4487. </td>
  4488. <td>
  4489. <em>(Optional)</em>
  4490. </td>
  4491. </tr>
  4492. </tbody>
  4493. </table>
  4494. <h3 id="external-secrets.io/v1beta1.ExternalSecretValidator">ExternalSecretValidator
  4495. </h3>
  4496. <p>
  4497. </p>
  4498. <h3 id="external-secrets.io/v1beta1.FakeProvider">FakeProvider
  4499. </h3>
  4500. <p>
  4501. (<em>Appears on:</em>
  4502. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4503. </p>
  4504. <p>
  4505. <p>FakeProvider configures a fake provider that returns static values.</p>
  4506. </p>
  4507. <table>
  4508. <thead>
  4509. <tr>
  4510. <th>Field</th>
  4511. <th>Description</th>
  4512. </tr>
  4513. </thead>
  4514. <tbody>
  4515. <tr>
  4516. <td>
  4517. <code>data</code></br>
  4518. <em>
  4519. <a href="#external-secrets.io/v1beta1.FakeProviderData">
  4520. []FakeProviderData
  4521. </a>
  4522. </em>
  4523. </td>
  4524. <td>
  4525. </td>
  4526. </tr>
  4527. </tbody>
  4528. </table>
  4529. <h3 id="external-secrets.io/v1beta1.FakeProviderData">FakeProviderData
  4530. </h3>
  4531. <p>
  4532. (<em>Appears on:</em>
  4533. <a href="#external-secrets.io/v1beta1.FakeProvider">FakeProvider</a>)
  4534. </p>
  4535. <p>
  4536. </p>
  4537. <table>
  4538. <thead>
  4539. <tr>
  4540. <th>Field</th>
  4541. <th>Description</th>
  4542. </tr>
  4543. </thead>
  4544. <tbody>
  4545. <tr>
  4546. <td>
  4547. <code>key</code></br>
  4548. <em>
  4549. string
  4550. </em>
  4551. </td>
  4552. <td>
  4553. </td>
  4554. </tr>
  4555. <tr>
  4556. <td>
  4557. <code>value</code></br>
  4558. <em>
  4559. string
  4560. </em>
  4561. </td>
  4562. <td>
  4563. </td>
  4564. </tr>
  4565. <tr>
  4566. <td>
  4567. <code>valueMap</code></br>
  4568. <em>
  4569. map[string]string
  4570. </em>
  4571. </td>
  4572. <td>
  4573. <p>Deprecated: ValueMap is deprecated and is intended to be removed in the future, use the <code>value</code> field instead.</p>
  4574. </td>
  4575. </tr>
  4576. <tr>
  4577. <td>
  4578. <code>version</code></br>
  4579. <em>
  4580. string
  4581. </em>
  4582. </td>
  4583. <td>
  4584. </td>
  4585. </tr>
  4586. </tbody>
  4587. </table>
  4588. <h3 id="external-secrets.io/v1beta1.FindName">FindName
  4589. </h3>
  4590. <p>
  4591. (<em>Appears on:</em>
  4592. <a href="#external-secrets.io/v1beta1.ExternalSecretFind">ExternalSecretFind</a>)
  4593. </p>
  4594. <p>
  4595. </p>
  4596. <table>
  4597. <thead>
  4598. <tr>
  4599. <th>Field</th>
  4600. <th>Description</th>
  4601. </tr>
  4602. </thead>
  4603. <tbody>
  4604. <tr>
  4605. <td>
  4606. <code>regexp</code></br>
  4607. <em>
  4608. string
  4609. </em>
  4610. </td>
  4611. <td>
  4612. <em>(Optional)</em>
  4613. <p>Finds secrets base</p>
  4614. </td>
  4615. </tr>
  4616. </tbody>
  4617. </table>
  4618. <h3 id="external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth
  4619. </h3>
  4620. <p>
  4621. (<em>Appears on:</em>
  4622. <a href="#external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider</a>)
  4623. </p>
  4624. <p>
  4625. </p>
  4626. <table>
  4627. <thead>
  4628. <tr>
  4629. <th>Field</th>
  4630. <th>Description</th>
  4631. </tr>
  4632. </thead>
  4633. <tbody>
  4634. <tr>
  4635. <td>
  4636. <code>secretRef</code></br>
  4637. <em>
  4638. <a href="#external-secrets.io/v1beta1.GCPSMAuthSecretRef">
  4639. GCPSMAuthSecretRef
  4640. </a>
  4641. </em>
  4642. </td>
  4643. <td>
  4644. <em>(Optional)</em>
  4645. </td>
  4646. </tr>
  4647. <tr>
  4648. <td>
  4649. <code>workloadIdentity</code></br>
  4650. <em>
  4651. <a href="#external-secrets.io/v1beta1.GCPWorkloadIdentity">
  4652. GCPWorkloadIdentity
  4653. </a>
  4654. </em>
  4655. </td>
  4656. <td>
  4657. <em>(Optional)</em>
  4658. </td>
  4659. </tr>
  4660. </tbody>
  4661. </table>
  4662. <h3 id="external-secrets.io/v1beta1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  4663. </h3>
  4664. <p>
  4665. (<em>Appears on:</em>
  4666. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  4667. </p>
  4668. <p>
  4669. </p>
  4670. <table>
  4671. <thead>
  4672. <tr>
  4673. <th>Field</th>
  4674. <th>Description</th>
  4675. </tr>
  4676. </thead>
  4677. <tbody>
  4678. <tr>
  4679. <td>
  4680. <code>secretAccessKeySecretRef</code></br>
  4681. <em>
  4682. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  4683. External Secrets meta/v1.SecretKeySelector
  4684. </a>
  4685. </em>
  4686. </td>
  4687. <td>
  4688. <em>(Optional)</em>
  4689. <p>The SecretAccessKey is used for authentication</p>
  4690. </td>
  4691. </tr>
  4692. </tbody>
  4693. </table>
  4694. <h3 id="external-secrets.io/v1beta1.GCPSMProvider">GCPSMProvider
  4695. </h3>
  4696. <p>
  4697. (<em>Appears on:</em>
  4698. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4699. </p>
  4700. <p>
  4701. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  4702. </p>
  4703. <table>
  4704. <thead>
  4705. <tr>
  4706. <th>Field</th>
  4707. <th>Description</th>
  4708. </tr>
  4709. </thead>
  4710. <tbody>
  4711. <tr>
  4712. <td>
  4713. <code>auth</code></br>
  4714. <em>
  4715. <a href="#external-secrets.io/v1beta1.GCPSMAuth">
  4716. GCPSMAuth
  4717. </a>
  4718. </em>
  4719. </td>
  4720. <td>
  4721. <em>(Optional)</em>
  4722. <p>Auth defines the information necessary to authenticate against GCP</p>
  4723. </td>
  4724. </tr>
  4725. <tr>
  4726. <td>
  4727. <code>projectID</code></br>
  4728. <em>
  4729. string
  4730. </em>
  4731. </td>
  4732. <td>
  4733. <p>ProjectID project where secret is located</p>
  4734. </td>
  4735. </tr>
  4736. </tbody>
  4737. </table>
  4738. <h3 id="external-secrets.io/v1beta1.GCPWorkloadIdentity">GCPWorkloadIdentity
  4739. </h3>
  4740. <p>
  4741. (<em>Appears on:</em>
  4742. <a href="#external-secrets.io/v1beta1.GCPSMAuth">GCPSMAuth</a>)
  4743. </p>
  4744. <p>
  4745. </p>
  4746. <table>
  4747. <thead>
  4748. <tr>
  4749. <th>Field</th>
  4750. <th>Description</th>
  4751. </tr>
  4752. </thead>
  4753. <tbody>
  4754. <tr>
  4755. <td>
  4756. <code>serviceAccountRef</code></br>
  4757. <em>
  4758. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  4759. External Secrets meta/v1.ServiceAccountSelector
  4760. </a>
  4761. </em>
  4762. </td>
  4763. <td>
  4764. </td>
  4765. </tr>
  4766. <tr>
  4767. <td>
  4768. <code>clusterLocation</code></br>
  4769. <em>
  4770. string
  4771. </em>
  4772. </td>
  4773. <td>
  4774. </td>
  4775. </tr>
  4776. <tr>
  4777. <td>
  4778. <code>clusterName</code></br>
  4779. <em>
  4780. string
  4781. </em>
  4782. </td>
  4783. <td>
  4784. </td>
  4785. </tr>
  4786. <tr>
  4787. <td>
  4788. <code>clusterProjectID</code></br>
  4789. <em>
  4790. string
  4791. </em>
  4792. </td>
  4793. <td>
  4794. </td>
  4795. </tr>
  4796. </tbody>
  4797. </table>
  4798. <h3 id="external-secrets.io/v1beta1.GeneratorRef">GeneratorRef
  4799. </h3>
  4800. <p>
  4801. (<em>Appears on:</em>
  4802. <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef</a>,
  4803. <a href="#external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef</a>)
  4804. </p>
  4805. <p>
  4806. <p>GeneratorRef points to a generator custom resource.</p>
  4807. </p>
  4808. <table>
  4809. <thead>
  4810. <tr>
  4811. <th>Field</th>
  4812. <th>Description</th>
  4813. </tr>
  4814. </thead>
  4815. <tbody>
  4816. <tr>
  4817. <td>
  4818. <code>apiVersion</code></br>
  4819. <em>
  4820. string
  4821. </em>
  4822. </td>
  4823. <td>
  4824. <p>Specify the apiVersion of the generator resource</p>
  4825. </td>
  4826. </tr>
  4827. <tr>
  4828. <td>
  4829. <code>kind</code></br>
  4830. <em>
  4831. string
  4832. </em>
  4833. </td>
  4834. <td>
  4835. <p>Specify the Kind of the resource, e.g. Password, ACRAccessToken etc.</p>
  4836. </td>
  4837. </tr>
  4838. <tr>
  4839. <td>
  4840. <code>name</code></br>
  4841. <em>
  4842. string
  4843. </em>
  4844. </td>
  4845. <td>
  4846. <p>Specify the name of the generator resource</p>
  4847. </td>
  4848. </tr>
  4849. </tbody>
  4850. </table>
  4851. <h3 id="external-secrets.io/v1beta1.GenericStore">GenericStore
  4852. </h3>
  4853. <p>
  4854. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  4855. or a namespaced SecretStore.</p>
  4856. </p>
  4857. <h3 id="external-secrets.io/v1beta1.GenericStoreValidator">GenericStoreValidator
  4858. </h3>
  4859. <p>
  4860. </p>
  4861. <h3 id="external-secrets.io/v1beta1.GitlabAuth">GitlabAuth
  4862. </h3>
  4863. <p>
  4864. (<em>Appears on:</em>
  4865. <a href="#external-secrets.io/v1beta1.GitlabProvider">GitlabProvider</a>)
  4866. </p>
  4867. <p>
  4868. </p>
  4869. <table>
  4870. <thead>
  4871. <tr>
  4872. <th>Field</th>
  4873. <th>Description</th>
  4874. </tr>
  4875. </thead>
  4876. <tbody>
  4877. <tr>
  4878. <td>
  4879. <code>SecretRef</code></br>
  4880. <em>
  4881. <a href="#external-secrets.io/v1beta1.GitlabSecretRef">
  4882. GitlabSecretRef
  4883. </a>
  4884. </em>
  4885. </td>
  4886. <td>
  4887. </td>
  4888. </tr>
  4889. </tbody>
  4890. </table>
  4891. <h3 id="external-secrets.io/v1beta1.GitlabProvider">GitlabProvider
  4892. </h3>
  4893. <p>
  4894. (<em>Appears on:</em>
  4895. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  4896. </p>
  4897. <p>
  4898. <p>Configures a store to sync secrets with a GitLab instance.</p>
  4899. </p>
  4900. <table>
  4901. <thead>
  4902. <tr>
  4903. <th>Field</th>
  4904. <th>Description</th>
  4905. </tr>
  4906. </thead>
  4907. <tbody>
  4908. <tr>
  4909. <td>
  4910. <code>url</code></br>
  4911. <em>
  4912. string
  4913. </em>
  4914. </td>
  4915. <td>
  4916. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
  4917. </td>
  4918. </tr>
  4919. <tr>
  4920. <td>
  4921. <code>auth</code></br>
  4922. <em>
  4923. <a href="#external-secrets.io/v1beta1.GitlabAuth">
  4924. GitlabAuth
  4925. </a>
  4926. </em>
  4927. </td>
  4928. <td>
  4929. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
  4930. </td>
  4931. </tr>
  4932. <tr>
  4933. <td>
  4934. <code>projectID</code></br>
  4935. <em>
  4936. string
  4937. </em>
  4938. </td>
  4939. <td>
  4940. <p>ProjectID specifies a project where secrets are located.</p>
  4941. </td>
  4942. </tr>
  4943. <tr>
  4944. <td>
  4945. <code>inheritFromGroups</code></br>
  4946. <em>
  4947. bool
  4948. </em>
  4949. </td>
  4950. <td>
  4951. <p>InheritFromGroups specifies whether parent groups should be discovered and checked for secrets.</p>
  4952. </td>
  4953. </tr>
  4954. <tr>
  4955. <td>
  4956. <code>groupIDs</code></br>
  4957. <em>
  4958. []string
  4959. </em>
  4960. </td>
  4961. <td>
  4962. <p>GroupIDs specify, which gitlab groups to pull secrets from. Group secrets are read from left to right followed by the project variables.</p>
  4963. </td>
  4964. </tr>
  4965. <tr>
  4966. <td>
  4967. <code>environment</code></br>
  4968. <em>
  4969. string
  4970. </em>
  4971. </td>
  4972. <td>
  4973. <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>
  4974. </td>
  4975. </tr>
  4976. </tbody>
  4977. </table>
  4978. <h3 id="external-secrets.io/v1beta1.GitlabSecretRef">GitlabSecretRef
  4979. </h3>
  4980. <p>
  4981. (<em>Appears on:</em>
  4982. <a href="#external-secrets.io/v1beta1.GitlabAuth">GitlabAuth</a>)
  4983. </p>
  4984. <p>
  4985. </p>
  4986. <table>
  4987. <thead>
  4988. <tr>
  4989. <th>Field</th>
  4990. <th>Description</th>
  4991. </tr>
  4992. </thead>
  4993. <tbody>
  4994. <tr>
  4995. <td>
  4996. <code>accessToken</code></br>
  4997. <em>
  4998. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  4999. External Secrets meta/v1.SecretKeySelector
  5000. </a>
  5001. </em>
  5002. </td>
  5003. <td>
  5004. <p>AccessToken is used for authentication.</p>
  5005. </td>
  5006. </tr>
  5007. </tbody>
  5008. </table>
  5009. <h3 id="external-secrets.io/v1beta1.IBMAuth">IBMAuth
  5010. </h3>
  5011. <p>
  5012. (<em>Appears on:</em>
  5013. <a href="#external-secrets.io/v1beta1.IBMProvider">IBMProvider</a>)
  5014. </p>
  5015. <p>
  5016. </p>
  5017. <table>
  5018. <thead>
  5019. <tr>
  5020. <th>Field</th>
  5021. <th>Description</th>
  5022. </tr>
  5023. </thead>
  5024. <tbody>
  5025. <tr>
  5026. <td>
  5027. <code>secretRef</code></br>
  5028. <em>
  5029. <a href="#external-secrets.io/v1beta1.IBMAuthSecretRef">
  5030. IBMAuthSecretRef
  5031. </a>
  5032. </em>
  5033. </td>
  5034. <td>
  5035. </td>
  5036. </tr>
  5037. <tr>
  5038. <td>
  5039. <code>containerAuth</code></br>
  5040. <em>
  5041. <a href="#external-secrets.io/v1beta1.IBMAuthContainerAuth">
  5042. IBMAuthContainerAuth
  5043. </a>
  5044. </em>
  5045. </td>
  5046. <td>
  5047. </td>
  5048. </tr>
  5049. </tbody>
  5050. </table>
  5051. <h3 id="external-secrets.io/v1beta1.IBMAuthContainerAuth">IBMAuthContainerAuth
  5052. </h3>
  5053. <p>
  5054. (<em>Appears on:</em>
  5055. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  5056. </p>
  5057. <p>
  5058. <p>IBM Container-based auth with IAM Trusted Profile.</p>
  5059. </p>
  5060. <table>
  5061. <thead>
  5062. <tr>
  5063. <th>Field</th>
  5064. <th>Description</th>
  5065. </tr>
  5066. </thead>
  5067. <tbody>
  5068. <tr>
  5069. <td>
  5070. <code>profile</code></br>
  5071. <em>
  5072. string
  5073. </em>
  5074. </td>
  5075. <td>
  5076. <p>the IBM Trusted Profile</p>
  5077. </td>
  5078. </tr>
  5079. <tr>
  5080. <td>
  5081. <code>tokenLocation</code></br>
  5082. <em>
  5083. string
  5084. </em>
  5085. </td>
  5086. <td>
  5087. <p>Location the token is mounted on the pod</p>
  5088. </td>
  5089. </tr>
  5090. <tr>
  5091. <td>
  5092. <code>iamEndpoint</code></br>
  5093. <em>
  5094. string
  5095. </em>
  5096. </td>
  5097. <td>
  5098. </td>
  5099. </tr>
  5100. </tbody>
  5101. </table>
  5102. <h3 id="external-secrets.io/v1beta1.IBMAuthSecretRef">IBMAuthSecretRef
  5103. </h3>
  5104. <p>
  5105. (<em>Appears on:</em>
  5106. <a href="#external-secrets.io/v1beta1.IBMAuth">IBMAuth</a>)
  5107. </p>
  5108. <p>
  5109. </p>
  5110. <table>
  5111. <thead>
  5112. <tr>
  5113. <th>Field</th>
  5114. <th>Description</th>
  5115. </tr>
  5116. </thead>
  5117. <tbody>
  5118. <tr>
  5119. <td>
  5120. <code>secretApiKeySecretRef</code></br>
  5121. <em>
  5122. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5123. External Secrets meta/v1.SecretKeySelector
  5124. </a>
  5125. </em>
  5126. </td>
  5127. <td>
  5128. <p>The SecretAccessKey is used for authentication</p>
  5129. </td>
  5130. </tr>
  5131. </tbody>
  5132. </table>
  5133. <h3 id="external-secrets.io/v1beta1.IBMProvider">IBMProvider
  5134. </h3>
  5135. <p>
  5136. (<em>Appears on:</em>
  5137. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5138. </p>
  5139. <p>
  5140. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
  5141. backend.</p>
  5142. </p>
  5143. <table>
  5144. <thead>
  5145. <tr>
  5146. <th>Field</th>
  5147. <th>Description</th>
  5148. </tr>
  5149. </thead>
  5150. <tbody>
  5151. <tr>
  5152. <td>
  5153. <code>auth</code></br>
  5154. <em>
  5155. <a href="#external-secrets.io/v1beta1.IBMAuth">
  5156. IBMAuth
  5157. </a>
  5158. </em>
  5159. </td>
  5160. <td>
  5161. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
  5162. </td>
  5163. </tr>
  5164. <tr>
  5165. <td>
  5166. <code>serviceUrl</code></br>
  5167. <em>
  5168. string
  5169. </em>
  5170. </td>
  5171. <td>
  5172. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
  5173. </td>
  5174. </tr>
  5175. </tbody>
  5176. </table>
  5177. <h3 id="external-secrets.io/v1beta1.KeeperSecurityProvider">KeeperSecurityProvider
  5178. </h3>
  5179. <p>
  5180. (<em>Appears on:</em>
  5181. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5182. </p>
  5183. <p>
  5184. <p>KeeperSecurityProvider Configures a store to sync secrets using Keeper Security.</p>
  5185. </p>
  5186. <table>
  5187. <thead>
  5188. <tr>
  5189. <th>Field</th>
  5190. <th>Description</th>
  5191. </tr>
  5192. </thead>
  5193. <tbody>
  5194. <tr>
  5195. <td>
  5196. <code>authRef</code></br>
  5197. <em>
  5198. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5199. External Secrets meta/v1.SecretKeySelector
  5200. </a>
  5201. </em>
  5202. </td>
  5203. <td>
  5204. </td>
  5205. </tr>
  5206. <tr>
  5207. <td>
  5208. <code>folderID</code></br>
  5209. <em>
  5210. string
  5211. </em>
  5212. </td>
  5213. <td>
  5214. </td>
  5215. </tr>
  5216. </tbody>
  5217. </table>
  5218. <h3 id="external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth
  5219. </h3>
  5220. <p>
  5221. (<em>Appears on:</em>
  5222. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  5223. </p>
  5224. <p>
  5225. </p>
  5226. <table>
  5227. <thead>
  5228. <tr>
  5229. <th>Field</th>
  5230. <th>Description</th>
  5231. </tr>
  5232. </thead>
  5233. <tbody>
  5234. <tr>
  5235. <td>
  5236. <code>cert</code></br>
  5237. <em>
  5238. <a href="#external-secrets.io/v1beta1.CertAuth">
  5239. CertAuth
  5240. </a>
  5241. </em>
  5242. </td>
  5243. <td>
  5244. <em>(Optional)</em>
  5245. <p>has both clientCert and clientKey as secretKeySelector</p>
  5246. </td>
  5247. </tr>
  5248. <tr>
  5249. <td>
  5250. <code>token</code></br>
  5251. <em>
  5252. <a href="#external-secrets.io/v1beta1.TokenAuth">
  5253. TokenAuth
  5254. </a>
  5255. </em>
  5256. </td>
  5257. <td>
  5258. <em>(Optional)</em>
  5259. <p>use static token to authenticate with</p>
  5260. </td>
  5261. </tr>
  5262. <tr>
  5263. <td>
  5264. <code>serviceAccount</code></br>
  5265. <em>
  5266. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  5267. External Secrets meta/v1.ServiceAccountSelector
  5268. </a>
  5269. </em>
  5270. </td>
  5271. <td>
  5272. <em>(Optional)</em>
  5273. <p>points to a service account that should be used for authentication</p>
  5274. </td>
  5275. </tr>
  5276. </tbody>
  5277. </table>
  5278. <h3 id="external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider
  5279. </h3>
  5280. <p>
  5281. (<em>Appears on:</em>
  5282. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5283. </p>
  5284. <p>
  5285. <p>Configures a store to sync secrets with a Kubernetes instance.</p>
  5286. </p>
  5287. <table>
  5288. <thead>
  5289. <tr>
  5290. <th>Field</th>
  5291. <th>Description</th>
  5292. </tr>
  5293. </thead>
  5294. <tbody>
  5295. <tr>
  5296. <td>
  5297. <code>server</code></br>
  5298. <em>
  5299. <a href="#external-secrets.io/v1beta1.KubernetesServer">
  5300. KubernetesServer
  5301. </a>
  5302. </em>
  5303. </td>
  5304. <td>
  5305. <p>configures the Kubernetes server Address.</p>
  5306. </td>
  5307. </tr>
  5308. <tr>
  5309. <td>
  5310. <code>auth</code></br>
  5311. <em>
  5312. <a href="#external-secrets.io/v1beta1.KubernetesAuth">
  5313. KubernetesAuth
  5314. </a>
  5315. </em>
  5316. </td>
  5317. <td>
  5318. <p>Auth configures how secret-manager authenticates with a Kubernetes instance.</p>
  5319. </td>
  5320. </tr>
  5321. <tr>
  5322. <td>
  5323. <code>remoteNamespace</code></br>
  5324. <em>
  5325. string
  5326. </em>
  5327. </td>
  5328. <td>
  5329. <em>(Optional)</em>
  5330. <p>Remote namespace to fetch the secrets from</p>
  5331. </td>
  5332. </tr>
  5333. </tbody>
  5334. </table>
  5335. <h3 id="external-secrets.io/v1beta1.KubernetesServer">KubernetesServer
  5336. </h3>
  5337. <p>
  5338. (<em>Appears on:</em>
  5339. <a href="#external-secrets.io/v1beta1.KubernetesProvider">KubernetesProvider</a>)
  5340. </p>
  5341. <p>
  5342. </p>
  5343. <table>
  5344. <thead>
  5345. <tr>
  5346. <th>Field</th>
  5347. <th>Description</th>
  5348. </tr>
  5349. </thead>
  5350. <tbody>
  5351. <tr>
  5352. <td>
  5353. <code>url</code></br>
  5354. <em>
  5355. string
  5356. </em>
  5357. </td>
  5358. <td>
  5359. <em>(Optional)</em>
  5360. <p>configures the Kubernetes server Address.</p>
  5361. </td>
  5362. </tr>
  5363. <tr>
  5364. <td>
  5365. <code>caBundle</code></br>
  5366. <em>
  5367. []byte
  5368. </em>
  5369. </td>
  5370. <td>
  5371. <em>(Optional)</em>
  5372. <p>CABundle is a base64-encoded CA certificate</p>
  5373. </td>
  5374. </tr>
  5375. <tr>
  5376. <td>
  5377. <code>caProvider</code></br>
  5378. <em>
  5379. <a href="#external-secrets.io/v1beta1.CAProvider">
  5380. CAProvider
  5381. </a>
  5382. </em>
  5383. </td>
  5384. <td>
  5385. <em>(Optional)</em>
  5386. <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>
  5387. </td>
  5388. </tr>
  5389. </tbody>
  5390. </table>
  5391. <h3 id="external-secrets.io/v1beta1.NoSecretError">NoSecretError
  5392. </h3>
  5393. <p>
  5394. <p>NoSecretError shall be returned when a GetSecret can not find the
  5395. desired secret. This is used for deletionPolicy.</p>
  5396. </p>
  5397. <h3 id="external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth
  5398. </h3>
  5399. <p>
  5400. (<em>Appears on:</em>
  5401. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider</a>)
  5402. </p>
  5403. <p>
  5404. <p>OnePasswordAuth contains a secretRef for credentials.</p>
  5405. </p>
  5406. <table>
  5407. <thead>
  5408. <tr>
  5409. <th>Field</th>
  5410. <th>Description</th>
  5411. </tr>
  5412. </thead>
  5413. <tbody>
  5414. <tr>
  5415. <td>
  5416. <code>secretRef</code></br>
  5417. <em>
  5418. <a href="#external-secrets.io/v1beta1.OnePasswordAuthSecretRef">
  5419. OnePasswordAuthSecretRef
  5420. </a>
  5421. </em>
  5422. </td>
  5423. <td>
  5424. </td>
  5425. </tr>
  5426. </tbody>
  5427. </table>
  5428. <h3 id="external-secrets.io/v1beta1.OnePasswordAuthSecretRef">OnePasswordAuthSecretRef
  5429. </h3>
  5430. <p>
  5431. (<em>Appears on:</em>
  5432. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">OnePasswordAuth</a>)
  5433. </p>
  5434. <p>
  5435. <p>OnePasswordAuthSecretRef holds secret references for 1Password credentials.</p>
  5436. </p>
  5437. <table>
  5438. <thead>
  5439. <tr>
  5440. <th>Field</th>
  5441. <th>Description</th>
  5442. </tr>
  5443. </thead>
  5444. <tbody>
  5445. <tr>
  5446. <td>
  5447. <code>connectTokenSecretRef</code></br>
  5448. <em>
  5449. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5450. External Secrets meta/v1.SecretKeySelector
  5451. </a>
  5452. </em>
  5453. </td>
  5454. <td>
  5455. <p>The ConnectToken is used for authentication to a 1Password Connect Server.</p>
  5456. </td>
  5457. </tr>
  5458. </tbody>
  5459. </table>
  5460. <h3 id="external-secrets.io/v1beta1.OnePasswordProvider">OnePasswordProvider
  5461. </h3>
  5462. <p>
  5463. (<em>Appears on:</em>
  5464. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5465. </p>
  5466. <p>
  5467. <p>OnePasswordProvider configures a store to sync secrets using the 1Password Secret Manager provider.</p>
  5468. </p>
  5469. <table>
  5470. <thead>
  5471. <tr>
  5472. <th>Field</th>
  5473. <th>Description</th>
  5474. </tr>
  5475. </thead>
  5476. <tbody>
  5477. <tr>
  5478. <td>
  5479. <code>auth</code></br>
  5480. <em>
  5481. <a href="#external-secrets.io/v1beta1.OnePasswordAuth">
  5482. OnePasswordAuth
  5483. </a>
  5484. </em>
  5485. </td>
  5486. <td>
  5487. <p>Auth defines the information necessary to authenticate against OnePassword Connect Server</p>
  5488. </td>
  5489. </tr>
  5490. <tr>
  5491. <td>
  5492. <code>connectHost</code></br>
  5493. <em>
  5494. string
  5495. </em>
  5496. </td>
  5497. <td>
  5498. <p>ConnectHost defines the OnePassword Connect Server to connect to</p>
  5499. </td>
  5500. </tr>
  5501. <tr>
  5502. <td>
  5503. <code>vaults</code></br>
  5504. <em>
  5505. map[string]int
  5506. </em>
  5507. </td>
  5508. <td>
  5509. <p>Vaults defines which OnePassword vaults to search in which order</p>
  5510. </td>
  5511. </tr>
  5512. </tbody>
  5513. </table>
  5514. <h3 id="external-secrets.io/v1beta1.OracleAuth">OracleAuth
  5515. </h3>
  5516. <p>
  5517. (<em>Appears on:</em>
  5518. <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
  5519. </p>
  5520. <p>
  5521. </p>
  5522. <table>
  5523. <thead>
  5524. <tr>
  5525. <th>Field</th>
  5526. <th>Description</th>
  5527. </tr>
  5528. </thead>
  5529. <tbody>
  5530. <tr>
  5531. <td>
  5532. <code>tenancy</code></br>
  5533. <em>
  5534. string
  5535. </em>
  5536. </td>
  5537. <td>
  5538. <p>Tenancy is the tenancy OCID where user is located.</p>
  5539. </td>
  5540. </tr>
  5541. <tr>
  5542. <td>
  5543. <code>user</code></br>
  5544. <em>
  5545. string
  5546. </em>
  5547. </td>
  5548. <td>
  5549. <p>User is an access OCID specific to the account.</p>
  5550. </td>
  5551. </tr>
  5552. <tr>
  5553. <td>
  5554. <code>secretRef</code></br>
  5555. <em>
  5556. <a href="#external-secrets.io/v1beta1.OracleSecretRef">
  5557. OracleSecretRef
  5558. </a>
  5559. </em>
  5560. </td>
  5561. <td>
  5562. <p>SecretRef to pass through sensitive information.</p>
  5563. </td>
  5564. </tr>
  5565. </tbody>
  5566. </table>
  5567. <h3 id="external-secrets.io/v1beta1.OraclePrincipalType">OraclePrincipalType
  5568. (<code>string</code> alias)</p></h3>
  5569. <p>
  5570. (<em>Appears on:</em>
  5571. <a href="#external-secrets.io/v1beta1.OracleProvider">OracleProvider</a>)
  5572. </p>
  5573. <p>
  5574. </p>
  5575. <table>
  5576. <thead>
  5577. <tr>
  5578. <th>Value</th>
  5579. <th>Description</th>
  5580. </tr>
  5581. </thead>
  5582. <tbody><tr><td><p>&#34;InstancePrincipal&#34;</p></td>
  5583. <td><p>InstancePrincipal represents a instance principal.</p>
  5584. </td>
  5585. </tr><tr><td><p>&#34;UserPrincipal&#34;</p></td>
  5586. <td><p>UserPrincipal represents a user principal.</p>
  5587. </td>
  5588. </tr><tr><td><p>&#34;Workload&#34;</p></td>
  5589. <td><p>WorkloadPrincipal represents a workload principal.</p>
  5590. </td>
  5591. </tr></tbody>
  5592. </table>
  5593. <h3 id="external-secrets.io/v1beta1.OracleProvider">OracleProvider
  5594. </h3>
  5595. <p>
  5596. (<em>Appears on:</em>
  5597. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5598. </p>
  5599. <p>
  5600. <p>Configures an store to sync secrets using a Oracle Vault
  5601. backend.</p>
  5602. </p>
  5603. <table>
  5604. <thead>
  5605. <tr>
  5606. <th>Field</th>
  5607. <th>Description</th>
  5608. </tr>
  5609. </thead>
  5610. <tbody>
  5611. <tr>
  5612. <td>
  5613. <code>region</code></br>
  5614. <em>
  5615. string
  5616. </em>
  5617. </td>
  5618. <td>
  5619. <p>Region is the region where vault is located.</p>
  5620. </td>
  5621. </tr>
  5622. <tr>
  5623. <td>
  5624. <code>vault</code></br>
  5625. <em>
  5626. string
  5627. </em>
  5628. </td>
  5629. <td>
  5630. <p>Vault is the vault&rsquo;s OCID of the specific vault where secret is located.</p>
  5631. </td>
  5632. </tr>
  5633. <tr>
  5634. <td>
  5635. <code>compartment</code></br>
  5636. <em>
  5637. string
  5638. </em>
  5639. </td>
  5640. <td>
  5641. <em>(Optional)</em>
  5642. <p>Compartment is the vault compartment OCID.
  5643. Required for PushSecret</p>
  5644. </td>
  5645. </tr>
  5646. <tr>
  5647. <td>
  5648. <code>encryptionKey</code></br>
  5649. <em>
  5650. string
  5651. </em>
  5652. </td>
  5653. <td>
  5654. <em>(Optional)</em>
  5655. <p>EncryptionKey is the OCID of the encryption key within the vault.
  5656. Required for PushSecret</p>
  5657. </td>
  5658. </tr>
  5659. <tr>
  5660. <td>
  5661. <code>principalType</code></br>
  5662. <em>
  5663. <a href="#external-secrets.io/v1beta1.OraclePrincipalType">
  5664. OraclePrincipalType
  5665. </a>
  5666. </em>
  5667. </td>
  5668. <td>
  5669. <em>(Optional)</em>
  5670. <p>The type of principal to use for authentication. If left blank, the Auth struct will
  5671. determine the principal type. This optional field must be specified if using
  5672. workload identity.</p>
  5673. </td>
  5674. </tr>
  5675. <tr>
  5676. <td>
  5677. <code>auth</code></br>
  5678. <em>
  5679. <a href="#external-secrets.io/v1beta1.OracleAuth">
  5680. OracleAuth
  5681. </a>
  5682. </em>
  5683. </td>
  5684. <td>
  5685. <em>(Optional)</em>
  5686. <p>Auth configures how secret-manager authenticates with the Oracle Vault.
  5687. If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
  5688. </td>
  5689. </tr>
  5690. <tr>
  5691. <td>
  5692. <code>serviceAccountRef</code></br>
  5693. <em>
  5694. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  5695. External Secrets meta/v1.ServiceAccountSelector
  5696. </a>
  5697. </em>
  5698. </td>
  5699. <td>
  5700. <em>(Optional)</em>
  5701. <p>ServiceAccountRef specified the service account
  5702. that should be used when authenticating with WorkloadIdentity.</p>
  5703. </td>
  5704. </tr>
  5705. </tbody>
  5706. </table>
  5707. <h3 id="external-secrets.io/v1beta1.OracleSecretRef">OracleSecretRef
  5708. </h3>
  5709. <p>
  5710. (<em>Appears on:</em>
  5711. <a href="#external-secrets.io/v1beta1.OracleAuth">OracleAuth</a>)
  5712. </p>
  5713. <p>
  5714. </p>
  5715. <table>
  5716. <thead>
  5717. <tr>
  5718. <th>Field</th>
  5719. <th>Description</th>
  5720. </tr>
  5721. </thead>
  5722. <tbody>
  5723. <tr>
  5724. <td>
  5725. <code>privatekey</code></br>
  5726. <em>
  5727. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5728. External Secrets meta/v1.SecretKeySelector
  5729. </a>
  5730. </em>
  5731. </td>
  5732. <td>
  5733. <p>PrivateKey is the user&rsquo;s API Signing Key in PEM format, used for authentication.</p>
  5734. </td>
  5735. </tr>
  5736. <tr>
  5737. <td>
  5738. <code>fingerprint</code></br>
  5739. <em>
  5740. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5741. External Secrets meta/v1.SecretKeySelector
  5742. </a>
  5743. </em>
  5744. </td>
  5745. <td>
  5746. <p>Fingerprint is the fingerprint of the API private key.</p>
  5747. </td>
  5748. </tr>
  5749. </tbody>
  5750. </table>
  5751. <h3 id="external-secrets.io/v1beta1.Provider">Provider
  5752. </h3>
  5753. <p>
  5754. <p>Provider is a common interface for interacting with secret backends.</p>
  5755. </p>
  5756. <h3 id="external-secrets.io/v1beta1.PulumiProvider">PulumiProvider
  5757. </h3>
  5758. <p>
  5759. (<em>Appears on:</em>
  5760. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5761. </p>
  5762. <p>
  5763. </p>
  5764. <table>
  5765. <thead>
  5766. <tr>
  5767. <th>Field</th>
  5768. <th>Description</th>
  5769. </tr>
  5770. </thead>
  5771. <tbody>
  5772. <tr>
  5773. <td>
  5774. <code>apiUrl</code></br>
  5775. <em>
  5776. string
  5777. </em>
  5778. </td>
  5779. <td>
  5780. <p>APIURL is the URL of the Pulumi API.</p>
  5781. </td>
  5782. </tr>
  5783. <tr>
  5784. <td>
  5785. <code>accessToken</code></br>
  5786. <em>
  5787. <a href="#external-secrets.io/v1beta1.PulumiProviderSecretRef">
  5788. PulumiProviderSecretRef
  5789. </a>
  5790. </em>
  5791. </td>
  5792. <td>
  5793. <p>AccessToken is the access tokens to sign in to the Pulumi Cloud Console.</p>
  5794. </td>
  5795. </tr>
  5796. <tr>
  5797. <td>
  5798. <code>organization</code></br>
  5799. <em>
  5800. string
  5801. </em>
  5802. </td>
  5803. <td>
  5804. <p>Organization are a space to collaborate on shared projects and stacks.
  5805. To create a new organization, visit <a href="https://app.pulumi.com/">https://app.pulumi.com/</a> and click &ldquo;New Organization&rdquo;.</p>
  5806. </td>
  5807. </tr>
  5808. <tr>
  5809. <td>
  5810. <code>environment</code></br>
  5811. <em>
  5812. string
  5813. </em>
  5814. </td>
  5815. <td>
  5816. <p>Environment are YAML documents composed of static key-value pairs, programmatic expressions,
  5817. dynamically retrieved values from supported providers including all major clouds,
  5818. and other Pulumi ESC environments.
  5819. To create a new environment, visit <a href="https://www.pulumi.com/docs/esc/environments/">https://www.pulumi.com/docs/esc/environments/</a> for more information.</p>
  5820. </td>
  5821. </tr>
  5822. </tbody>
  5823. </table>
  5824. <h3 id="external-secrets.io/v1beta1.PulumiProviderSecretRef">PulumiProviderSecretRef
  5825. </h3>
  5826. <p>
  5827. (<em>Appears on:</em>
  5828. <a href="#external-secrets.io/v1beta1.PulumiProvider">PulumiProvider</a>)
  5829. </p>
  5830. <p>
  5831. </p>
  5832. <table>
  5833. <thead>
  5834. <tr>
  5835. <th>Field</th>
  5836. <th>Description</th>
  5837. </tr>
  5838. </thead>
  5839. <tbody>
  5840. <tr>
  5841. <td>
  5842. <code>secretRef</code></br>
  5843. <em>
  5844. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5845. External Secrets meta/v1.SecretKeySelector
  5846. </a>
  5847. </em>
  5848. </td>
  5849. <td>
  5850. <p>SecretRef is a reference to a secret containing the Pulumi API token.</p>
  5851. </td>
  5852. </tr>
  5853. </tbody>
  5854. </table>
  5855. <h3 id="external-secrets.io/v1beta1.PushSecretData">PushSecretData
  5856. </h3>
  5857. <p>
  5858. <p>PushSecretData is an interface to allow using v1alpha1.PushSecretData content in Provider registered in v1beta1.</p>
  5859. </p>
  5860. <h3 id="external-secrets.io/v1beta1.PushSecretRemoteRef">PushSecretRemoteRef
  5861. </h3>
  5862. <p>
  5863. <p>PushSecretRemoteRef is an interface to allow using v1alpha1.PushSecretRemoteRef in Provider registered in v1beta1.</p>
  5864. </p>
  5865. <h3 id="external-secrets.io/v1beta1.ScalewayProvider">ScalewayProvider
  5866. </h3>
  5867. <p>
  5868. (<em>Appears on:</em>
  5869. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  5870. </p>
  5871. <p>
  5872. </p>
  5873. <table>
  5874. <thead>
  5875. <tr>
  5876. <th>Field</th>
  5877. <th>Description</th>
  5878. </tr>
  5879. </thead>
  5880. <tbody>
  5881. <tr>
  5882. <td>
  5883. <code>apiUrl</code></br>
  5884. <em>
  5885. string
  5886. </em>
  5887. </td>
  5888. <td>
  5889. <em>(Optional)</em>
  5890. <p>APIURL is the url of the api to use. Defaults to <a href="https://api.scaleway.com">https://api.scaleway.com</a></p>
  5891. </td>
  5892. </tr>
  5893. <tr>
  5894. <td>
  5895. <code>region</code></br>
  5896. <em>
  5897. string
  5898. </em>
  5899. </td>
  5900. <td>
  5901. <p>Region where your secrets are located: <a href="https://developers.scaleway.com/en/quickstart/#region-and-zone">https://developers.scaleway.com/en/quickstart/#region-and-zone</a></p>
  5902. </td>
  5903. </tr>
  5904. <tr>
  5905. <td>
  5906. <code>projectId</code></br>
  5907. <em>
  5908. string
  5909. </em>
  5910. </td>
  5911. <td>
  5912. <p>ProjectID is the id of your project, which you can find in the console: <a href="https://console.scaleway.com/project/settings">https://console.scaleway.com/project/settings</a></p>
  5913. </td>
  5914. </tr>
  5915. <tr>
  5916. <td>
  5917. <code>accessKey</code></br>
  5918. <em>
  5919. <a href="#external-secrets.io/v1beta1.ScalewayProviderSecretRef">
  5920. ScalewayProviderSecretRef
  5921. </a>
  5922. </em>
  5923. </td>
  5924. <td>
  5925. <p>AccessKey is the non-secret part of the api key.</p>
  5926. </td>
  5927. </tr>
  5928. <tr>
  5929. <td>
  5930. <code>secretKey</code></br>
  5931. <em>
  5932. <a href="#external-secrets.io/v1beta1.ScalewayProviderSecretRef">
  5933. ScalewayProviderSecretRef
  5934. </a>
  5935. </em>
  5936. </td>
  5937. <td>
  5938. <p>SecretKey is the non-secret part of the api key.</p>
  5939. </td>
  5940. </tr>
  5941. </tbody>
  5942. </table>
  5943. <h3 id="external-secrets.io/v1beta1.ScalewayProviderSecretRef">ScalewayProviderSecretRef
  5944. </h3>
  5945. <p>
  5946. (<em>Appears on:</em>
  5947. <a href="#external-secrets.io/v1beta1.ScalewayProvider">ScalewayProvider</a>)
  5948. </p>
  5949. <p>
  5950. </p>
  5951. <table>
  5952. <thead>
  5953. <tr>
  5954. <th>Field</th>
  5955. <th>Description</th>
  5956. </tr>
  5957. </thead>
  5958. <tbody>
  5959. <tr>
  5960. <td>
  5961. <code>value</code></br>
  5962. <em>
  5963. string
  5964. </em>
  5965. </td>
  5966. <td>
  5967. <em>(Optional)</em>
  5968. <p>Value can be specified directly to set a value without using a secret.</p>
  5969. </td>
  5970. </tr>
  5971. <tr>
  5972. <td>
  5973. <code>secretRef</code></br>
  5974. <em>
  5975. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  5976. External Secrets meta/v1.SecretKeySelector
  5977. </a>
  5978. </em>
  5979. </td>
  5980. <td>
  5981. <em>(Optional)</em>
  5982. <p>SecretRef references a key in a secret that will be used as value.</p>
  5983. </td>
  5984. </tr>
  5985. </tbody>
  5986. </table>
  5987. <h3 id="external-secrets.io/v1beta1.SecretStore">SecretStore
  5988. </h3>
  5989. <p>
  5990. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  5991. </p>
  5992. <table>
  5993. <thead>
  5994. <tr>
  5995. <th>Field</th>
  5996. <th>Description</th>
  5997. </tr>
  5998. </thead>
  5999. <tbody>
  6000. <tr>
  6001. <td>
  6002. <code>metadata</code></br>
  6003. <em>
  6004. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
  6005. Kubernetes meta/v1.ObjectMeta
  6006. </a>
  6007. </em>
  6008. </td>
  6009. <td>
  6010. Refer to the Kubernetes API documentation for the fields of the
  6011. <code>metadata</code> field.
  6012. </td>
  6013. </tr>
  6014. <tr>
  6015. <td>
  6016. <code>spec</code></br>
  6017. <em>
  6018. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">
  6019. SecretStoreSpec
  6020. </a>
  6021. </em>
  6022. </td>
  6023. <td>
  6024. <br/>
  6025. <br/>
  6026. <table>
  6027. <tr>
  6028. <td>
  6029. <code>controller</code></br>
  6030. <em>
  6031. string
  6032. </em>
  6033. </td>
  6034. <td>
  6035. <em>(Optional)</em>
  6036. <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
  6037. The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
  6038. </td>
  6039. </tr>
  6040. <tr>
  6041. <td>
  6042. <code>provider</code></br>
  6043. <em>
  6044. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  6045. SecretStoreProvider
  6046. </a>
  6047. </em>
  6048. </td>
  6049. <td>
  6050. <p>Used to configure the provider. Only one provider may be set</p>
  6051. </td>
  6052. </tr>
  6053. <tr>
  6054. <td>
  6055. <code>retrySettings</code></br>
  6056. <em>
  6057. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  6058. SecretStoreRetrySettings
  6059. </a>
  6060. </em>
  6061. </td>
  6062. <td>
  6063. <em>(Optional)</em>
  6064. <p>Used to configure http retries if failed</p>
  6065. </td>
  6066. </tr>
  6067. <tr>
  6068. <td>
  6069. <code>refreshInterval</code></br>
  6070. <em>
  6071. int
  6072. </em>
  6073. </td>
  6074. <td>
  6075. <em>(Optional)</em>
  6076. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  6077. </td>
  6078. </tr>
  6079. <tr>
  6080. <td>
  6081. <code>conditions</code></br>
  6082. <em>
  6083. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  6084. []ClusterSecretStoreCondition
  6085. </a>
  6086. </em>
  6087. </td>
  6088. <td>
  6089. <em>(Optional)</em>
  6090. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  6091. </td>
  6092. </tr>
  6093. </table>
  6094. </td>
  6095. </tr>
  6096. <tr>
  6097. <td>
  6098. <code>status</code></br>
  6099. <em>
  6100. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">
  6101. SecretStoreStatus
  6102. </a>
  6103. </em>
  6104. </td>
  6105. <td>
  6106. </td>
  6107. </tr>
  6108. </tbody>
  6109. </table>
  6110. <h3 id="external-secrets.io/v1beta1.SecretStoreCapabilities">SecretStoreCapabilities
  6111. (<code>string</code> alias)</p></h3>
  6112. <p>
  6113. (<em>Appears on:</em>
  6114. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  6115. </p>
  6116. <p>
  6117. <p>SecretStoreCapabilities defines the possible operations a SecretStore can do.</p>
  6118. </p>
  6119. <table>
  6120. <thead>
  6121. <tr>
  6122. <th>Value</th>
  6123. <th>Description</th>
  6124. </tr>
  6125. </thead>
  6126. <tbody><tr><td><p>&#34;ReadOnly&#34;</p></td>
  6127. <td></td>
  6128. </tr><tr><td><p>&#34;ReadWrite&#34;</p></td>
  6129. <td></td>
  6130. </tr><tr><td><p>&#34;WriteOnly&#34;</p></td>
  6131. <td></td>
  6132. </tr></tbody>
  6133. </table>
  6134. <h3 id="external-secrets.io/v1beta1.SecretStoreConditionType">SecretStoreConditionType
  6135. (<code>string</code> alias)</p></h3>
  6136. <p>
  6137. (<em>Appears on:</em>
  6138. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  6139. </p>
  6140. <p>
  6141. </p>
  6142. <table>
  6143. <thead>
  6144. <tr>
  6145. <th>Value</th>
  6146. <th>Description</th>
  6147. </tr>
  6148. </thead>
  6149. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  6150. <td></td>
  6151. </tr></tbody>
  6152. </table>
  6153. <h3 id="external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider
  6154. </h3>
  6155. <p>
  6156. (<em>Appears on:</em>
  6157. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  6158. </p>
  6159. <p>
  6160. <p>SecretStoreProvider contains the provider-specific configuration.</p>
  6161. </p>
  6162. <table>
  6163. <thead>
  6164. <tr>
  6165. <th>Field</th>
  6166. <th>Description</th>
  6167. </tr>
  6168. </thead>
  6169. <tbody>
  6170. <tr>
  6171. <td>
  6172. <code>aws</code></br>
  6173. <em>
  6174. <a href="#external-secrets.io/v1beta1.AWSProvider">
  6175. AWSProvider
  6176. </a>
  6177. </em>
  6178. </td>
  6179. <td>
  6180. <em>(Optional)</em>
  6181. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  6182. </td>
  6183. </tr>
  6184. <tr>
  6185. <td>
  6186. <code>azurekv</code></br>
  6187. <em>
  6188. <a href="#external-secrets.io/v1beta1.AzureKVProvider">
  6189. AzureKVProvider
  6190. </a>
  6191. </em>
  6192. </td>
  6193. <td>
  6194. <em>(Optional)</em>
  6195. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  6196. </td>
  6197. </tr>
  6198. <tr>
  6199. <td>
  6200. <code>akeyless</code></br>
  6201. <em>
  6202. <a href="#external-secrets.io/v1beta1.AkeylessProvider">
  6203. AkeylessProvider
  6204. </a>
  6205. </em>
  6206. </td>
  6207. <td>
  6208. <em>(Optional)</em>
  6209. <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
  6210. </td>
  6211. </tr>
  6212. <tr>
  6213. <td>
  6214. <code>vault</code></br>
  6215. <em>
  6216. <a href="#external-secrets.io/v1beta1.VaultProvider">
  6217. VaultProvider
  6218. </a>
  6219. </em>
  6220. </td>
  6221. <td>
  6222. <em>(Optional)</em>
  6223. <p>Vault configures this store to sync secrets using Hashi provider</p>
  6224. </td>
  6225. </tr>
  6226. <tr>
  6227. <td>
  6228. <code>gcpsm</code></br>
  6229. <em>
  6230. <a href="#external-secrets.io/v1beta1.GCPSMProvider">
  6231. GCPSMProvider
  6232. </a>
  6233. </em>
  6234. </td>
  6235. <td>
  6236. <em>(Optional)</em>
  6237. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  6238. </td>
  6239. </tr>
  6240. <tr>
  6241. <td>
  6242. <code>oracle</code></br>
  6243. <em>
  6244. <a href="#external-secrets.io/v1beta1.OracleProvider">
  6245. OracleProvider
  6246. </a>
  6247. </em>
  6248. </td>
  6249. <td>
  6250. <em>(Optional)</em>
  6251. <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
  6252. </td>
  6253. </tr>
  6254. <tr>
  6255. <td>
  6256. <code>ibm</code></br>
  6257. <em>
  6258. <a href="#external-secrets.io/v1beta1.IBMProvider">
  6259. IBMProvider
  6260. </a>
  6261. </em>
  6262. </td>
  6263. <td>
  6264. <em>(Optional)</em>
  6265. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
  6266. </td>
  6267. </tr>
  6268. <tr>
  6269. <td>
  6270. <code>yandexcertificatemanager</code></br>
  6271. <em>
  6272. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">
  6273. YandexCertificateManagerProvider
  6274. </a>
  6275. </em>
  6276. </td>
  6277. <td>
  6278. <em>(Optional)</em>
  6279. <p>YandexCertificateManager configures this store to sync secrets using Yandex Certificate Manager provider</p>
  6280. </td>
  6281. </tr>
  6282. <tr>
  6283. <td>
  6284. <code>yandexlockbox</code></br>
  6285. <em>
  6286. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">
  6287. YandexLockboxProvider
  6288. </a>
  6289. </em>
  6290. </td>
  6291. <td>
  6292. <em>(Optional)</em>
  6293. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
  6294. </td>
  6295. </tr>
  6296. <tr>
  6297. <td>
  6298. <code>gitlab</code></br>
  6299. <em>
  6300. <a href="#external-secrets.io/v1beta1.GitlabProvider">
  6301. GitlabProvider
  6302. </a>
  6303. </em>
  6304. </td>
  6305. <td>
  6306. <em>(Optional)</em>
  6307. <p>GitLab configures this store to sync secrets using GitLab Variables provider</p>
  6308. </td>
  6309. </tr>
  6310. <tr>
  6311. <td>
  6312. <code>alibaba</code></br>
  6313. <em>
  6314. <a href="#external-secrets.io/v1beta1.AlibabaProvider">
  6315. AlibabaProvider
  6316. </a>
  6317. </em>
  6318. </td>
  6319. <td>
  6320. <em>(Optional)</em>
  6321. <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
  6322. </td>
  6323. </tr>
  6324. <tr>
  6325. <td>
  6326. <code>onepassword</code></br>
  6327. <em>
  6328. <a href="#external-secrets.io/v1beta1.OnePasswordProvider">
  6329. OnePasswordProvider
  6330. </a>
  6331. </em>
  6332. </td>
  6333. <td>
  6334. <em>(Optional)</em>
  6335. <p>OnePassword configures this store to sync secrets using the 1Password Cloud provider</p>
  6336. </td>
  6337. </tr>
  6338. <tr>
  6339. <td>
  6340. <code>webhook</code></br>
  6341. <em>
  6342. <a href="#external-secrets.io/v1beta1.WebhookProvider">
  6343. WebhookProvider
  6344. </a>
  6345. </em>
  6346. </td>
  6347. <td>
  6348. <em>(Optional)</em>
  6349. <p>Webhook configures this store to sync secrets using a generic templated webhook</p>
  6350. </td>
  6351. </tr>
  6352. <tr>
  6353. <td>
  6354. <code>kubernetes</code></br>
  6355. <em>
  6356. <a href="#external-secrets.io/v1beta1.KubernetesProvider">
  6357. KubernetesProvider
  6358. </a>
  6359. </em>
  6360. </td>
  6361. <td>
  6362. <em>(Optional)</em>
  6363. <p>Kubernetes configures this store to sync secrets using a Kubernetes cluster provider</p>
  6364. </td>
  6365. </tr>
  6366. <tr>
  6367. <td>
  6368. <code>fake</code></br>
  6369. <em>
  6370. <a href="#external-secrets.io/v1beta1.FakeProvider">
  6371. FakeProvider
  6372. </a>
  6373. </em>
  6374. </td>
  6375. <td>
  6376. <em>(Optional)</em>
  6377. <p>Fake configures a store with static key/value pairs</p>
  6378. </td>
  6379. </tr>
  6380. <tr>
  6381. <td>
  6382. <code>senhasegura</code></br>
  6383. <em>
  6384. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">
  6385. SenhaseguraProvider
  6386. </a>
  6387. </em>
  6388. </td>
  6389. <td>
  6390. <em>(Optional)</em>
  6391. <p>Senhasegura configures this store to sync secrets using senhasegura provider</p>
  6392. </td>
  6393. </tr>
  6394. <tr>
  6395. <td>
  6396. <code>scaleway</code></br>
  6397. <em>
  6398. <a href="#external-secrets.io/v1beta1.ScalewayProvider">
  6399. ScalewayProvider
  6400. </a>
  6401. </em>
  6402. </td>
  6403. <td>
  6404. <em>(Optional)</em>
  6405. <p>Scaleway</p>
  6406. </td>
  6407. </tr>
  6408. <tr>
  6409. <td>
  6410. <code>doppler</code></br>
  6411. <em>
  6412. <a href="#external-secrets.io/v1beta1.DopplerProvider">
  6413. DopplerProvider
  6414. </a>
  6415. </em>
  6416. </td>
  6417. <td>
  6418. <em>(Optional)</em>
  6419. <p>Doppler configures this store to sync secrets using the Doppler provider</p>
  6420. </td>
  6421. </tr>
  6422. <tr>
  6423. <td>
  6424. <code>keepersecurity</code></br>
  6425. <em>
  6426. <a href="#external-secrets.io/v1beta1.KeeperSecurityProvider">
  6427. KeeperSecurityProvider
  6428. </a>
  6429. </em>
  6430. </td>
  6431. <td>
  6432. <em>(Optional)</em>
  6433. <p>KeeperSecurity configures this store to sync secrets using the KeeperSecurity provider</p>
  6434. </td>
  6435. </tr>
  6436. <tr>
  6437. <td>
  6438. <code>conjur</code></br>
  6439. <em>
  6440. <a href="#external-secrets.io/v1beta1.ConjurProvider">
  6441. ConjurProvider
  6442. </a>
  6443. </em>
  6444. </td>
  6445. <td>
  6446. <em>(Optional)</em>
  6447. <p>Conjur configures this store to sync secrets using conjur provider</p>
  6448. </td>
  6449. </tr>
  6450. <tr>
  6451. <td>
  6452. <code>delinea</code></br>
  6453. <em>
  6454. <a href="#external-secrets.io/v1beta1.DelineaProvider">
  6455. DelineaProvider
  6456. </a>
  6457. </em>
  6458. </td>
  6459. <td>
  6460. <em>(Optional)</em>
  6461. <p>Delinea DevOps Secrets Vault
  6462. <a href="https://docs.delinea.com/online-help/products/devops-secrets-vault/current">https://docs.delinea.com/online-help/products/devops-secrets-vault/current</a></p>
  6463. </td>
  6464. </tr>
  6465. <tr>
  6466. <td>
  6467. <code>chef</code></br>
  6468. <em>
  6469. <a href="#external-secrets.io/v1beta1.ChefProvider">
  6470. ChefProvider
  6471. </a>
  6472. </em>
  6473. </td>
  6474. <td>
  6475. <em>(Optional)</em>
  6476. <p>Chef configures this store to sync secrets with chef server</p>
  6477. </td>
  6478. </tr>
  6479. <tr>
  6480. <td>
  6481. <code>pulumi</code></br>
  6482. <em>
  6483. <a href="#external-secrets.io/v1beta1.PulumiProvider">
  6484. PulumiProvider
  6485. </a>
  6486. </em>
  6487. </td>
  6488. <td>
  6489. <em>(Optional)</em>
  6490. <p>Pulumi configures this store to sync secrets using the Pulumi provider</p>
  6491. </td>
  6492. </tr>
  6493. </tbody>
  6494. </table>
  6495. <h3 id="external-secrets.io/v1beta1.SecretStoreRef">SecretStoreRef
  6496. </h3>
  6497. <p>
  6498. (<em>Appears on:</em>
  6499. <a href="#external-secrets.io/v1beta1.ExternalSecretSpec">ExternalSecretSpec</a>,
  6500. <a href="#external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef</a>,
  6501. <a href="#external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef</a>)
  6502. </p>
  6503. <p>
  6504. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  6505. </p>
  6506. <table>
  6507. <thead>
  6508. <tr>
  6509. <th>Field</th>
  6510. <th>Description</th>
  6511. </tr>
  6512. </thead>
  6513. <tbody>
  6514. <tr>
  6515. <td>
  6516. <code>name</code></br>
  6517. <em>
  6518. string
  6519. </em>
  6520. </td>
  6521. <td>
  6522. <p>Name of the SecretStore resource</p>
  6523. </td>
  6524. </tr>
  6525. <tr>
  6526. <td>
  6527. <code>kind</code></br>
  6528. <em>
  6529. string
  6530. </em>
  6531. </td>
  6532. <td>
  6533. <em>(Optional)</em>
  6534. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  6535. Defaults to <code>SecretStore</code></p>
  6536. </td>
  6537. </tr>
  6538. </tbody>
  6539. </table>
  6540. <h3 id="external-secrets.io/v1beta1.SecretStoreRetrySettings">SecretStoreRetrySettings
  6541. </h3>
  6542. <p>
  6543. (<em>Appears on:</em>
  6544. <a href="#external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec</a>)
  6545. </p>
  6546. <p>
  6547. </p>
  6548. <table>
  6549. <thead>
  6550. <tr>
  6551. <th>Field</th>
  6552. <th>Description</th>
  6553. </tr>
  6554. </thead>
  6555. <tbody>
  6556. <tr>
  6557. <td>
  6558. <code>maxRetries</code></br>
  6559. <em>
  6560. int32
  6561. </em>
  6562. </td>
  6563. <td>
  6564. </td>
  6565. </tr>
  6566. <tr>
  6567. <td>
  6568. <code>retryInterval</code></br>
  6569. <em>
  6570. string
  6571. </em>
  6572. </td>
  6573. <td>
  6574. </td>
  6575. </tr>
  6576. </tbody>
  6577. </table>
  6578. <h3 id="external-secrets.io/v1beta1.SecretStoreSpec">SecretStoreSpec
  6579. </h3>
  6580. <p>
  6581. (<em>Appears on:</em>
  6582. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  6583. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  6584. </p>
  6585. <p>
  6586. <p>SecretStoreSpec defines the desired state of SecretStore.</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>controller</code></br>
  6599. <em>
  6600. string
  6601. </em>
  6602. </td>
  6603. <td>
  6604. <em>(Optional)</em>
  6605. <p>Used to select the correct ESO controller (think: ingress.ingressClassName)
  6606. The ESO controller is instantiated with a specific controller name and filters ES based on this property</p>
  6607. </td>
  6608. </tr>
  6609. <tr>
  6610. <td>
  6611. <code>provider</code></br>
  6612. <em>
  6613. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">
  6614. SecretStoreProvider
  6615. </a>
  6616. </em>
  6617. </td>
  6618. <td>
  6619. <p>Used to configure the provider. Only one provider may be set</p>
  6620. </td>
  6621. </tr>
  6622. <tr>
  6623. <td>
  6624. <code>retrySettings</code></br>
  6625. <em>
  6626. <a href="#external-secrets.io/v1beta1.SecretStoreRetrySettings">
  6627. SecretStoreRetrySettings
  6628. </a>
  6629. </em>
  6630. </td>
  6631. <td>
  6632. <em>(Optional)</em>
  6633. <p>Used to configure http retries if failed</p>
  6634. </td>
  6635. </tr>
  6636. <tr>
  6637. <td>
  6638. <code>refreshInterval</code></br>
  6639. <em>
  6640. int
  6641. </em>
  6642. </td>
  6643. <td>
  6644. <em>(Optional)</em>
  6645. <p>Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.</p>
  6646. </td>
  6647. </tr>
  6648. <tr>
  6649. <td>
  6650. <code>conditions</code></br>
  6651. <em>
  6652. <a href="#external-secrets.io/v1beta1.ClusterSecretStoreCondition">
  6653. []ClusterSecretStoreCondition
  6654. </a>
  6655. </em>
  6656. </td>
  6657. <td>
  6658. <em>(Optional)</em>
  6659. <p>Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore</p>
  6660. </td>
  6661. </tr>
  6662. </tbody>
  6663. </table>
  6664. <h3 id="external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus
  6665. </h3>
  6666. <p>
  6667. (<em>Appears on:</em>
  6668. <a href="#external-secrets.io/v1beta1.ClusterSecretStore">ClusterSecretStore</a>,
  6669. <a href="#external-secrets.io/v1beta1.SecretStore">SecretStore</a>)
  6670. </p>
  6671. <p>
  6672. <p>SecretStoreStatus defines the observed state of the SecretStore.</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>conditions</code></br>
  6685. <em>
  6686. <a href="#external-secrets.io/v1beta1.SecretStoreStatusCondition">
  6687. []SecretStoreStatusCondition
  6688. </a>
  6689. </em>
  6690. </td>
  6691. <td>
  6692. <em>(Optional)</em>
  6693. </td>
  6694. </tr>
  6695. <tr>
  6696. <td>
  6697. <code>capabilities</code></br>
  6698. <em>
  6699. <a href="#external-secrets.io/v1beta1.SecretStoreCapabilities">
  6700. SecretStoreCapabilities
  6701. </a>
  6702. </em>
  6703. </td>
  6704. <td>
  6705. <em>(Optional)</em>
  6706. </td>
  6707. </tr>
  6708. </tbody>
  6709. </table>
  6710. <h3 id="external-secrets.io/v1beta1.SecretStoreStatusCondition">SecretStoreStatusCondition
  6711. </h3>
  6712. <p>
  6713. (<em>Appears on:</em>
  6714. <a href="#external-secrets.io/v1beta1.SecretStoreStatus">SecretStoreStatus</a>)
  6715. </p>
  6716. <p>
  6717. </p>
  6718. <table>
  6719. <thead>
  6720. <tr>
  6721. <th>Field</th>
  6722. <th>Description</th>
  6723. </tr>
  6724. </thead>
  6725. <tbody>
  6726. <tr>
  6727. <td>
  6728. <code>type</code></br>
  6729. <em>
  6730. <a href="#external-secrets.io/v1beta1.SecretStoreConditionType">
  6731. SecretStoreConditionType
  6732. </a>
  6733. </em>
  6734. </td>
  6735. <td>
  6736. </td>
  6737. </tr>
  6738. <tr>
  6739. <td>
  6740. <code>status</code></br>
  6741. <em>
  6742. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#conditionstatus-v1-core">
  6743. Kubernetes core/v1.ConditionStatus
  6744. </a>
  6745. </em>
  6746. </td>
  6747. <td>
  6748. </td>
  6749. </tr>
  6750. <tr>
  6751. <td>
  6752. <code>reason</code></br>
  6753. <em>
  6754. string
  6755. </em>
  6756. </td>
  6757. <td>
  6758. <em>(Optional)</em>
  6759. </td>
  6760. </tr>
  6761. <tr>
  6762. <td>
  6763. <code>message</code></br>
  6764. <em>
  6765. string
  6766. </em>
  6767. </td>
  6768. <td>
  6769. <em>(Optional)</em>
  6770. </td>
  6771. </tr>
  6772. <tr>
  6773. <td>
  6774. <code>lastTransitionTime</code></br>
  6775. <em>
  6776. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
  6777. Kubernetes meta/v1.Time
  6778. </a>
  6779. </em>
  6780. </td>
  6781. <td>
  6782. <em>(Optional)</em>
  6783. </td>
  6784. </tr>
  6785. </tbody>
  6786. </table>
  6787. <h3 id="external-secrets.io/v1beta1.SecretsClient">SecretsClient
  6788. </h3>
  6789. <p>
  6790. <p>SecretsClient provides access to secrets.</p>
  6791. </p>
  6792. <h3 id="external-secrets.io/v1beta1.SecretsManager">SecretsManager
  6793. </h3>
  6794. <p>
  6795. (<em>Appears on:</em>
  6796. <a href="#external-secrets.io/v1beta1.AWSProvider">AWSProvider</a>)
  6797. </p>
  6798. <p>
  6799. <p>SecretsManager defines how the provider behaves when interacting with AWS
  6800. SecretsManager. Some of these settings are only applicable to controlling how
  6801. secrets are deleted, and hence only apply to PushSecret (and only when
  6802. deletionPolicy is set to Delete).</p>
  6803. </p>
  6804. <table>
  6805. <thead>
  6806. <tr>
  6807. <th>Field</th>
  6808. <th>Description</th>
  6809. </tr>
  6810. </thead>
  6811. <tbody>
  6812. <tr>
  6813. <td>
  6814. <code>forceDeleteWithoutRecovery</code></br>
  6815. <em>
  6816. bool
  6817. </em>
  6818. </td>
  6819. <td>
  6820. <em>(Optional)</em>
  6821. <p>Specifies whether to delete the secret without any recovery window. You
  6822. can&rsquo;t use both this parameter and RecoveryWindowInDays in the same call.
  6823. If you don&rsquo;t use either, then by default Secrets Manager uses a 30 day
  6824. recovery window.
  6825. see: <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-ForceDeleteWithoutRecovery">https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-ForceDeleteWithoutRecovery</a></p>
  6826. </td>
  6827. </tr>
  6828. <tr>
  6829. <td>
  6830. <code>recoveryWindowInDays</code></br>
  6831. <em>
  6832. int64
  6833. </em>
  6834. </td>
  6835. <td>
  6836. <em>(Optional)</em>
  6837. <p>The number of days from 7 to 30 that Secrets Manager waits before
  6838. permanently deleting the secret. You can&rsquo;t use both this parameter and
  6839. ForceDeleteWithoutRecovery in the same call. If you don&rsquo;t use either,
  6840. then by default Secrets Manager uses a 30 day recovery window.
  6841. see: <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-RecoveryWindowInDays">https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-RecoveryWindowInDays</a></p>
  6842. </td>
  6843. </tr>
  6844. </tbody>
  6845. </table>
  6846. <h3 id="external-secrets.io/v1beta1.SenhaseguraAuth">SenhaseguraAuth
  6847. </h3>
  6848. <p>
  6849. (<em>Appears on:</em>
  6850. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  6851. </p>
  6852. <p>
  6853. <p>SenhaseguraAuth tells the controller how to do auth in senhasegura.</p>
  6854. </p>
  6855. <table>
  6856. <thead>
  6857. <tr>
  6858. <th>Field</th>
  6859. <th>Description</th>
  6860. </tr>
  6861. </thead>
  6862. <tbody>
  6863. <tr>
  6864. <td>
  6865. <code>clientId</code></br>
  6866. <em>
  6867. string
  6868. </em>
  6869. </td>
  6870. <td>
  6871. </td>
  6872. </tr>
  6873. <tr>
  6874. <td>
  6875. <code>clientSecretSecretRef</code></br>
  6876. <em>
  6877. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  6878. External Secrets meta/v1.SecretKeySelector
  6879. </a>
  6880. </em>
  6881. </td>
  6882. <td>
  6883. </td>
  6884. </tr>
  6885. </tbody>
  6886. </table>
  6887. <h3 id="external-secrets.io/v1beta1.SenhaseguraModuleType">SenhaseguraModuleType
  6888. (<code>string</code> alias)</p></h3>
  6889. <p>
  6890. (<em>Appears on:</em>
  6891. <a href="#external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider</a>)
  6892. </p>
  6893. <p>
  6894. <p>SenhaseguraModuleType enum defines senhasegura target module to fetch secrets</p>
  6895. </p>
  6896. <table>
  6897. <thead>
  6898. <tr>
  6899. <th>Value</th>
  6900. <th>Description</th>
  6901. </tr>
  6902. </thead>
  6903. <tbody><tr><td><p>&#34;DSM&#34;</p></td>
  6904. <td><pre><code> SenhaseguraModuleDSM is the senhasegura DevOps Secrets Management module
  6905. see: https://senhasegura.com/devops
  6906. </code></pre>
  6907. </td>
  6908. </tr></tbody>
  6909. </table>
  6910. <h3 id="external-secrets.io/v1beta1.SenhaseguraProvider">SenhaseguraProvider
  6911. </h3>
  6912. <p>
  6913. (<em>Appears on:</em>
  6914. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  6915. </p>
  6916. <p>
  6917. <p>SenhaseguraProvider setup a store to sync secrets with senhasegura.</p>
  6918. </p>
  6919. <table>
  6920. <thead>
  6921. <tr>
  6922. <th>Field</th>
  6923. <th>Description</th>
  6924. </tr>
  6925. </thead>
  6926. <tbody>
  6927. <tr>
  6928. <td>
  6929. <code>url</code></br>
  6930. <em>
  6931. string
  6932. </em>
  6933. </td>
  6934. <td>
  6935. <p>URL of senhasegura</p>
  6936. </td>
  6937. </tr>
  6938. <tr>
  6939. <td>
  6940. <code>module</code></br>
  6941. <em>
  6942. <a href="#external-secrets.io/v1beta1.SenhaseguraModuleType">
  6943. SenhaseguraModuleType
  6944. </a>
  6945. </em>
  6946. </td>
  6947. <td>
  6948. <p>Module defines which senhasegura module should be used to get secrets</p>
  6949. </td>
  6950. </tr>
  6951. <tr>
  6952. <td>
  6953. <code>auth</code></br>
  6954. <em>
  6955. <a href="#external-secrets.io/v1beta1.SenhaseguraAuth">
  6956. SenhaseguraAuth
  6957. </a>
  6958. </em>
  6959. </td>
  6960. <td>
  6961. <p>Auth defines parameters to authenticate in senhasegura</p>
  6962. </td>
  6963. </tr>
  6964. <tr>
  6965. <td>
  6966. <code>ignoreSslCertificate</code></br>
  6967. <em>
  6968. bool
  6969. </em>
  6970. </td>
  6971. <td>
  6972. <p>IgnoreSslCertificate defines if SSL certificate must be ignored</p>
  6973. </td>
  6974. </tr>
  6975. </tbody>
  6976. </table>
  6977. <h3 id="external-secrets.io/v1beta1.StoreGeneratorSourceRef">StoreGeneratorSourceRef
  6978. </h3>
  6979. <p>
  6980. (<em>Appears on:</em>
  6981. <a href="#external-secrets.io/v1beta1.ExternalSecretDataFromRemoteRef">ExternalSecretDataFromRemoteRef</a>)
  6982. </p>
  6983. <p>
  6984. <p>StoreGeneratorSourceRef allows you to override the source
  6985. from which the secret will be pulled from.
  6986. You can define at maximum one property.</p>
  6987. </p>
  6988. <table>
  6989. <thead>
  6990. <tr>
  6991. <th>Field</th>
  6992. <th>Description</th>
  6993. </tr>
  6994. </thead>
  6995. <tbody>
  6996. <tr>
  6997. <td>
  6998. <code>storeRef</code></br>
  6999. <em>
  7000. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  7001. SecretStoreRef
  7002. </a>
  7003. </em>
  7004. </td>
  7005. <td>
  7006. <em>(Optional)</em>
  7007. </td>
  7008. </tr>
  7009. <tr>
  7010. <td>
  7011. <code>generatorRef</code></br>
  7012. <em>
  7013. <a href="#external-secrets.io/v1beta1.GeneratorRef">
  7014. GeneratorRef
  7015. </a>
  7016. </em>
  7017. </td>
  7018. <td>
  7019. <em>(Optional)</em>
  7020. <p>GeneratorRef points to a generator custom resource.</p>
  7021. </td>
  7022. </tr>
  7023. </tbody>
  7024. </table>
  7025. <h3 id="external-secrets.io/v1beta1.StoreSourceRef">StoreSourceRef
  7026. </h3>
  7027. <p>
  7028. (<em>Appears on:</em>
  7029. <a href="#external-secrets.io/v1beta1.ExternalSecretData">ExternalSecretData</a>)
  7030. </p>
  7031. <p>
  7032. <p>StoreSourceRef allows you to override the SecretStore source
  7033. from which the secret will be pulled from.
  7034. You can define at maximum one property.</p>
  7035. </p>
  7036. <table>
  7037. <thead>
  7038. <tr>
  7039. <th>Field</th>
  7040. <th>Description</th>
  7041. </tr>
  7042. </thead>
  7043. <tbody>
  7044. <tr>
  7045. <td>
  7046. <code>storeRef</code></br>
  7047. <em>
  7048. <a href="#external-secrets.io/v1beta1.SecretStoreRef">
  7049. SecretStoreRef
  7050. </a>
  7051. </em>
  7052. </td>
  7053. <td>
  7054. <em>(Optional)</em>
  7055. </td>
  7056. </tr>
  7057. <tr>
  7058. <td>
  7059. <code>generatorRef</code></br>
  7060. <em>
  7061. <a href="#external-secrets.io/v1beta1.GeneratorRef">
  7062. GeneratorRef
  7063. </a>
  7064. </em>
  7065. </td>
  7066. <td>
  7067. <p>GeneratorRef points to a generator custom resource.</p>
  7068. <p>Deprecated: The generatorRef is not implemented in .data[].
  7069. this will be removed with v1.</p>
  7070. </td>
  7071. </tr>
  7072. </tbody>
  7073. </table>
  7074. <h3 id="external-secrets.io/v1beta1.Tag">Tag
  7075. </h3>
  7076. <p>
  7077. </p>
  7078. <table>
  7079. <thead>
  7080. <tr>
  7081. <th>Field</th>
  7082. <th>Description</th>
  7083. </tr>
  7084. </thead>
  7085. <tbody>
  7086. <tr>
  7087. <td>
  7088. <code>key</code></br>
  7089. <em>
  7090. string
  7091. </em>
  7092. </td>
  7093. <td>
  7094. </td>
  7095. </tr>
  7096. <tr>
  7097. <td>
  7098. <code>value</code></br>
  7099. <em>
  7100. string
  7101. </em>
  7102. </td>
  7103. <td>
  7104. </td>
  7105. </tr>
  7106. </tbody>
  7107. </table>
  7108. <h3 id="external-secrets.io/v1beta1.TemplateEngineVersion">TemplateEngineVersion
  7109. (<code>string</code> alias)</p></h3>
  7110. <p>
  7111. (<em>Appears on:</em>
  7112. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  7113. </p>
  7114. <p>
  7115. </p>
  7116. <table>
  7117. <thead>
  7118. <tr>
  7119. <th>Value</th>
  7120. <th>Description</th>
  7121. </tr>
  7122. </thead>
  7123. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  7124. <td></td>
  7125. </tr><tr><td><p>&#34;v2&#34;</p></td>
  7126. <td></td>
  7127. </tr></tbody>
  7128. </table>
  7129. <h3 id="external-secrets.io/v1beta1.TemplateFrom">TemplateFrom
  7130. </h3>
  7131. <p>
  7132. (<em>Appears on:</em>
  7133. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  7134. </p>
  7135. <p>
  7136. </p>
  7137. <table>
  7138. <thead>
  7139. <tr>
  7140. <th>Field</th>
  7141. <th>Description</th>
  7142. </tr>
  7143. </thead>
  7144. <tbody>
  7145. <tr>
  7146. <td>
  7147. <code>configMap</code></br>
  7148. <em>
  7149. <a href="#external-secrets.io/v1beta1.TemplateRef">
  7150. TemplateRef
  7151. </a>
  7152. </em>
  7153. </td>
  7154. <td>
  7155. </td>
  7156. </tr>
  7157. <tr>
  7158. <td>
  7159. <code>secret</code></br>
  7160. <em>
  7161. <a href="#external-secrets.io/v1beta1.TemplateRef">
  7162. TemplateRef
  7163. </a>
  7164. </em>
  7165. </td>
  7166. <td>
  7167. </td>
  7168. </tr>
  7169. <tr>
  7170. <td>
  7171. <code>target</code></br>
  7172. <em>
  7173. <a href="#external-secrets.io/v1beta1.TemplateTarget">
  7174. TemplateTarget
  7175. </a>
  7176. </em>
  7177. </td>
  7178. <td>
  7179. <em>(Optional)</em>
  7180. </td>
  7181. </tr>
  7182. <tr>
  7183. <td>
  7184. <code>literal</code></br>
  7185. <em>
  7186. string
  7187. </em>
  7188. </td>
  7189. <td>
  7190. <em>(Optional)</em>
  7191. </td>
  7192. </tr>
  7193. </tbody>
  7194. </table>
  7195. <h3 id="external-secrets.io/v1beta1.TemplateMergePolicy">TemplateMergePolicy
  7196. (<code>string</code> alias)</p></h3>
  7197. <p>
  7198. (<em>Appears on:</em>
  7199. <a href="#external-secrets.io/v1beta1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  7200. </p>
  7201. <p>
  7202. </p>
  7203. <table>
  7204. <thead>
  7205. <tr>
  7206. <th>Value</th>
  7207. <th>Description</th>
  7208. </tr>
  7209. </thead>
  7210. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  7211. <td></td>
  7212. </tr><tr><td><p>&#34;Replace&#34;</p></td>
  7213. <td></td>
  7214. </tr></tbody>
  7215. </table>
  7216. <h3 id="external-secrets.io/v1beta1.TemplateRef">TemplateRef
  7217. </h3>
  7218. <p>
  7219. (<em>Appears on:</em>
  7220. <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
  7221. </p>
  7222. <p>
  7223. </p>
  7224. <table>
  7225. <thead>
  7226. <tr>
  7227. <th>Field</th>
  7228. <th>Description</th>
  7229. </tr>
  7230. </thead>
  7231. <tbody>
  7232. <tr>
  7233. <td>
  7234. <code>name</code></br>
  7235. <em>
  7236. string
  7237. </em>
  7238. </td>
  7239. <td>
  7240. </td>
  7241. </tr>
  7242. <tr>
  7243. <td>
  7244. <code>items</code></br>
  7245. <em>
  7246. <a href="#external-secrets.io/v1beta1.TemplateRefItem">
  7247. []TemplateRefItem
  7248. </a>
  7249. </em>
  7250. </td>
  7251. <td>
  7252. </td>
  7253. </tr>
  7254. </tbody>
  7255. </table>
  7256. <h3 id="external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem
  7257. </h3>
  7258. <p>
  7259. (<em>Appears on:</em>
  7260. <a href="#external-secrets.io/v1beta1.TemplateRef">TemplateRef</a>)
  7261. </p>
  7262. <p>
  7263. </p>
  7264. <table>
  7265. <thead>
  7266. <tr>
  7267. <th>Field</th>
  7268. <th>Description</th>
  7269. </tr>
  7270. </thead>
  7271. <tbody>
  7272. <tr>
  7273. <td>
  7274. <code>key</code></br>
  7275. <em>
  7276. string
  7277. </em>
  7278. </td>
  7279. <td>
  7280. </td>
  7281. </tr>
  7282. <tr>
  7283. <td>
  7284. <code>templateAs</code></br>
  7285. <em>
  7286. <a href="#external-secrets.io/v1beta1.TemplateScope">
  7287. TemplateScope
  7288. </a>
  7289. </em>
  7290. </td>
  7291. <td>
  7292. </td>
  7293. </tr>
  7294. </tbody>
  7295. </table>
  7296. <h3 id="external-secrets.io/v1beta1.TemplateScope">TemplateScope
  7297. (<code>string</code> alias)</p></h3>
  7298. <p>
  7299. (<em>Appears on:</em>
  7300. <a href="#external-secrets.io/v1beta1.TemplateRefItem">TemplateRefItem</a>)
  7301. </p>
  7302. <p>
  7303. </p>
  7304. <table>
  7305. <thead>
  7306. <tr>
  7307. <th>Value</th>
  7308. <th>Description</th>
  7309. </tr>
  7310. </thead>
  7311. <tbody><tr><td><p>&#34;KeysAndValues&#34;</p></td>
  7312. <td></td>
  7313. </tr><tr><td><p>&#34;Values&#34;</p></td>
  7314. <td></td>
  7315. </tr></tbody>
  7316. </table>
  7317. <h3 id="external-secrets.io/v1beta1.TemplateTarget">TemplateTarget
  7318. (<code>string</code> alias)</p></h3>
  7319. <p>
  7320. (<em>Appears on:</em>
  7321. <a href="#external-secrets.io/v1beta1.TemplateFrom">TemplateFrom</a>)
  7322. </p>
  7323. <p>
  7324. </p>
  7325. <table>
  7326. <thead>
  7327. <tr>
  7328. <th>Value</th>
  7329. <th>Description</th>
  7330. </tr>
  7331. </thead>
  7332. <tbody><tr><td><p>&#34;Annotations&#34;</p></td>
  7333. <td></td>
  7334. </tr><tr><td><p>&#34;Data&#34;</p></td>
  7335. <td></td>
  7336. </tr><tr><td><p>&#34;Labels&#34;</p></td>
  7337. <td></td>
  7338. </tr></tbody>
  7339. </table>
  7340. <h3 id="external-secrets.io/v1beta1.TokenAuth">TokenAuth
  7341. </h3>
  7342. <p>
  7343. (<em>Appears on:</em>
  7344. <a href="#external-secrets.io/v1beta1.KubernetesAuth">KubernetesAuth</a>)
  7345. </p>
  7346. <p>
  7347. </p>
  7348. <table>
  7349. <thead>
  7350. <tr>
  7351. <th>Field</th>
  7352. <th>Description</th>
  7353. </tr>
  7354. </thead>
  7355. <tbody>
  7356. <tr>
  7357. <td>
  7358. <code>bearerToken</code></br>
  7359. <em>
  7360. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7361. External Secrets meta/v1.SecretKeySelector
  7362. </a>
  7363. </em>
  7364. </td>
  7365. <td>
  7366. </td>
  7367. </tr>
  7368. </tbody>
  7369. </table>
  7370. <h3 id="external-secrets.io/v1beta1.ValidationResult">ValidationResult
  7371. (<code>byte</code> alias)</p></h3>
  7372. <p>
  7373. </p>
  7374. <table>
  7375. <thead>
  7376. <tr>
  7377. <th>Value</th>
  7378. <th>Description</th>
  7379. </tr>
  7380. </thead>
  7381. <tbody><tr><td><p>2</p></td>
  7382. <td><p>Error indicates that there is a misconfiguration.</p>
  7383. </td>
  7384. </tr><tr><td><p>0</p></td>
  7385. <td><p>Ready indicates that the client is configured correctly
  7386. and can be used.</p>
  7387. </td>
  7388. </tr><tr><td><p>1</p></td>
  7389. <td><p>Unknown indicates that the client can be used
  7390. but information is missing and it can not be validated.</p>
  7391. </td>
  7392. </tr></tbody>
  7393. </table>
  7394. <h3 id="external-secrets.io/v1beta1.VaultAppRole">VaultAppRole
  7395. </h3>
  7396. <p>
  7397. (<em>Appears on:</em>
  7398. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  7399. </p>
  7400. <p>
  7401. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  7402. with the role and secret stored in a Kubernetes Secret resource.</p>
  7403. </p>
  7404. <table>
  7405. <thead>
  7406. <tr>
  7407. <th>Field</th>
  7408. <th>Description</th>
  7409. </tr>
  7410. </thead>
  7411. <tbody>
  7412. <tr>
  7413. <td>
  7414. <code>path</code></br>
  7415. <em>
  7416. string
  7417. </em>
  7418. </td>
  7419. <td>
  7420. <p>Path where the App Role authentication backend is mounted
  7421. in Vault, e.g: &ldquo;approle&rdquo;</p>
  7422. </td>
  7423. </tr>
  7424. <tr>
  7425. <td>
  7426. <code>roleId</code></br>
  7427. <em>
  7428. string
  7429. </em>
  7430. </td>
  7431. <td>
  7432. <em>(Optional)</em>
  7433. <p>RoleID configured in the App Role authentication backend when setting
  7434. up the authentication backend in Vault.</p>
  7435. </td>
  7436. </tr>
  7437. <tr>
  7438. <td>
  7439. <code>roleRef</code></br>
  7440. <em>
  7441. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7442. External Secrets meta/v1.SecretKeySelector
  7443. </a>
  7444. </em>
  7445. </td>
  7446. <td>
  7447. <em>(Optional)</em>
  7448. <p>Reference to a key in a Secret that contains the App Role ID used
  7449. to authenticate with Vault.
  7450. The <code>key</code> field must be specified and denotes which entry within the Secret
  7451. resource is used as the app role id.</p>
  7452. </td>
  7453. </tr>
  7454. <tr>
  7455. <td>
  7456. <code>secretRef</code></br>
  7457. <em>
  7458. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7459. External Secrets meta/v1.SecretKeySelector
  7460. </a>
  7461. </em>
  7462. </td>
  7463. <td>
  7464. <p>Reference to a key in a Secret that contains the App Role secret used
  7465. to authenticate with Vault.
  7466. The <code>key</code> field must be specified and denotes which entry within the Secret
  7467. resource is used as the app role secret.</p>
  7468. </td>
  7469. </tr>
  7470. </tbody>
  7471. </table>
  7472. <h3 id="external-secrets.io/v1beta1.VaultAuth">VaultAuth
  7473. </h3>
  7474. <p>
  7475. (<em>Appears on:</em>
  7476. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  7477. </p>
  7478. <p>
  7479. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  7480. Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>userPass</code>, <code>jwt</code> or <code>cert</code>
  7481. can be specified.</p>
  7482. </p>
  7483. <table>
  7484. <thead>
  7485. <tr>
  7486. <th>Field</th>
  7487. <th>Description</th>
  7488. </tr>
  7489. </thead>
  7490. <tbody>
  7491. <tr>
  7492. <td>
  7493. <code>tokenSecretRef</code></br>
  7494. <em>
  7495. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7496. External Secrets meta/v1.SecretKeySelector
  7497. </a>
  7498. </em>
  7499. </td>
  7500. <td>
  7501. <em>(Optional)</em>
  7502. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  7503. </td>
  7504. </tr>
  7505. <tr>
  7506. <td>
  7507. <code>appRole</code></br>
  7508. <em>
  7509. <a href="#external-secrets.io/v1beta1.VaultAppRole">
  7510. VaultAppRole
  7511. </a>
  7512. </em>
  7513. </td>
  7514. <td>
  7515. <em>(Optional)</em>
  7516. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  7517. with the role and secret stored in a Kubernetes Secret resource.</p>
  7518. </td>
  7519. </tr>
  7520. <tr>
  7521. <td>
  7522. <code>kubernetes</code></br>
  7523. <em>
  7524. <a href="#external-secrets.io/v1beta1.VaultKubernetesAuth">
  7525. VaultKubernetesAuth
  7526. </a>
  7527. </em>
  7528. </td>
  7529. <td>
  7530. <em>(Optional)</em>
  7531. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  7532. token stored in the named Secret resource to the Vault server.</p>
  7533. </td>
  7534. </tr>
  7535. <tr>
  7536. <td>
  7537. <code>ldap</code></br>
  7538. <em>
  7539. <a href="#external-secrets.io/v1beta1.VaultLdapAuth">
  7540. VaultLdapAuth
  7541. </a>
  7542. </em>
  7543. </td>
  7544. <td>
  7545. <em>(Optional)</em>
  7546. <p>Ldap authenticates with Vault by passing username/password pair using
  7547. the LDAP authentication method</p>
  7548. </td>
  7549. </tr>
  7550. <tr>
  7551. <td>
  7552. <code>jwt</code></br>
  7553. <em>
  7554. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">
  7555. VaultJwtAuth
  7556. </a>
  7557. </em>
  7558. </td>
  7559. <td>
  7560. <em>(Optional)</em>
  7561. <p>Jwt authenticates with Vault by passing role and JWT token using the
  7562. JWT/OIDC authentication method</p>
  7563. </td>
  7564. </tr>
  7565. <tr>
  7566. <td>
  7567. <code>cert</code></br>
  7568. <em>
  7569. <a href="#external-secrets.io/v1beta1.VaultCertAuth">
  7570. VaultCertAuth
  7571. </a>
  7572. </em>
  7573. </td>
  7574. <td>
  7575. <em>(Optional)</em>
  7576. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  7577. Cert authentication method</p>
  7578. </td>
  7579. </tr>
  7580. <tr>
  7581. <td>
  7582. <code>iam</code></br>
  7583. <em>
  7584. <a href="#external-secrets.io/v1beta1.VaultIamAuth">
  7585. VaultIamAuth
  7586. </a>
  7587. </em>
  7588. </td>
  7589. <td>
  7590. <em>(Optional)</em>
  7591. <p>Iam authenticates with vault by passing a special AWS request signed with AWS IAM credentials
  7592. AWS IAM authentication method</p>
  7593. </td>
  7594. </tr>
  7595. <tr>
  7596. <td>
  7597. <code>userPass</code></br>
  7598. <em>
  7599. <a href="#external-secrets.io/v1beta1.VaultUserPassAuth">
  7600. VaultUserPassAuth
  7601. </a>
  7602. </em>
  7603. </td>
  7604. <td>
  7605. <em>(Optional)</em>
  7606. <p>UserPass authenticates with Vault by passing username/password pair</p>
  7607. </td>
  7608. </tr>
  7609. </tbody>
  7610. </table>
  7611. <h3 id="external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth
  7612. </h3>
  7613. <p>
  7614. <p>VaultAwsAuth tells the controller how to do authentication with aws.
  7615. Only one of secretRef or jwt can be specified.
  7616. if none is specified the controller will try to load credentials from its own service account assuming it is IRSA enabled.</p>
  7617. </p>
  7618. <table>
  7619. <thead>
  7620. <tr>
  7621. <th>Field</th>
  7622. <th>Description</th>
  7623. </tr>
  7624. </thead>
  7625. <tbody>
  7626. <tr>
  7627. <td>
  7628. <code>secretRef</code></br>
  7629. <em>
  7630. <a href="#external-secrets.io/v1beta1.VaultAwsAuthSecretRef">
  7631. VaultAwsAuthSecretRef
  7632. </a>
  7633. </em>
  7634. </td>
  7635. <td>
  7636. <em>(Optional)</em>
  7637. </td>
  7638. </tr>
  7639. <tr>
  7640. <td>
  7641. <code>jwt</code></br>
  7642. <em>
  7643. <a href="#external-secrets.io/v1beta1.VaultAwsJWTAuth">
  7644. VaultAwsJWTAuth
  7645. </a>
  7646. </em>
  7647. </td>
  7648. <td>
  7649. <em>(Optional)</em>
  7650. </td>
  7651. </tr>
  7652. </tbody>
  7653. </table>
  7654. <h3 id="external-secrets.io/v1beta1.VaultAwsAuthSecretRef">VaultAwsAuthSecretRef
  7655. </h3>
  7656. <p>
  7657. (<em>Appears on:</em>
  7658. <a href="#external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth</a>,
  7659. <a href="#external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth</a>)
  7660. </p>
  7661. <p>
  7662. <p>VaultAWSAuthSecretRef holds secret references for AWS credentials
  7663. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  7664. </p>
  7665. <table>
  7666. <thead>
  7667. <tr>
  7668. <th>Field</th>
  7669. <th>Description</th>
  7670. </tr>
  7671. </thead>
  7672. <tbody>
  7673. <tr>
  7674. <td>
  7675. <code>accessKeyIDSecretRef</code></br>
  7676. <em>
  7677. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7678. External Secrets meta/v1.SecretKeySelector
  7679. </a>
  7680. </em>
  7681. </td>
  7682. <td>
  7683. <p>The AccessKeyID is used for authentication</p>
  7684. </td>
  7685. </tr>
  7686. <tr>
  7687. <td>
  7688. <code>secretAccessKeySecretRef</code></br>
  7689. <em>
  7690. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7691. External Secrets meta/v1.SecretKeySelector
  7692. </a>
  7693. </em>
  7694. </td>
  7695. <td>
  7696. <p>The SecretAccessKey is used for authentication</p>
  7697. </td>
  7698. </tr>
  7699. <tr>
  7700. <td>
  7701. <code>sessionTokenSecretRef</code></br>
  7702. <em>
  7703. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7704. External Secrets meta/v1.SecretKeySelector
  7705. </a>
  7706. </em>
  7707. </td>
  7708. <td>
  7709. <p>The SessionToken used for authentication
  7710. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  7711. 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>
  7712. </td>
  7713. </tr>
  7714. </tbody>
  7715. </table>
  7716. <h3 id="external-secrets.io/v1beta1.VaultAwsJWTAuth">VaultAwsJWTAuth
  7717. </h3>
  7718. <p>
  7719. (<em>Appears on:</em>
  7720. <a href="#external-secrets.io/v1beta1.VaultAwsAuth">VaultAwsAuth</a>,
  7721. <a href="#external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth</a>)
  7722. </p>
  7723. <p>
  7724. <p>Authenticate against AWS using service account tokens.</p>
  7725. </p>
  7726. <table>
  7727. <thead>
  7728. <tr>
  7729. <th>Field</th>
  7730. <th>Description</th>
  7731. </tr>
  7732. </thead>
  7733. <tbody>
  7734. <tr>
  7735. <td>
  7736. <code>serviceAccountRef</code></br>
  7737. <em>
  7738. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  7739. External Secrets meta/v1.ServiceAccountSelector
  7740. </a>
  7741. </em>
  7742. </td>
  7743. <td>
  7744. </td>
  7745. </tr>
  7746. </tbody>
  7747. </table>
  7748. <h3 id="external-secrets.io/v1beta1.VaultCertAuth">VaultCertAuth
  7749. </h3>
  7750. <p>
  7751. (<em>Appears on:</em>
  7752. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  7753. </p>
  7754. <p>
  7755. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  7756. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  7757. </p>
  7758. <table>
  7759. <thead>
  7760. <tr>
  7761. <th>Field</th>
  7762. <th>Description</th>
  7763. </tr>
  7764. </thead>
  7765. <tbody>
  7766. <tr>
  7767. <td>
  7768. <code>clientCert</code></br>
  7769. <em>
  7770. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7771. External Secrets meta/v1.SecretKeySelector
  7772. </a>
  7773. </em>
  7774. </td>
  7775. <td>
  7776. <em>(Optional)</em>
  7777. <p>ClientCert is a certificate to authenticate using the Cert Vault
  7778. authentication method</p>
  7779. </td>
  7780. </tr>
  7781. <tr>
  7782. <td>
  7783. <code>secretRef</code></br>
  7784. <em>
  7785. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7786. External Secrets meta/v1.SecretKeySelector
  7787. </a>
  7788. </em>
  7789. </td>
  7790. <td>
  7791. <p>SecretRef to a key in a Secret resource containing client private key to
  7792. authenticate with Vault using the Cert authentication method</p>
  7793. </td>
  7794. </tr>
  7795. </tbody>
  7796. </table>
  7797. <h3 id="external-secrets.io/v1beta1.VaultClientTLS">VaultClientTLS
  7798. </h3>
  7799. <p>
  7800. (<em>Appears on:</em>
  7801. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  7802. </p>
  7803. <p>
  7804. <p>VaultClientTLS is the configuration used for client side related TLS communication,
  7805. when the Vault server requires mutual authentication.</p>
  7806. </p>
  7807. <table>
  7808. <thead>
  7809. <tr>
  7810. <th>Field</th>
  7811. <th>Description</th>
  7812. </tr>
  7813. </thead>
  7814. <tbody>
  7815. <tr>
  7816. <td>
  7817. <code>certSecretRef</code></br>
  7818. <em>
  7819. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7820. External Secrets meta/v1.SecretKeySelector
  7821. </a>
  7822. </em>
  7823. </td>
  7824. <td>
  7825. <p>CertSecretRef is a certificate added to the transport layer
  7826. when communicating with the Vault server.
  7827. If no key for the Secret is specified, external-secret will default to &lsquo;tls.crt&rsquo;.</p>
  7828. </td>
  7829. </tr>
  7830. <tr>
  7831. <td>
  7832. <code>keySecretRef</code></br>
  7833. <em>
  7834. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  7835. External Secrets meta/v1.SecretKeySelector
  7836. </a>
  7837. </em>
  7838. </td>
  7839. <td>
  7840. <p>KeySecretRef to a key in a Secret resource containing client private key
  7841. added to the transport layer when communicating with the Vault server.
  7842. If no key for the Secret is specified, external-secret will default to &lsquo;tls.key&rsquo;.</p>
  7843. </td>
  7844. </tr>
  7845. </tbody>
  7846. </table>
  7847. <h3 id="external-secrets.io/v1beta1.VaultIamAuth">VaultIamAuth
  7848. </h3>
  7849. <p>
  7850. (<em>Appears on:</em>
  7851. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  7852. </p>
  7853. <p>
  7854. <p>VaultIamAuth authenticates with Vault using the Vault&rsquo;s AWS IAM authentication method. Refer: <a href="https://developer.hashicorp.com/vault/docs/auth/aws">https://developer.hashicorp.com/vault/docs/auth/aws</a></p>
  7855. </p>
  7856. <table>
  7857. <thead>
  7858. <tr>
  7859. <th>Field</th>
  7860. <th>Description</th>
  7861. </tr>
  7862. </thead>
  7863. <tbody>
  7864. <tr>
  7865. <td>
  7866. <code>path</code></br>
  7867. <em>
  7868. string
  7869. </em>
  7870. </td>
  7871. <td>
  7872. <p>Path where the AWS auth method is enabled in Vault, e.g: &ldquo;aws&rdquo;</p>
  7873. </td>
  7874. </tr>
  7875. <tr>
  7876. <td>
  7877. <code>region</code></br>
  7878. <em>
  7879. string
  7880. </em>
  7881. </td>
  7882. <td>
  7883. <p>AWS region</p>
  7884. </td>
  7885. </tr>
  7886. <tr>
  7887. <td>
  7888. <code>role</code></br>
  7889. <em>
  7890. string
  7891. </em>
  7892. </td>
  7893. <td>
  7894. <p>This is the AWS role to be assumed before talking to vault</p>
  7895. </td>
  7896. </tr>
  7897. <tr>
  7898. <td>
  7899. <code>vaultRole</code></br>
  7900. <em>
  7901. string
  7902. </em>
  7903. </td>
  7904. <td>
  7905. <p>Vault Role. In vault, a role describes an identity with a set of permissions, groups, or policies you want to attach a user of the secrets engine</p>
  7906. </td>
  7907. </tr>
  7908. <tr>
  7909. <td>
  7910. <code>externalID</code></br>
  7911. <em>
  7912. string
  7913. </em>
  7914. </td>
  7915. <td>
  7916. <p>AWS External ID set on assumed IAM roles</p>
  7917. </td>
  7918. </tr>
  7919. <tr>
  7920. <td>
  7921. <code>vaultAwsIamServerID</code></br>
  7922. <em>
  7923. string
  7924. </em>
  7925. </td>
  7926. <td>
  7927. <p>X-Vault-AWS-IAM-Server-ID is an additional header used by Vault IAM auth method to mitigate against different types of replay attacks. More details here: <a href="https://developer.hashicorp.com/vault/docs/auth/aws">https://developer.hashicorp.com/vault/docs/auth/aws</a></p>
  7928. </td>
  7929. </tr>
  7930. <tr>
  7931. <td>
  7932. <code>secretRef</code></br>
  7933. <em>
  7934. <a href="#external-secrets.io/v1beta1.VaultAwsAuthSecretRef">
  7935. VaultAwsAuthSecretRef
  7936. </a>
  7937. </em>
  7938. </td>
  7939. <td>
  7940. <em>(Optional)</em>
  7941. <p>Specify credentials in a Secret object</p>
  7942. </td>
  7943. </tr>
  7944. <tr>
  7945. <td>
  7946. <code>jwt</code></br>
  7947. <em>
  7948. <a href="#external-secrets.io/v1beta1.VaultAwsJWTAuth">
  7949. VaultAwsJWTAuth
  7950. </a>
  7951. </em>
  7952. </td>
  7953. <td>
  7954. <em>(Optional)</em>
  7955. <p>Specify a service account with IRSA enabled</p>
  7956. </td>
  7957. </tr>
  7958. </tbody>
  7959. </table>
  7960. <h3 id="external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth
  7961. </h3>
  7962. <p>
  7963. (<em>Appears on:</em>
  7964. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  7965. </p>
  7966. <p>
  7967. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  7968. method, with the role name and a token stored in a Kubernetes Secret resource or
  7969. a Kubernetes service account token retrieved via <code>TokenRequest</code>.</p>
  7970. </p>
  7971. <table>
  7972. <thead>
  7973. <tr>
  7974. <th>Field</th>
  7975. <th>Description</th>
  7976. </tr>
  7977. </thead>
  7978. <tbody>
  7979. <tr>
  7980. <td>
  7981. <code>path</code></br>
  7982. <em>
  7983. string
  7984. </em>
  7985. </td>
  7986. <td>
  7987. <p>Path where the JWT authentication backend is mounted
  7988. in Vault, e.g: &ldquo;jwt&rdquo;</p>
  7989. </td>
  7990. </tr>
  7991. <tr>
  7992. <td>
  7993. <code>role</code></br>
  7994. <em>
  7995. string
  7996. </em>
  7997. </td>
  7998. <td>
  7999. <em>(Optional)</em>
  8000. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  8001. authentication method</p>
  8002. </td>
  8003. </tr>
  8004. <tr>
  8005. <td>
  8006. <code>secretRef</code></br>
  8007. <em>
  8008. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8009. External Secrets meta/v1.SecretKeySelector
  8010. </a>
  8011. </em>
  8012. </td>
  8013. <td>
  8014. <em>(Optional)</em>
  8015. <p>Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  8016. authenticate with Vault using the JWT/OIDC authentication method.</p>
  8017. </td>
  8018. </tr>
  8019. <tr>
  8020. <td>
  8021. <code>kubernetesServiceAccountToken</code></br>
  8022. <em>
  8023. <a href="#external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">
  8024. VaultKubernetesServiceAccountTokenAuth
  8025. </a>
  8026. </em>
  8027. </td>
  8028. <td>
  8029. <em>(Optional)</em>
  8030. <p>Optional ServiceAccountToken specifies the Kubernetes service account for which to request
  8031. a token for with the <code>TokenRequest</code> API.</p>
  8032. </td>
  8033. </tr>
  8034. </tbody>
  8035. </table>
  8036. <h3 id="external-secrets.io/v1beta1.VaultKVStoreVersion">VaultKVStoreVersion
  8037. (<code>string</code> alias)</p></h3>
  8038. <p>
  8039. (<em>Appears on:</em>
  8040. <a href="#external-secrets.io/v1beta1.VaultProvider">VaultProvider</a>)
  8041. </p>
  8042. <p>
  8043. </p>
  8044. <table>
  8045. <thead>
  8046. <tr>
  8047. <th>Value</th>
  8048. <th>Description</th>
  8049. </tr>
  8050. </thead>
  8051. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  8052. <td></td>
  8053. </tr><tr><td><p>&#34;v2&#34;</p></td>
  8054. <td></td>
  8055. </tr></tbody>
  8056. </table>
  8057. <h3 id="external-secrets.io/v1beta1.VaultKubernetesAuth">VaultKubernetesAuth
  8058. </h3>
  8059. <p>
  8060. (<em>Appears on:</em>
  8061. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  8062. </p>
  8063. <p>
  8064. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  8065. a Secret.</p>
  8066. </p>
  8067. <table>
  8068. <thead>
  8069. <tr>
  8070. <th>Field</th>
  8071. <th>Description</th>
  8072. </tr>
  8073. </thead>
  8074. <tbody>
  8075. <tr>
  8076. <td>
  8077. <code>mountPath</code></br>
  8078. <em>
  8079. string
  8080. </em>
  8081. </td>
  8082. <td>
  8083. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  8084. &ldquo;kubernetes&rdquo;</p>
  8085. </td>
  8086. </tr>
  8087. <tr>
  8088. <td>
  8089. <code>serviceAccountRef</code></br>
  8090. <em>
  8091. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  8092. External Secrets meta/v1.ServiceAccountSelector
  8093. </a>
  8094. </em>
  8095. </td>
  8096. <td>
  8097. <em>(Optional)</em>
  8098. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  8099. If the service account is specified, the service account secret token JWT will be used
  8100. for authenticating with Vault. If the service account selector is not supplied,
  8101. the secretRef will be used instead.</p>
  8102. </td>
  8103. </tr>
  8104. <tr>
  8105. <td>
  8106. <code>secretRef</code></br>
  8107. <em>
  8108. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8109. External Secrets meta/v1.SecretKeySelector
  8110. </a>
  8111. </em>
  8112. </td>
  8113. <td>
  8114. <em>(Optional)</em>
  8115. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  8116. for authenticating with Vault. If a name is specified without a key,
  8117. <code>token</code> is the default. If one is not specified, the one bound to
  8118. the controller will be used.</p>
  8119. </td>
  8120. </tr>
  8121. <tr>
  8122. <td>
  8123. <code>role</code></br>
  8124. <em>
  8125. string
  8126. </em>
  8127. </td>
  8128. <td>
  8129. <p>A required field containing the Vault Role to assume. A Role binds a
  8130. Kubernetes ServiceAccount with a set of Vault policies.</p>
  8131. </td>
  8132. </tr>
  8133. </tbody>
  8134. </table>
  8135. <h3 id="external-secrets.io/v1beta1.VaultKubernetesServiceAccountTokenAuth">VaultKubernetesServiceAccountTokenAuth
  8136. </h3>
  8137. <p>
  8138. (<em>Appears on:</em>
  8139. <a href="#external-secrets.io/v1beta1.VaultJwtAuth">VaultJwtAuth</a>)
  8140. </p>
  8141. <p>
  8142. <p>VaultKubernetesServiceAccountTokenAuth authenticates with Vault using a temporary
  8143. Kubernetes service account token retrieved by the <code>TokenRequest</code> API.</p>
  8144. </p>
  8145. <table>
  8146. <thead>
  8147. <tr>
  8148. <th>Field</th>
  8149. <th>Description</th>
  8150. </tr>
  8151. </thead>
  8152. <tbody>
  8153. <tr>
  8154. <td>
  8155. <code>serviceAccountRef</code></br>
  8156. <em>
  8157. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#ServiceAccountSelector">
  8158. External Secrets meta/v1.ServiceAccountSelector
  8159. </a>
  8160. </em>
  8161. </td>
  8162. <td>
  8163. <p>Service account field containing the name of a kubernetes ServiceAccount.</p>
  8164. </td>
  8165. </tr>
  8166. <tr>
  8167. <td>
  8168. <code>audiences</code></br>
  8169. <em>
  8170. []string
  8171. </em>
  8172. </td>
  8173. <td>
  8174. <em>(Optional)</em>
  8175. <p>Optional audiences field that will be used to request a temporary Kubernetes service
  8176. account token for the service account referenced by <code>serviceAccountRef</code>.
  8177. Defaults to a single audience <code>vault</code> it not specified.
  8178. Deprecated: use serviceAccountRef.Audiences instead</p>
  8179. </td>
  8180. </tr>
  8181. <tr>
  8182. <td>
  8183. <code>expirationSeconds</code></br>
  8184. <em>
  8185. int64
  8186. </em>
  8187. </td>
  8188. <td>
  8189. <em>(Optional)</em>
  8190. <p>Optional expiration time in seconds that will be used to request a temporary
  8191. Kubernetes service account token for the service account referenced by
  8192. <code>serviceAccountRef</code>.
  8193. Deprecated: this will be removed in the future.
  8194. Defaults to 10 minutes.</p>
  8195. </td>
  8196. </tr>
  8197. </tbody>
  8198. </table>
  8199. <h3 id="external-secrets.io/v1beta1.VaultLdapAuth">VaultLdapAuth
  8200. </h3>
  8201. <p>
  8202. (<em>Appears on:</em>
  8203. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  8204. </p>
  8205. <p>
  8206. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  8207. with the username and password stored in a Kubernetes Secret resource.</p>
  8208. </p>
  8209. <table>
  8210. <thead>
  8211. <tr>
  8212. <th>Field</th>
  8213. <th>Description</th>
  8214. </tr>
  8215. </thead>
  8216. <tbody>
  8217. <tr>
  8218. <td>
  8219. <code>path</code></br>
  8220. <em>
  8221. string
  8222. </em>
  8223. </td>
  8224. <td>
  8225. <p>Path where the LDAP authentication backend is mounted
  8226. in Vault, e.g: &ldquo;ldap&rdquo;</p>
  8227. </td>
  8228. </tr>
  8229. <tr>
  8230. <td>
  8231. <code>username</code></br>
  8232. <em>
  8233. string
  8234. </em>
  8235. </td>
  8236. <td>
  8237. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  8238. authentication method</p>
  8239. </td>
  8240. </tr>
  8241. <tr>
  8242. <td>
  8243. <code>secretRef</code></br>
  8244. <em>
  8245. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8246. External Secrets meta/v1.SecretKeySelector
  8247. </a>
  8248. </em>
  8249. </td>
  8250. <td>
  8251. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  8252. user used to authenticate with Vault using the LDAP authentication
  8253. method</p>
  8254. </td>
  8255. </tr>
  8256. </tbody>
  8257. </table>
  8258. <h3 id="external-secrets.io/v1beta1.VaultProvider">VaultProvider
  8259. </h3>
  8260. <p>
  8261. (<em>Appears on:</em>
  8262. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  8263. </p>
  8264. <p>
  8265. <p>Configures an store to sync secrets using a HashiCorp Vault
  8266. KV backend.</p>
  8267. </p>
  8268. <table>
  8269. <thead>
  8270. <tr>
  8271. <th>Field</th>
  8272. <th>Description</th>
  8273. </tr>
  8274. </thead>
  8275. <tbody>
  8276. <tr>
  8277. <td>
  8278. <code>auth</code></br>
  8279. <em>
  8280. <a href="#external-secrets.io/v1beta1.VaultAuth">
  8281. VaultAuth
  8282. </a>
  8283. </em>
  8284. </td>
  8285. <td>
  8286. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  8287. </td>
  8288. </tr>
  8289. <tr>
  8290. <td>
  8291. <code>server</code></br>
  8292. <em>
  8293. string
  8294. </em>
  8295. </td>
  8296. <td>
  8297. <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>
  8298. </td>
  8299. </tr>
  8300. <tr>
  8301. <td>
  8302. <code>path</code></br>
  8303. <em>
  8304. string
  8305. </em>
  8306. </td>
  8307. <td>
  8308. <em>(Optional)</em>
  8309. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  8310. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  8311. for fetching secrets from Vault is optional and will be appended
  8312. if not present in specified path.</p>
  8313. </td>
  8314. </tr>
  8315. <tr>
  8316. <td>
  8317. <code>version</code></br>
  8318. <em>
  8319. <a href="#external-secrets.io/v1beta1.VaultKVStoreVersion">
  8320. VaultKVStoreVersion
  8321. </a>
  8322. </em>
  8323. </td>
  8324. <td>
  8325. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  8326. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  8327. </td>
  8328. </tr>
  8329. <tr>
  8330. <td>
  8331. <code>namespace</code></br>
  8332. <em>
  8333. string
  8334. </em>
  8335. </td>
  8336. <td>
  8337. <em>(Optional)</em>
  8338. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  8339. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  8340. 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>
  8341. </td>
  8342. </tr>
  8343. <tr>
  8344. <td>
  8345. <code>caBundle</code></br>
  8346. <em>
  8347. []byte
  8348. </em>
  8349. </td>
  8350. <td>
  8351. <em>(Optional)</em>
  8352. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  8353. if the Server URL is using HTTPS protocol. This parameter is ignored for
  8354. plain HTTP protocol connection. If not set the system root certificates
  8355. are used to validate the TLS connection.</p>
  8356. </td>
  8357. </tr>
  8358. <tr>
  8359. <td>
  8360. <code>tls</code></br>
  8361. <em>
  8362. <a href="#external-secrets.io/v1beta1.VaultClientTLS">
  8363. VaultClientTLS
  8364. </a>
  8365. </em>
  8366. </td>
  8367. <td>
  8368. <em>(Optional)</em>
  8369. <p>The configuration used for client side related TLS communication, when the Vault server
  8370. requires mutual authentication. Only used if the Server URL is using HTTPS protocol.
  8371. This parameter is ignored for plain HTTP protocol connection.
  8372. It&rsquo;s worth noting this configuration is different from the &ldquo;TLS certificates auth method&rdquo;,
  8373. which is available under the <code>auth.cert</code> section.</p>
  8374. </td>
  8375. </tr>
  8376. <tr>
  8377. <td>
  8378. <code>caProvider</code></br>
  8379. <em>
  8380. <a href="#external-secrets.io/v1beta1.CAProvider">
  8381. CAProvider
  8382. </a>
  8383. </em>
  8384. </td>
  8385. <td>
  8386. <em>(Optional)</em>
  8387. <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
  8388. </td>
  8389. </tr>
  8390. <tr>
  8391. <td>
  8392. <code>readYourWrites</code></br>
  8393. <em>
  8394. bool
  8395. </em>
  8396. </td>
  8397. <td>
  8398. <em>(Optional)</em>
  8399. <p>ReadYourWrites ensures isolated read-after-write semantics by
  8400. providing discovered cluster replication states in each request.
  8401. More information about eventual consistency in Vault can be found here
  8402. <a href="https://www.vaultproject.io/docs/enterprise/consistency">https://www.vaultproject.io/docs/enterprise/consistency</a></p>
  8403. </td>
  8404. </tr>
  8405. <tr>
  8406. <td>
  8407. <code>forwardInconsistent</code></br>
  8408. <em>
  8409. bool
  8410. </em>
  8411. </td>
  8412. <td>
  8413. <em>(Optional)</em>
  8414. <p>ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
  8415. leader instead of simply retrying within a loop. This can increase performance if
  8416. the option is enabled serverside.
  8417. <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>
  8418. </td>
  8419. </tr>
  8420. </tbody>
  8421. </table>
  8422. <h3 id="external-secrets.io/v1beta1.VaultUserPassAuth">VaultUserPassAuth
  8423. </h3>
  8424. <p>
  8425. (<em>Appears on:</em>
  8426. <a href="#external-secrets.io/v1beta1.VaultAuth">VaultAuth</a>)
  8427. </p>
  8428. <p>
  8429. <p>VaultUserPassAuth authenticates with Vault using UserPass authentication method,
  8430. with the username and password stored in a Kubernetes Secret resource.</p>
  8431. </p>
  8432. <table>
  8433. <thead>
  8434. <tr>
  8435. <th>Field</th>
  8436. <th>Description</th>
  8437. </tr>
  8438. </thead>
  8439. <tbody>
  8440. <tr>
  8441. <td>
  8442. <code>path</code></br>
  8443. <em>
  8444. string
  8445. </em>
  8446. </td>
  8447. <td>
  8448. <p>Path where the UserPassword authentication backend is mounted
  8449. in Vault, e.g: &ldquo;user&rdquo;</p>
  8450. </td>
  8451. </tr>
  8452. <tr>
  8453. <td>
  8454. <code>username</code></br>
  8455. <em>
  8456. string
  8457. </em>
  8458. </td>
  8459. <td>
  8460. <p>Username is a user name used to authenticate using the UserPass Vault
  8461. authentication method</p>
  8462. </td>
  8463. </tr>
  8464. <tr>
  8465. <td>
  8466. <code>secretRef</code></br>
  8467. <em>
  8468. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8469. External Secrets meta/v1.SecretKeySelector
  8470. </a>
  8471. </em>
  8472. </td>
  8473. <td>
  8474. <p>SecretRef to a key in a Secret resource containing password for the
  8475. user used to authenticate with Vault using the UserPass authentication
  8476. method</p>
  8477. </td>
  8478. </tr>
  8479. </tbody>
  8480. </table>
  8481. <h3 id="external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider
  8482. </h3>
  8483. <p>
  8484. (<em>Appears on:</em>
  8485. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  8486. </p>
  8487. <p>
  8488. <p>Defines a location to fetch the cert for the webhook provider from.</p>
  8489. </p>
  8490. <table>
  8491. <thead>
  8492. <tr>
  8493. <th>Field</th>
  8494. <th>Description</th>
  8495. </tr>
  8496. </thead>
  8497. <tbody>
  8498. <tr>
  8499. <td>
  8500. <code>type</code></br>
  8501. <em>
  8502. <a href="#external-secrets.io/v1beta1.WebhookCAProviderType">
  8503. WebhookCAProviderType
  8504. </a>
  8505. </em>
  8506. </td>
  8507. <td>
  8508. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  8509. </td>
  8510. </tr>
  8511. <tr>
  8512. <td>
  8513. <code>name</code></br>
  8514. <em>
  8515. string
  8516. </em>
  8517. </td>
  8518. <td>
  8519. <p>The name of the object located at the provider type.</p>
  8520. </td>
  8521. </tr>
  8522. <tr>
  8523. <td>
  8524. <code>key</code></br>
  8525. <em>
  8526. string
  8527. </em>
  8528. </td>
  8529. <td>
  8530. <p>The key the value inside of the provider type to use, only used with &ldquo;Secret&rdquo; type</p>
  8531. </td>
  8532. </tr>
  8533. <tr>
  8534. <td>
  8535. <code>namespace</code></br>
  8536. <em>
  8537. string
  8538. </em>
  8539. </td>
  8540. <td>
  8541. <em>(Optional)</em>
  8542. <p>The namespace the Provider type is in.</p>
  8543. </td>
  8544. </tr>
  8545. </tbody>
  8546. </table>
  8547. <h3 id="external-secrets.io/v1beta1.WebhookCAProviderType">WebhookCAProviderType
  8548. (<code>string</code> alias)</p></h3>
  8549. <p>
  8550. (<em>Appears on:</em>
  8551. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">WebhookCAProvider</a>)
  8552. </p>
  8553. <p>
  8554. </p>
  8555. <table>
  8556. <thead>
  8557. <tr>
  8558. <th>Value</th>
  8559. <th>Description</th>
  8560. </tr>
  8561. </thead>
  8562. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  8563. <td></td>
  8564. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  8565. <td></td>
  8566. </tr></tbody>
  8567. </table>
  8568. <h3 id="external-secrets.io/v1beta1.WebhookProvider">WebhookProvider
  8569. </h3>
  8570. <p>
  8571. (<em>Appears on:</em>
  8572. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  8573. </p>
  8574. <p>
  8575. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  8576. </p>
  8577. <table>
  8578. <thead>
  8579. <tr>
  8580. <th>Field</th>
  8581. <th>Description</th>
  8582. </tr>
  8583. </thead>
  8584. <tbody>
  8585. <tr>
  8586. <td>
  8587. <code>method</code></br>
  8588. <em>
  8589. string
  8590. </em>
  8591. </td>
  8592. <td>
  8593. <p>Webhook Method</p>
  8594. </td>
  8595. </tr>
  8596. <tr>
  8597. <td>
  8598. <code>url</code></br>
  8599. <em>
  8600. string
  8601. </em>
  8602. </td>
  8603. <td>
  8604. <p>Webhook url to call</p>
  8605. </td>
  8606. </tr>
  8607. <tr>
  8608. <td>
  8609. <code>headers</code></br>
  8610. <em>
  8611. map[string]string
  8612. </em>
  8613. </td>
  8614. <td>
  8615. <em>(Optional)</em>
  8616. <p>Headers</p>
  8617. </td>
  8618. </tr>
  8619. <tr>
  8620. <td>
  8621. <code>body</code></br>
  8622. <em>
  8623. string
  8624. </em>
  8625. </td>
  8626. <td>
  8627. <em>(Optional)</em>
  8628. <p>Body</p>
  8629. </td>
  8630. </tr>
  8631. <tr>
  8632. <td>
  8633. <code>timeout</code></br>
  8634. <em>
  8635. <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
  8636. Kubernetes meta/v1.Duration
  8637. </a>
  8638. </em>
  8639. </td>
  8640. <td>
  8641. <em>(Optional)</em>
  8642. <p>Timeout</p>
  8643. </td>
  8644. </tr>
  8645. <tr>
  8646. <td>
  8647. <code>result</code></br>
  8648. <em>
  8649. <a href="#external-secrets.io/v1beta1.WebhookResult">
  8650. WebhookResult
  8651. </a>
  8652. </em>
  8653. </td>
  8654. <td>
  8655. <p>Result formatting</p>
  8656. </td>
  8657. </tr>
  8658. <tr>
  8659. <td>
  8660. <code>secrets</code></br>
  8661. <em>
  8662. <a href="#external-secrets.io/v1beta1.WebhookSecret">
  8663. []WebhookSecret
  8664. </a>
  8665. </em>
  8666. </td>
  8667. <td>
  8668. <em>(Optional)</em>
  8669. <p>Secrets to fill in templates
  8670. These secrets will be passed to the templating function as key value pairs under the given name</p>
  8671. </td>
  8672. </tr>
  8673. <tr>
  8674. <td>
  8675. <code>caBundle</code></br>
  8676. <em>
  8677. []byte
  8678. </em>
  8679. </td>
  8680. <td>
  8681. <em>(Optional)</em>
  8682. <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
  8683. if the Server URL is using HTTPS protocol. This parameter is ignored for
  8684. plain HTTP protocol connection. If not set the system root certificates
  8685. are used to validate the TLS connection.</p>
  8686. </td>
  8687. </tr>
  8688. <tr>
  8689. <td>
  8690. <code>caProvider</code></br>
  8691. <em>
  8692. <a href="#external-secrets.io/v1beta1.WebhookCAProvider">
  8693. WebhookCAProvider
  8694. </a>
  8695. </em>
  8696. </td>
  8697. <td>
  8698. <em>(Optional)</em>
  8699. <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
  8700. </td>
  8701. </tr>
  8702. </tbody>
  8703. </table>
  8704. <h3 id="external-secrets.io/v1beta1.WebhookResult">WebhookResult
  8705. </h3>
  8706. <p>
  8707. (<em>Appears on:</em>
  8708. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  8709. </p>
  8710. <p>
  8711. </p>
  8712. <table>
  8713. <thead>
  8714. <tr>
  8715. <th>Field</th>
  8716. <th>Description</th>
  8717. </tr>
  8718. </thead>
  8719. <tbody>
  8720. <tr>
  8721. <td>
  8722. <code>jsonPath</code></br>
  8723. <em>
  8724. string
  8725. </em>
  8726. </td>
  8727. <td>
  8728. <em>(Optional)</em>
  8729. <p>Json path of return value</p>
  8730. </td>
  8731. </tr>
  8732. </tbody>
  8733. </table>
  8734. <h3 id="external-secrets.io/v1beta1.WebhookSecret">WebhookSecret
  8735. </h3>
  8736. <p>
  8737. (<em>Appears on:</em>
  8738. <a href="#external-secrets.io/v1beta1.WebhookProvider">WebhookProvider</a>)
  8739. </p>
  8740. <p>
  8741. </p>
  8742. <table>
  8743. <thead>
  8744. <tr>
  8745. <th>Field</th>
  8746. <th>Description</th>
  8747. </tr>
  8748. </thead>
  8749. <tbody>
  8750. <tr>
  8751. <td>
  8752. <code>name</code></br>
  8753. <em>
  8754. string
  8755. </em>
  8756. </td>
  8757. <td>
  8758. <p>Name of this secret in templates</p>
  8759. </td>
  8760. </tr>
  8761. <tr>
  8762. <td>
  8763. <code>secretRef</code></br>
  8764. <em>
  8765. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8766. External Secrets meta/v1.SecretKeySelector
  8767. </a>
  8768. </em>
  8769. </td>
  8770. <td>
  8771. <p>Secret ref to fill in credentials</p>
  8772. </td>
  8773. </tr>
  8774. </tbody>
  8775. </table>
  8776. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerAuth">YandexCertificateManagerAuth
  8777. </h3>
  8778. <p>
  8779. (<em>Appears on:</em>
  8780. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  8781. </p>
  8782. <p>
  8783. </p>
  8784. <table>
  8785. <thead>
  8786. <tr>
  8787. <th>Field</th>
  8788. <th>Description</th>
  8789. </tr>
  8790. </thead>
  8791. <tbody>
  8792. <tr>
  8793. <td>
  8794. <code>authorizedKeySecretRef</code></br>
  8795. <em>
  8796. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8797. External Secrets meta/v1.SecretKeySelector
  8798. </a>
  8799. </em>
  8800. </td>
  8801. <td>
  8802. <em>(Optional)</em>
  8803. <p>The authorized key used for authentication</p>
  8804. </td>
  8805. </tr>
  8806. </tbody>
  8807. </table>
  8808. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">YandexCertificateManagerCAProvider
  8809. </h3>
  8810. <p>
  8811. (<em>Appears on:</em>
  8812. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider</a>)
  8813. </p>
  8814. <p>
  8815. </p>
  8816. <table>
  8817. <thead>
  8818. <tr>
  8819. <th>Field</th>
  8820. <th>Description</th>
  8821. </tr>
  8822. </thead>
  8823. <tbody>
  8824. <tr>
  8825. <td>
  8826. <code>certSecretRef</code></br>
  8827. <em>
  8828. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8829. External Secrets meta/v1.SecretKeySelector
  8830. </a>
  8831. </em>
  8832. </td>
  8833. <td>
  8834. </td>
  8835. </tr>
  8836. </tbody>
  8837. </table>
  8838. <h3 id="external-secrets.io/v1beta1.YandexCertificateManagerProvider">YandexCertificateManagerProvider
  8839. </h3>
  8840. <p>
  8841. (<em>Appears on:</em>
  8842. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  8843. </p>
  8844. <p>
  8845. <p>YandexCertificateManagerProvider Configures a store to sync secrets using the Yandex Certificate Manager provider.</p>
  8846. </p>
  8847. <table>
  8848. <thead>
  8849. <tr>
  8850. <th>Field</th>
  8851. <th>Description</th>
  8852. </tr>
  8853. </thead>
  8854. <tbody>
  8855. <tr>
  8856. <td>
  8857. <code>apiEndpoint</code></br>
  8858. <em>
  8859. string
  8860. </em>
  8861. </td>
  8862. <td>
  8863. <em>(Optional)</em>
  8864. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  8865. </td>
  8866. </tr>
  8867. <tr>
  8868. <td>
  8869. <code>auth</code></br>
  8870. <em>
  8871. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerAuth">
  8872. YandexCertificateManagerAuth
  8873. </a>
  8874. </em>
  8875. </td>
  8876. <td>
  8877. <p>Auth defines the information necessary to authenticate against Yandex Certificate Manager</p>
  8878. </td>
  8879. </tr>
  8880. <tr>
  8881. <td>
  8882. <code>caProvider</code></br>
  8883. <em>
  8884. <a href="#external-secrets.io/v1beta1.YandexCertificateManagerCAProvider">
  8885. YandexCertificateManagerCAProvider
  8886. </a>
  8887. </em>
  8888. </td>
  8889. <td>
  8890. <em>(Optional)</em>
  8891. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  8892. </td>
  8893. </tr>
  8894. </tbody>
  8895. </table>
  8896. <h3 id="external-secrets.io/v1beta1.YandexLockboxAuth">YandexLockboxAuth
  8897. </h3>
  8898. <p>
  8899. (<em>Appears on:</em>
  8900. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  8901. </p>
  8902. <p>
  8903. </p>
  8904. <table>
  8905. <thead>
  8906. <tr>
  8907. <th>Field</th>
  8908. <th>Description</th>
  8909. </tr>
  8910. </thead>
  8911. <tbody>
  8912. <tr>
  8913. <td>
  8914. <code>authorizedKeySecretRef</code></br>
  8915. <em>
  8916. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8917. External Secrets meta/v1.SecretKeySelector
  8918. </a>
  8919. </em>
  8920. </td>
  8921. <td>
  8922. <em>(Optional)</em>
  8923. <p>The authorized key used for authentication</p>
  8924. </td>
  8925. </tr>
  8926. </tbody>
  8927. </table>
  8928. <h3 id="external-secrets.io/v1beta1.YandexLockboxCAProvider">YandexLockboxCAProvider
  8929. </h3>
  8930. <p>
  8931. (<em>Appears on:</em>
  8932. <a href="#external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider</a>)
  8933. </p>
  8934. <p>
  8935. </p>
  8936. <table>
  8937. <thead>
  8938. <tr>
  8939. <th>Field</th>
  8940. <th>Description</th>
  8941. </tr>
  8942. </thead>
  8943. <tbody>
  8944. <tr>
  8945. <td>
  8946. <code>certSecretRef</code></br>
  8947. <em>
  8948. <a href="https://pkg.go.dev/github.com/external-secrets/external-secrets/apis/meta/v1#SecretKeySelector">
  8949. External Secrets meta/v1.SecretKeySelector
  8950. </a>
  8951. </em>
  8952. </td>
  8953. <td>
  8954. </td>
  8955. </tr>
  8956. </tbody>
  8957. </table>
  8958. <h3 id="external-secrets.io/v1beta1.YandexLockboxProvider">YandexLockboxProvider
  8959. </h3>
  8960. <p>
  8961. (<em>Appears on:</em>
  8962. <a href="#external-secrets.io/v1beta1.SecretStoreProvider">SecretStoreProvider</a>)
  8963. </p>
  8964. <p>
  8965. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
  8966. </p>
  8967. <table>
  8968. <thead>
  8969. <tr>
  8970. <th>Field</th>
  8971. <th>Description</th>
  8972. </tr>
  8973. </thead>
  8974. <tbody>
  8975. <tr>
  8976. <td>
  8977. <code>apiEndpoint</code></br>
  8978. <em>
  8979. string
  8980. </em>
  8981. </td>
  8982. <td>
  8983. <em>(Optional)</em>
  8984. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  8985. </td>
  8986. </tr>
  8987. <tr>
  8988. <td>
  8989. <code>auth</code></br>
  8990. <em>
  8991. <a href="#external-secrets.io/v1beta1.YandexLockboxAuth">
  8992. YandexLockboxAuth
  8993. </a>
  8994. </em>
  8995. </td>
  8996. <td>
  8997. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
  8998. </td>
  8999. </tr>
  9000. <tr>
  9001. <td>
  9002. <code>caProvider</code></br>
  9003. <em>
  9004. <a href="#external-secrets.io/v1beta1.YandexLockboxCAProvider">
  9005. YandexLockboxCAProvider
  9006. </a>
  9007. </em>
  9008. </td>
  9009. <td>
  9010. <em>(Optional)</em>
  9011. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  9012. </td>
  9013. </tr>
  9014. </tbody>
  9015. </table>
  9016. <hr/>
  9017. <p><em>
  9018. Generated with <code>gen-crd-api-reference-docs</code>.
  9019. </em></p>
  9020. </article>
  9021. </div>
  9022. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  9023. </div>
  9024. </main>
  9025. <footer class="md-footer">
  9026. <div class="md-footer-meta md-typeset">
  9027. <div class="md-footer-meta__inner md-grid">
  9028. <div class="md-copyright">
  9029. <div class="md-copyright__highlight">
  9030. &copy; 2023 The external-secrets Authors.<br/>
  9031. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  9032. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  9033. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  9034. </div>
  9035. Made with
  9036. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  9037. Material for MkDocs
  9038. </a>
  9039. </div>
  9040. </div>
  9041. </div>
  9042. </footer>
  9043. </div>
  9044. <div class="md-dialog" data-md-component="dialog">
  9045. <div class="md-dialog__inner md-typeset"></div>
  9046. </div>
  9047. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  9048. <script src="../../assets/javascripts/bundle.8fd75fb4.min.js"></script>
  9049. </body>
  9050. </html>