index.html 135 KB

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