index.html 142 KB

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