index.html 129 KB

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