index.html 216 KB

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