index.html 104 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="icon" href="../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
  8. <title>API specification - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. </div>
  24. <div data-md-component="announce">
  25. </div>
  26. <div data-md-component="outdated" hidden>
  27. <aside class="md-banner md-banner--warning">
  28. <div class="md-banner__inner md-grid md-typeset">
  29. You're not viewing the latest version.
  30. <a href="../..">
  31. <strong>Click here to go to latest.</strong>
  32. </a>
  33. </div>
  34. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  35. </aside>
  36. </div>
  37. <header class="md-header" data-md-component="header">
  38. <nav class="md-header__inner md-grid" aria-label="Header">
  39. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  40. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  41. </a>
  42. <label class="md-header__button md-icon" for="__drawer">
  43. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  44. </label>
  45. <div class="md-header__title" data-md-component="header-title">
  46. <div class="md-header__ellipsis">
  47. <div class="md-header__topic">
  48. <span class="md-ellipsis">
  49. External Secrets Operator
  50. </span>
  51. </div>
  52. <div class="md-header__topic" data-md-component="header-topic">
  53. <span class="md-ellipsis">
  54. API specification
  55. </span>
  56. </div>
  57. </div>
  58. </div>
  59. <label class="md-header__button md-icon" for="__search">
  60. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  61. </label>
  62. <div class="md-search" data-md-component="search" role="dialog">
  63. <label class="md-search__overlay" for="__search"></label>
  64. <div class="md-search__inner" role="search">
  65. <form class="md-search__form" name="search">
  66. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  67. <label class="md-search__icon md-icon" for="__search">
  68. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  69. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  70. </label>
  71. <nav class="md-search__options" aria-label="Search">
  72. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  73. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  74. </button>
  75. </nav>
  76. </form>
  77. <div class="md-search__output">
  78. <div class="md-search__scrollwrap" data-md-scrollfix>
  79. <div class="md-search-result" data-md-component="search-result">
  80. <div class="md-search-result__meta">
  81. Initializing search
  82. </div>
  83. <ol class="md-search-result__list"></ol>
  84. </div>
  85. </div>
  86. </div>
  87. </div>
  88. </div>
  89. <div class="md-header__source">
  90. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  91. <div class="md-source__icon md-icon">
  92. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  93. </div>
  94. <div class="md-source__repository">
  95. External Secrets Operator
  96. </div>
  97. </a>
  98. </div>
  99. </nav>
  100. </header>
  101. <div class="md-container" data-md-component="container">
  102. <main class="md-main" data-md-component="main">
  103. <div class="md-main__inner md-grid">
  104. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  105. <div class="md-sidebar__scrollwrap">
  106. <div class="md-sidebar__inner">
  107. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  108. <label class="md-nav__title" for="__drawer">
  109. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  110. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  111. </a>
  112. External Secrets Operator
  113. </label>
  114. <div class="md-nav__source">
  115. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  116. <div class="md-source__icon md-icon">
  117. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  118. </div>
  119. <div class="md-source__repository">
  120. External Secrets Operator
  121. </div>
  122. </a>
  123. </div>
  124. <ul class="md-nav__list" data-md-scrollfix>
  125. <li class="md-nav__item">
  126. <a href=".." class="md-nav__link">
  127. Introduction
  128. </a>
  129. </li>
  130. <li class="md-nav__item">
  131. <a href="../api-overview/" class="md-nav__link">
  132. Overview
  133. </a>
  134. </li>
  135. <li class="md-nav__item md-nav__item--nested">
  136. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  137. <label class="md-nav__link" for="__nav_3">
  138. API Types
  139. <span class="md-nav__icon md-icon"></span>
  140. </label>
  141. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  142. <label class="md-nav__title" for="__nav_3">
  143. <span class="md-nav__icon md-icon"></span>
  144. API Types
  145. </label>
  146. <ul class="md-nav__list" data-md-scrollfix>
  147. <li class="md-nav__item">
  148. <a href="../api-externalsecret/" class="md-nav__link">
  149. ExternalSecret
  150. </a>
  151. </li>
  152. <li class="md-nav__item">
  153. <a href="../api-secretstore/" class="md-nav__link">
  154. SecretStore
  155. </a>
  156. </li>
  157. <li class="md-nav__item">
  158. <a href="../api-clustersecretstore/" class="md-nav__link">
  159. ClusterSecretStore
  160. </a>
  161. </li>
  162. <li class="md-nav__item">
  163. <a href="../api-clusterexternalsecret/" class="md-nav__link">
  164. ClusterExternalSecret
  165. </a>
  166. </li>
  167. </ul>
  168. </nav>
  169. </li>
  170. <li class="md-nav__item md-nav__item--nested">
  171. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  172. <label class="md-nav__link" for="__nav_4">
  173. Guides
  174. <span class="md-nav__icon md-icon"></span>
  175. </label>
  176. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  177. <label class="md-nav__title" for="__nav_4">
  178. <span class="md-nav__icon md-icon"></span>
  179. Guides
  180. </label>
  181. <ul class="md-nav__list" data-md-scrollfix>
  182. <li class="md-nav__item">
  183. <a href="../guides-introduction/" class="md-nav__link">
  184. Introduction
  185. </a>
  186. </li>
  187. <li class="md-nav__item">
  188. <a href="../guides-getting-started/" class="md-nav__link">
  189. Getting started
  190. </a>
  191. </li>
  192. <li class="md-nav__item md-nav__item--nested">
  193. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  194. <label class="md-nav__link" for="__nav_4_3">
  195. Advanced Templating
  196. <span class="md-nav__icon md-icon"></span>
  197. </label>
  198. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  199. <label class="md-nav__title" for="__nav_4_3">
  200. <span class="md-nav__icon md-icon"></span>
  201. Advanced Templating
  202. </label>
  203. <ul class="md-nav__list" data-md-scrollfix>
  204. <li class="md-nav__item">
  205. <a href="../guides-templating/" class="md-nav__link">
  206. v2
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../guides-templating-v1/" class="md-nav__link">
  211. v1
  212. </a>
  213. </li>
  214. </ul>
  215. </nav>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  219. All keys, One secret
  220. </a>
  221. </li>
  222. <li class="md-nav__item">
  223. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  224. Common K8S Secret Types
  225. </a>
  226. </li>
  227. <li class="md-nav__item">
  228. <a href="../guides-controller-class/" class="md-nav__link">
  229. Controller Classes
  230. </a>
  231. </li>
  232. <li class="md-nav__item">
  233. <a href="../guides-multi-tenancy/" class="md-nav__link">
  234. Multi Tenancy
  235. </a>
  236. </li>
  237. <li class="md-nav__item">
  238. <a href="../guides-metrics/" class="md-nav__link">
  239. Metrics
  240. </a>
  241. </li>
  242. <li class="md-nav__item">
  243. <a href="../guides-v1beta1/" class="md-nav__link">
  244. Upgrading to v1beta1
  245. </a>
  246. </li>
  247. <li class="md-nav__item">
  248. <a href="../guides-using-latest-image/" class="md-nav__link">
  249. Using Latest Image
  250. </a>
  251. </li>
  252. </ul>
  253. </nav>
  254. </li>
  255. <li class="md-nav__item md-nav__item--nested">
  256. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  257. <label class="md-nav__link" for="__nav_5">
  258. Provider
  259. <span class="md-nav__icon md-icon"></span>
  260. </label>
  261. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  262. <label class="md-nav__title" for="__nav_5">
  263. <span class="md-nav__icon md-icon"></span>
  264. Provider
  265. </label>
  266. <ul class="md-nav__list" data-md-scrollfix>
  267. <li class="md-nav__item md-nav__item--nested">
  268. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  269. <label class="md-nav__link" for="__nav_5_1">
  270. AWS
  271. <span class="md-nav__icon md-icon"></span>
  272. </label>
  273. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  274. <label class="md-nav__title" for="__nav_5_1">
  275. <span class="md-nav__icon md-icon"></span>
  276. AWS
  277. </label>
  278. <ul class="md-nav__list" data-md-scrollfix>
  279. <li class="md-nav__item">
  280. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  281. Secrets Manager
  282. </a>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  286. Parameter Store
  287. </a>
  288. </li>
  289. </ul>
  290. </nav>
  291. </li>
  292. <li class="md-nav__item md-nav__item--nested">
  293. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  294. <label class="md-nav__link" for="__nav_5_2">
  295. Azure
  296. <span class="md-nav__icon md-icon"></span>
  297. </label>
  298. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  299. <label class="md-nav__title" for="__nav_5_2">
  300. <span class="md-nav__icon md-icon"></span>
  301. Azure
  302. </label>
  303. <ul class="md-nav__list" data-md-scrollfix>
  304. <li class="md-nav__item">
  305. <a href="../provider-azure-key-vault/" class="md-nav__link">
  306. Key Vault
  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_3" type="checkbox" id="__nav_5_3" >
  314. <label class="md-nav__link" for="__nav_5_3">
  315. Google
  316. <span class="md-nav__icon md-icon"></span>
  317. </label>
  318. <nav class="md-nav" aria-label="Google" data-md-level="2">
  319. <label class="md-nav__title" for="__nav_5_3">
  320. <span class="md-nav__icon md-icon"></span>
  321. Google
  322. </label>
  323. <ul class="md-nav__list" data-md-scrollfix>
  324. <li class="md-nav__item">
  325. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  326. Secret Manager
  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_4" type="checkbox" id="__nav_5_4" >
  334. <label class="md-nav__link" for="__nav_5_4">
  335. IBM
  336. <span class="md-nav__icon md-icon"></span>
  337. </label>
  338. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  339. <label class="md-nav__title" for="__nav_5_4">
  340. <span class="md-nav__icon md-icon"></span>
  341. IBM
  342. </label>
  343. <ul class="md-nav__list" data-md-scrollfix>
  344. <li class="md-nav__item">
  345. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  346. Secrets Manager
  347. </a>
  348. </li>
  349. </ul>
  350. </nav>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../provider-akeyless/" class="md-nav__link">
  354. Akeyless
  355. </a>
  356. </li>
  357. <li class="md-nav__item">
  358. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  359. HashiCorp Vault
  360. </a>
  361. </li>
  362. <li class="md-nav__item md-nav__item--nested">
  363. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  364. <label class="md-nav__link" for="__nav_5_7">
  365. Yandex
  366. <span class="md-nav__icon md-icon"></span>
  367. </label>
  368. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  369. <label class="md-nav__title" for="__nav_5_7">
  370. <span class="md-nav__icon md-icon"></span>
  371. Yandex
  372. </label>
  373. <ul class="md-nav__list" data-md-scrollfix>
  374. <li class="md-nav__item">
  375. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  376. Lockbox
  377. </a>
  378. </li>
  379. </ul>
  380. </nav>
  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_8" type="checkbox" id="__nav_5_8" >
  384. <label class="md-nav__link" for="__nav_5_8">
  385. Gitlab
  386. <span class="md-nav__icon md-icon"></span>
  387. </label>
  388. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  389. <label class="md-nav__title" for="__nav_5_8">
  390. <span class="md-nav__icon md-icon"></span>
  391. Gitlab
  392. </label>
  393. <ul class="md-nav__list" data-md-scrollfix>
  394. <li class="md-nav__item">
  395. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  396. Gitlab Project Variables
  397. </a>
  398. </li>
  399. </ul>
  400. </nav>
  401. </li>
  402. <li class="md-nav__item md-nav__item--nested">
  403. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  404. <label class="md-nav__link" for="__nav_5_9">
  405. Oracle
  406. <span class="md-nav__icon md-icon"></span>
  407. </label>
  408. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  409. <label class="md-nav__title" for="__nav_5_9">
  410. <span class="md-nav__icon md-icon"></span>
  411. Oracle
  412. </label>
  413. <ul class="md-nav__list" data-md-scrollfix>
  414. <li class="md-nav__item">
  415. <a href="../provider-oracle-vault/" class="md-nav__link">
  416. Oracle Vault
  417. </a>
  418. </li>
  419. </ul>
  420. </nav>
  421. </li>
  422. <li class="md-nav__item">
  423. <a href="../provider-webhook/" class="md-nav__link">
  424. Webhook
  425. </a>
  426. </li>
  427. <li class="md-nav__item">
  428. <a href="../provider-fake/" class="md-nav__link">
  429. Fake
  430. </a>
  431. </li>
  432. <li class="md-nav__item">
  433. <a href="../provider-kubernetes/" class="md-nav__link">
  434. Kubernetes
  435. </a>
  436. </li>
  437. </ul>
  438. </nav>
  439. </li>
  440. <li class="md-nav__item md-nav__item--nested">
  441. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  442. <label class="md-nav__link" for="__nav_6">
  443. Examples
  444. <span class="md-nav__icon md-icon"></span>
  445. </label>
  446. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  447. <label class="md-nav__title" for="__nav_6">
  448. <span class="md-nav__icon md-icon"></span>
  449. Examples
  450. </label>
  451. <ul class="md-nav__list" data-md-scrollfix>
  452. <li class="md-nav__item">
  453. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  454. FluxCD
  455. </a>
  456. </li>
  457. <li class="md-nav__item">
  458. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  459. Anchore Engine
  460. </a>
  461. </li>
  462. <li class="md-nav__item">
  463. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  464. Jenkins
  465. </a>
  466. </li>
  467. </ul>
  468. </nav>
  469. </li>
  470. <li class="md-nav__item md-nav__item--nested">
  471. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  472. <label class="md-nav__link" for="__nav_7">
  473. External Resources
  474. <span class="md-nav__icon md-icon"></span>
  475. </label>
  476. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  477. <label class="md-nav__title" for="__nav_7">
  478. <span class="md-nav__icon md-icon"></span>
  479. External Resources
  480. </label>
  481. <ul class="md-nav__list" data-md-scrollfix>
  482. <li class="md-nav__item">
  483. <a href="../eso-talks/" class="md-nav__link">
  484. Talks
  485. </a>
  486. </li>
  487. <li class="md-nav__item">
  488. <a href="../eso-demos/" class="md-nav__link">
  489. Demos
  490. </a>
  491. </li>
  492. <li class="md-nav__item">
  493. <a href="../eso-blogs/" class="md-nav__link">
  494. Blogs
  495. </a>
  496. </li>
  497. </ul>
  498. </nav>
  499. </li>
  500. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  501. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" checked>
  502. <label class="md-nav__link" for="__nav_8">
  503. References
  504. <span class="md-nav__icon md-icon"></span>
  505. </label>
  506. <nav class="md-nav" aria-label="References" data-md-level="1">
  507. <label class="md-nav__title" for="__nav_8">
  508. <span class="md-nav__icon md-icon"></span>
  509. References
  510. </label>
  511. <ul class="md-nav__list" data-md-scrollfix>
  512. <li class="md-nav__item md-nav__item--active">
  513. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  514. <a href="./" class="md-nav__link md-nav__link--active">
  515. API specification
  516. </a>
  517. </li>
  518. </ul>
  519. </nav>
  520. </li>
  521. <li class="md-nav__item md-nav__item--nested">
  522. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  523. <label class="md-nav__link" for="__nav_9">
  524. Contributing
  525. <span class="md-nav__icon md-icon"></span>
  526. </label>
  527. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  528. <label class="md-nav__title" for="__nav_9">
  529. <span class="md-nav__icon md-icon"></span>
  530. Contributing
  531. </label>
  532. <ul class="md-nav__list" data-md-scrollfix>
  533. <li class="md-nav__item">
  534. <a href="../contributing-devguide/" class="md-nav__link">
  535. Developer guide
  536. </a>
  537. </li>
  538. <li class="md-nav__item">
  539. <a href="../contributing-process/" class="md-nav__link">
  540. Contributing Process
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="../contributing-release/" class="md-nav__link">
  545. Release Process
  546. </a>
  547. </li>
  548. <li class="md-nav__item">
  549. <a href="../contributing-coc/" class="md-nav__link">
  550. Code of Conduct
  551. </a>
  552. </li>
  553. </ul>
  554. </nav>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="../deprecation-policy/" class="md-nav__link">
  558. Deprecation Policy
  559. </a>
  560. </li>
  561. </ul>
  562. </nav>
  563. </div>
  564. </div>
  565. </div>
  566. <div class="md-content" data-md-component="content">
  567. <article class="md-content__inner md-typeset">
  568. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/spec.md" title="Edit this page" class="md-content__button md-icon">
  569. <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>
  570. </a>
  571. <h1>API specification</h1>
  572. <p>Packages:</p>
  573. <ul>
  574. <li>
  575. <a href="#external-secrets.io%2fv1alpha1">external-secrets.io/v1alpha1</a>
  576. </li>
  577. </ul>
  578. <h2 id="external-secrets.io/v1alpha1">external-secrets.io/v1alpha1</h2>
  579. <p>
  580. <p>Package v1alpha1 contains resources for external-secrets</p>
  581. </p>
  582. <p>Resource Types:</p>
  583. <ul></ul>
  584. <h3 id="external-secrets.io/v1alpha1.AWSAuth">AWSAuth
  585. </h3>
  586. <p>
  587. (<em>Appears on:</em>
  588. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
  589. </p>
  590. <p>
  591. <p>AWSAuth tells the controller how to do authentication with aws.
  592. Only one of secretRef or jwt can be specified.
  593. if none is specified the controller will load credentials using the aws sdk defaults.</p>
  594. </p>
  595. <table>
  596. <thead>
  597. <tr>
  598. <th>Field</th>
  599. <th>Description</th>
  600. </tr>
  601. </thead>
  602. <tbody>
  603. <tr>
  604. <td>
  605. <code>secretRef</code></br>
  606. <em>
  607. <a href="#external-secrets.io/v1alpha1.AWSAuthSecretRef">
  608. AWSAuthSecretRef
  609. </a>
  610. </em>
  611. </td>
  612. <td>
  613. <em>(Optional)</em>
  614. </td>
  615. </tr>
  616. <tr>
  617. <td>
  618. <code>jwt</code></br>
  619. <em>
  620. <a href="#external-secrets.io/v1alpha1.AWSJWTAuth">
  621. AWSJWTAuth
  622. </a>
  623. </em>
  624. </td>
  625. <td>
  626. <em>(Optional)</em>
  627. </td>
  628. </tr>
  629. </tbody>
  630. </table>
  631. <h3 id="external-secrets.io/v1alpha1.AWSAuthSecretRef">AWSAuthSecretRef
  632. </h3>
  633. <p>
  634. (<em>Appears on:</em>
  635. <a href="#external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
  636. </p>
  637. <p>
  638. <p>AWSAuthSecretRef holds secret references for AWS credentials
  639. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  640. </p>
  641. <table>
  642. <thead>
  643. <tr>
  644. <th>Field</th>
  645. <th>Description</th>
  646. </tr>
  647. </thead>
  648. <tbody>
  649. <tr>
  650. <td>
  651. <code>accessKeyIDSecretRef</code></br>
  652. <em>
  653. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  654. </em>
  655. </td>
  656. <td>
  657. <p>The AccessKeyID is used for authentication</p>
  658. </td>
  659. </tr>
  660. <tr>
  661. <td>
  662. <code>secretAccessKeySecretRef</code></br>
  663. <em>
  664. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  665. </em>
  666. </td>
  667. <td>
  668. <p>The SecretAccessKey is used for authentication</p>
  669. </td>
  670. </tr>
  671. </tbody>
  672. </table>
  673. <h3 id="external-secrets.io/v1alpha1.AWSJWTAuth">AWSJWTAuth
  674. </h3>
  675. <p>
  676. (<em>Appears on:</em>
  677. <a href="#external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
  678. </p>
  679. <p>
  680. <p>Authenticate against AWS using service account tokens.</p>
  681. </p>
  682. <table>
  683. <thead>
  684. <tr>
  685. <th>Field</th>
  686. <th>Description</th>
  687. </tr>
  688. </thead>
  689. <tbody>
  690. <tr>
  691. <td>
  692. <code>serviceAccountRef</code></br>
  693. <em>
  694. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  695. </em>
  696. </td>
  697. <td>
  698. </td>
  699. </tr>
  700. </tbody>
  701. </table>
  702. <h3 id="external-secrets.io/v1alpha1.AWSProvider">AWSProvider
  703. </h3>
  704. <p>
  705. (<em>Appears on:</em>
  706. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  707. </p>
  708. <p>
  709. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  710. </p>
  711. <table>
  712. <thead>
  713. <tr>
  714. <th>Field</th>
  715. <th>Description</th>
  716. </tr>
  717. </thead>
  718. <tbody>
  719. <tr>
  720. <td>
  721. <code>service</code></br>
  722. <em>
  723. <a href="#external-secrets.io/v1alpha1.AWSServiceType">
  724. AWSServiceType
  725. </a>
  726. </em>
  727. </td>
  728. <td>
  729. <p>Service defines which service should be used to fetch the secrets</p>
  730. </td>
  731. </tr>
  732. <tr>
  733. <td>
  734. <code>auth</code></br>
  735. <em>
  736. <a href="#external-secrets.io/v1alpha1.AWSAuth">
  737. AWSAuth
  738. </a>
  739. </em>
  740. </td>
  741. <td>
  742. <em>(Optional)</em>
  743. <p>Auth defines the information necessary to authenticate against AWS
  744. if not set aws sdk will infer credentials from your environment
  745. 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>
  746. </td>
  747. </tr>
  748. <tr>
  749. <td>
  750. <code>role</code></br>
  751. <em>
  752. string
  753. </em>
  754. </td>
  755. <td>
  756. <em>(Optional)</em>
  757. <p>Role is a Role ARN which the SecretManager provider will assume</p>
  758. </td>
  759. </tr>
  760. <tr>
  761. <td>
  762. <code>region</code></br>
  763. <em>
  764. string
  765. </em>
  766. </td>
  767. <td>
  768. <p>AWS Region to be used for the provider</p>
  769. </td>
  770. </tr>
  771. </tbody>
  772. </table>
  773. <h3 id="external-secrets.io/v1alpha1.AWSServiceType">AWSServiceType
  774. (<code>string</code> alias)</p></h3>
  775. <p>
  776. (<em>Appears on:</em>
  777. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
  778. </p>
  779. <p>
  780. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  781. </p>
  782. <table>
  783. <thead>
  784. <tr>
  785. <th>Value</th>
  786. <th>Description</th>
  787. </tr>
  788. </thead>
  789. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  790. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore.
  791. 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>
  792. </td>
  793. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  794. <td><p>AWSServiceSecretsManager is the AWS SecretsManager.
  795. 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>
  796. </td>
  797. </tr></tbody>
  798. </table>
  799. <h3 id="external-secrets.io/v1alpha1.AkeylessAuth">AkeylessAuth
  800. </h3>
  801. <p>
  802. (<em>Appears on:</em>
  803. <a href="#external-secrets.io/v1alpha1.AkeylessProvider">AkeylessProvider</a>)
  804. </p>
  805. <p>
  806. </p>
  807. <table>
  808. <thead>
  809. <tr>
  810. <th>Field</th>
  811. <th>Description</th>
  812. </tr>
  813. </thead>
  814. <tbody>
  815. <tr>
  816. <td>
  817. <code>secretRef</code></br>
  818. <em>
  819. <a href="#external-secrets.io/v1alpha1.AkeylessAuthSecretRef">
  820. AkeylessAuthSecretRef
  821. </a>
  822. </em>
  823. </td>
  824. <td>
  825. </td>
  826. </tr>
  827. </tbody>
  828. </table>
  829. <h3 id="external-secrets.io/v1alpha1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
  830. </h3>
  831. <p>
  832. (<em>Appears on:</em>
  833. <a href="#external-secrets.io/v1alpha1.AkeylessAuth">AkeylessAuth</a>)
  834. </p>
  835. <p>
  836. <p>AkeylessAuthSecretRef
  837. AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
  838. </p>
  839. <table>
  840. <thead>
  841. <tr>
  842. <th>Field</th>
  843. <th>Description</th>
  844. </tr>
  845. </thead>
  846. <tbody>
  847. <tr>
  848. <td>
  849. <code>accessID</code></br>
  850. <em>
  851. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  852. </em>
  853. </td>
  854. <td>
  855. <p>The SecretAccessID is used for authentication</p>
  856. </td>
  857. </tr>
  858. <tr>
  859. <td>
  860. <code>accessType</code></br>
  861. <em>
  862. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  863. </em>
  864. </td>
  865. <td>
  866. </td>
  867. </tr>
  868. <tr>
  869. <td>
  870. <code>accessTypeParam</code></br>
  871. <em>
  872. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  873. </em>
  874. </td>
  875. <td>
  876. </td>
  877. </tr>
  878. </tbody>
  879. </table>
  880. <h3 id="external-secrets.io/v1alpha1.AkeylessProvider">AkeylessProvider
  881. </h3>
  882. <p>
  883. (<em>Appears on:</em>
  884. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  885. </p>
  886. <p>
  887. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  888. </p>
  889. <table>
  890. <thead>
  891. <tr>
  892. <th>Field</th>
  893. <th>Description</th>
  894. </tr>
  895. </thead>
  896. <tbody>
  897. <tr>
  898. <td>
  899. <code>akeylessGWApiURL</code></br>
  900. <em>
  901. string
  902. </em>
  903. </td>
  904. <td>
  905. <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
  906. </td>
  907. </tr>
  908. <tr>
  909. <td>
  910. <code>authSecretRef</code></br>
  911. <em>
  912. <a href="#external-secrets.io/v1alpha1.AkeylessAuth">
  913. AkeylessAuth
  914. </a>
  915. </em>
  916. </td>
  917. <td>
  918. <p>Auth configures how the operator authenticates with Akeyless.</p>
  919. </td>
  920. </tr>
  921. </tbody>
  922. </table>
  923. <h3 id="external-secrets.io/v1alpha1.AlibabaAuth">AlibabaAuth
  924. </h3>
  925. <p>
  926. (<em>Appears on:</em>
  927. <a href="#external-secrets.io/v1alpha1.AlibabaProvider">AlibabaProvider</a>)
  928. </p>
  929. <p>
  930. <p>AlibabaAuth contains a secretRef for credentials.</p>
  931. </p>
  932. <table>
  933. <thead>
  934. <tr>
  935. <th>Field</th>
  936. <th>Description</th>
  937. </tr>
  938. </thead>
  939. <tbody>
  940. <tr>
  941. <td>
  942. <code>secretRef</code></br>
  943. <em>
  944. <a href="#external-secrets.io/v1alpha1.AlibabaAuthSecretRef">
  945. AlibabaAuthSecretRef
  946. </a>
  947. </em>
  948. </td>
  949. <td>
  950. </td>
  951. </tr>
  952. </tbody>
  953. </table>
  954. <h3 id="external-secrets.io/v1alpha1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
  955. </h3>
  956. <p>
  957. (<em>Appears on:</em>
  958. <a href="#external-secrets.io/v1alpha1.AlibabaAuth">AlibabaAuth</a>)
  959. </p>
  960. <p>
  961. <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
  962. </p>
  963. <table>
  964. <thead>
  965. <tr>
  966. <th>Field</th>
  967. <th>Description</th>
  968. </tr>
  969. </thead>
  970. <tbody>
  971. <tr>
  972. <td>
  973. <code>accessKeyIDSecretRef</code></br>
  974. <em>
  975. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  976. </em>
  977. </td>
  978. <td>
  979. <p>The AccessKeyID is used for authentication</p>
  980. </td>
  981. </tr>
  982. <tr>
  983. <td>
  984. <code>accessKeySecretSecretRef</code></br>
  985. <em>
  986. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  987. </em>
  988. </td>
  989. <td>
  990. <p>The AccessKeySecret is used for authentication</p>
  991. </td>
  992. </tr>
  993. </tbody>
  994. </table>
  995. <h3 id="external-secrets.io/v1alpha1.AlibabaProvider">AlibabaProvider
  996. </h3>
  997. <p>
  998. (<em>Appears on:</em>
  999. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  1000. </p>
  1001. <p>
  1002. <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
  1003. </p>
  1004. <table>
  1005. <thead>
  1006. <tr>
  1007. <th>Field</th>
  1008. <th>Description</th>
  1009. </tr>
  1010. </thead>
  1011. <tbody>
  1012. <tr>
  1013. <td>
  1014. <code>auth</code></br>
  1015. <em>
  1016. <a href="#external-secrets.io/v1alpha1.AlibabaAuth">
  1017. AlibabaAuth
  1018. </a>
  1019. </em>
  1020. </td>
  1021. <td>
  1022. </td>
  1023. </tr>
  1024. <tr>
  1025. <td>
  1026. <code>endpoint</code></br>
  1027. <em>
  1028. string
  1029. </em>
  1030. </td>
  1031. <td>
  1032. <em>(Optional)</em>
  1033. </td>
  1034. </tr>
  1035. <tr>
  1036. <td>
  1037. <code>regionID</code></br>
  1038. <em>
  1039. string
  1040. </em>
  1041. </td>
  1042. <td>
  1043. <p>Alibaba Region to be used for the provider</p>
  1044. </td>
  1045. </tr>
  1046. </tbody>
  1047. </table>
  1048. <h3 id="external-secrets.io/v1alpha1.AzureAuthType">AzureAuthType
  1049. (<code>string</code> alias)</p></h3>
  1050. <p>
  1051. (<em>Appears on:</em>
  1052. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider</a>)
  1053. </p>
  1054. <p>
  1055. <p>AuthType describes how to authenticate to the Azure Keyvault
  1056. Only one of the following auth types may be specified.
  1057. If none of the following auth type is specified, the default one
  1058. is ServicePrincipal.</p>
  1059. </p>
  1060. <table>
  1061. <thead>
  1062. <tr>
  1063. <th>Value</th>
  1064. <th>Description</th>
  1065. </tr>
  1066. </thead>
  1067. <tbody><tr><td><p>&#34;ManagedIdentity&#34;</p></td>
  1068. <td><p>Using Managed Identity to authenticate. Used with aad-pod-identity installed in the clister.</p>
  1069. </td>
  1070. </tr><tr><td><p>&#34;ServicePrincipal&#34;</p></td>
  1071. <td><p>Using service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.</p>
  1072. </td>
  1073. </tr><tr><td><p>&#34;WorkloadIdentity&#34;</p></td>
  1074. <td><p>Using Workload Identity service accounts to authenticate.</p>
  1075. </td>
  1076. </tr></tbody>
  1077. </table>
  1078. <h3 id="external-secrets.io/v1alpha1.AzureKVAuth">AzureKVAuth
  1079. </h3>
  1080. <p>
  1081. (<em>Appears on:</em>
  1082. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider</a>)
  1083. </p>
  1084. <p>
  1085. <p>Configuration used to authenticate with Azure.</p>
  1086. </p>
  1087. <table>
  1088. <thead>
  1089. <tr>
  1090. <th>Field</th>
  1091. <th>Description</th>
  1092. </tr>
  1093. </thead>
  1094. <tbody>
  1095. <tr>
  1096. <td>
  1097. <code>clientId</code></br>
  1098. <em>
  1099. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1100. </em>
  1101. </td>
  1102. <td>
  1103. <em>(Optional)</em>
  1104. <p>The Azure clientId of the service principle used for authentication.</p>
  1105. </td>
  1106. </tr>
  1107. <tr>
  1108. <td>
  1109. <code>clientSecret</code></br>
  1110. <em>
  1111. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1112. </em>
  1113. </td>
  1114. <td>
  1115. <em>(Optional)</em>
  1116. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  1117. </td>
  1118. </tr>
  1119. </tbody>
  1120. </table>
  1121. <h3 id="external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider
  1122. </h3>
  1123. <p>
  1124. (<em>Appears on:</em>
  1125. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  1126. </p>
  1127. <p>
  1128. <p>Configures an store to sync secrets using Azure KV.</p>
  1129. </p>
  1130. <table>
  1131. <thead>
  1132. <tr>
  1133. <th>Field</th>
  1134. <th>Description</th>
  1135. </tr>
  1136. </thead>
  1137. <tbody>
  1138. <tr>
  1139. <td>
  1140. <code>authType</code></br>
  1141. <em>
  1142. <a href="#external-secrets.io/v1alpha1.AzureAuthType">
  1143. AzureAuthType
  1144. </a>
  1145. </em>
  1146. </td>
  1147. <td>
  1148. <em>(Optional)</em>
  1149. <p>Auth type defines how to authenticate to the keyvault service.
  1150. Valid values are:
  1151. - &ldquo;ServicePrincipal&rdquo; (default): Using a service principal (tenantId, clientId, clientSecret)
  1152. - &ldquo;ManagedIdentity&rdquo;: Using Managed Identity assigned to the pod (see aad-pod-identity)</p>
  1153. </td>
  1154. </tr>
  1155. <tr>
  1156. <td>
  1157. <code>vaultUrl</code></br>
  1158. <em>
  1159. string
  1160. </em>
  1161. </td>
  1162. <td>
  1163. <p>Vault Url from which the secrets to be fetched from.</p>
  1164. </td>
  1165. </tr>
  1166. <tr>
  1167. <td>
  1168. <code>tenantId</code></br>
  1169. <em>
  1170. string
  1171. </em>
  1172. </td>
  1173. <td>
  1174. <em>(Optional)</em>
  1175. <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type.</p>
  1176. </td>
  1177. </tr>
  1178. <tr>
  1179. <td>
  1180. <code>authSecretRef</code></br>
  1181. <em>
  1182. <a href="#external-secrets.io/v1alpha1.AzureKVAuth">
  1183. AzureKVAuth
  1184. </a>
  1185. </em>
  1186. </td>
  1187. <td>
  1188. <em>(Optional)</em>
  1189. <p>Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type.</p>
  1190. </td>
  1191. </tr>
  1192. <tr>
  1193. <td>
  1194. <code>serviceAccountRef</code></br>
  1195. <em>
  1196. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  1197. </em>
  1198. </td>
  1199. <td>
  1200. <em>(Optional)</em>
  1201. <p>ServiceAccountRef specified the service account
  1202. that should be used when authenticating with WorkloadIdentity.</p>
  1203. </td>
  1204. </tr>
  1205. <tr>
  1206. <td>
  1207. <code>identityId</code></br>
  1208. <em>
  1209. string
  1210. </em>
  1211. </td>
  1212. <td>
  1213. <em>(Optional)</em>
  1214. <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
  1215. </td>
  1216. </tr>
  1217. </tbody>
  1218. </table>
  1219. <h3 id="external-secrets.io/v1alpha1.CAProvider">CAProvider
  1220. </h3>
  1221. <p>
  1222. (<em>Appears on:</em>
  1223. <a href="#external-secrets.io/v1alpha1.KubernetesServer">KubernetesServer</a>,
  1224. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  1225. </p>
  1226. <p>
  1227. <p>Defines a location to fetch the cert for the vault provider from.</p>
  1228. </p>
  1229. <table>
  1230. <thead>
  1231. <tr>
  1232. <th>Field</th>
  1233. <th>Description</th>
  1234. </tr>
  1235. </thead>
  1236. <tbody>
  1237. <tr>
  1238. <td>
  1239. <code>type</code></br>
  1240. <em>
  1241. <a href="#external-secrets.io/v1alpha1.CAProviderType">
  1242. CAProviderType
  1243. </a>
  1244. </em>
  1245. </td>
  1246. <td>
  1247. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  1248. </td>
  1249. </tr>
  1250. <tr>
  1251. <td>
  1252. <code>name</code></br>
  1253. <em>
  1254. string
  1255. </em>
  1256. </td>
  1257. <td>
  1258. <p>The name of the object located at the provider type.</p>
  1259. </td>
  1260. </tr>
  1261. <tr>
  1262. <td>
  1263. <code>key</code></br>
  1264. <em>
  1265. string
  1266. </em>
  1267. </td>
  1268. <td>
  1269. <p>The key the value inside of the provider type to use, only used with &ldquo;Secret&rdquo; type</p>
  1270. </td>
  1271. </tr>
  1272. <tr>
  1273. <td>
  1274. <code>namespace</code></br>
  1275. <em>
  1276. string
  1277. </em>
  1278. </td>
  1279. <td>
  1280. <em>(Optional)</em>
  1281. <p>The namespace the Provider type is in.</p>
  1282. </td>
  1283. </tr>
  1284. </tbody>
  1285. </table>
  1286. <h3 id="external-secrets.io/v1alpha1.CAProviderType">CAProviderType
  1287. (<code>string</code> alias)</p></h3>
  1288. <p>
  1289. (<em>Appears on:</em>
  1290. <a href="#external-secrets.io/v1alpha1.CAProvider">CAProvider</a>)
  1291. </p>
  1292. <p>
  1293. </p>
  1294. <table>
  1295. <thead>
  1296. <tr>
  1297. <th>Value</th>
  1298. <th>Description</th>
  1299. </tr>
  1300. </thead>
  1301. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  1302. <td></td>
  1303. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  1304. <td></td>
  1305. </tr></tbody>
  1306. </table>
  1307. <h3 id="external-secrets.io/v1alpha1.CertAuth">CertAuth
  1308. </h3>
  1309. <p>
  1310. (<em>Appears on:</em>
  1311. <a href="#external-secrets.io/v1alpha1.KubernetesAuth">KubernetesAuth</a>)
  1312. </p>
  1313. <p>
  1314. </p>
  1315. <table>
  1316. <thead>
  1317. <tr>
  1318. <th>Field</th>
  1319. <th>Description</th>
  1320. </tr>
  1321. </thead>
  1322. <tbody>
  1323. <tr>
  1324. <td>
  1325. <code>clientCert</code></br>
  1326. <em>
  1327. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1328. </em>
  1329. </td>
  1330. <td>
  1331. </td>
  1332. </tr>
  1333. <tr>
  1334. <td>
  1335. <code>clientKey</code></br>
  1336. <em>
  1337. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1338. </em>
  1339. </td>
  1340. <td>
  1341. </td>
  1342. </tr>
  1343. </tbody>
  1344. </table>
  1345. <h3 id="external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore
  1346. </h3>
  1347. <p>
  1348. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  1349. </p>
  1350. <table>
  1351. <thead>
  1352. <tr>
  1353. <th>Field</th>
  1354. <th>Description</th>
  1355. </tr>
  1356. </thead>
  1357. <tbody>
  1358. <tr>
  1359. <td>
  1360. <code>metadata</code></br>
  1361. <em>
  1362. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1363. Kubernetes meta/v1.ObjectMeta
  1364. </a>
  1365. </em>
  1366. </td>
  1367. <td>
  1368. Refer to the Kubernetes API documentation for the fields of the
  1369. <code>metadata</code> field.
  1370. </td>
  1371. </tr>
  1372. <tr>
  1373. <td>
  1374. <code>spec</code></br>
  1375. <em>
  1376. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  1377. SecretStoreSpec
  1378. </a>
  1379. </em>
  1380. </td>
  1381. <td>
  1382. <br/>
  1383. <br/>
  1384. <table>
  1385. <tr>
  1386. <td>
  1387. <code>controller</code></br>
  1388. <em>
  1389. string
  1390. </em>
  1391. </td>
  1392. <td>
  1393. <em>(Optional)</em>
  1394. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  1395. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  1396. </td>
  1397. </tr>
  1398. <tr>
  1399. <td>
  1400. <code>provider</code></br>
  1401. <em>
  1402. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  1403. SecretStoreProvider
  1404. </a>
  1405. </em>
  1406. </td>
  1407. <td>
  1408. <p>Used to configure the provider. Only one provider may be set</p>
  1409. </td>
  1410. </tr>
  1411. <tr>
  1412. <td>
  1413. <code>retrySettings</code></br>
  1414. <em>
  1415. <a href="#external-secrets.io/v1alpha1.SecretStoreRetrySettings">
  1416. SecretStoreRetrySettings
  1417. </a>
  1418. </em>
  1419. </td>
  1420. <td>
  1421. <em>(Optional)</em>
  1422. <p>Used to configure http retries if failed</p>
  1423. </td>
  1424. </tr>
  1425. </table>
  1426. </td>
  1427. </tr>
  1428. <tr>
  1429. <td>
  1430. <code>status</code></br>
  1431. <em>
  1432. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  1433. SecretStoreStatus
  1434. </a>
  1435. </em>
  1436. </td>
  1437. <td>
  1438. </td>
  1439. </tr>
  1440. </tbody>
  1441. </table>
  1442. <h3 id="external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret
  1443. </h3>
  1444. <p>
  1445. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  1446. </p>
  1447. <table>
  1448. <thead>
  1449. <tr>
  1450. <th>Field</th>
  1451. <th>Description</th>
  1452. </tr>
  1453. </thead>
  1454. <tbody>
  1455. <tr>
  1456. <td>
  1457. <code>metadata</code></br>
  1458. <em>
  1459. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1460. Kubernetes meta/v1.ObjectMeta
  1461. </a>
  1462. </em>
  1463. </td>
  1464. <td>
  1465. Refer to the Kubernetes API documentation for the fields of the
  1466. <code>metadata</code> field.
  1467. </td>
  1468. </tr>
  1469. <tr>
  1470. <td>
  1471. <code>spec</code></br>
  1472. <em>
  1473. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">
  1474. ExternalSecretSpec
  1475. </a>
  1476. </em>
  1477. </td>
  1478. <td>
  1479. <br/>
  1480. <br/>
  1481. <table>
  1482. <tr>
  1483. <td>
  1484. <code>secretStoreRef</code></br>
  1485. <em>
  1486. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  1487. SecretStoreRef
  1488. </a>
  1489. </em>
  1490. </td>
  1491. <td>
  1492. </td>
  1493. </tr>
  1494. <tr>
  1495. <td>
  1496. <code>target</code></br>
  1497. <em>
  1498. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  1499. ExternalSecretTarget
  1500. </a>
  1501. </em>
  1502. </td>
  1503. <td>
  1504. </td>
  1505. </tr>
  1506. <tr>
  1507. <td>
  1508. <code>refreshInterval</code></br>
  1509. <em>
  1510. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1511. Kubernetes meta/v1.Duration
  1512. </a>
  1513. </em>
  1514. </td>
  1515. <td>
  1516. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  1517. 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;
  1518. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  1519. </td>
  1520. </tr>
  1521. <tr>
  1522. <td>
  1523. <code>data</code></br>
  1524. <em>
  1525. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  1526. []ExternalSecretData
  1527. </a>
  1528. </em>
  1529. </td>
  1530. <td>
  1531. <em>(Optional)</em>
  1532. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  1533. </td>
  1534. </tr>
  1535. <tr>
  1536. <td>
  1537. <code>dataFrom</code></br>
  1538. <em>
  1539. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1540. []ExternalSecretDataRemoteRef
  1541. </a>
  1542. </em>
  1543. </td>
  1544. <td>
  1545. <em>(Optional)</em>
  1546. <p>DataFrom is used to fetch all properties from a specific Provider data
  1547. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  1548. </td>
  1549. </tr>
  1550. </table>
  1551. </td>
  1552. </tr>
  1553. <tr>
  1554. <td>
  1555. <code>status</code></br>
  1556. <em>
  1557. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">
  1558. ExternalSecretStatus
  1559. </a>
  1560. </em>
  1561. </td>
  1562. <td>
  1563. </td>
  1564. </tr>
  1565. </tbody>
  1566. </table>
  1567. <h3 id="external-secrets.io/v1alpha1.ExternalSecretConditionType">ExternalSecretConditionType
  1568. (<code>string</code> alias)</p></h3>
  1569. <p>
  1570. (<em>Appears on:</em>
  1571. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  1572. </p>
  1573. <p>
  1574. </p>
  1575. <table>
  1576. <thead>
  1577. <tr>
  1578. <th>Value</th>
  1579. <th>Description</th>
  1580. </tr>
  1581. </thead>
  1582. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
  1583. <td></td>
  1584. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  1585. <td></td>
  1586. </tr></tbody>
  1587. </table>
  1588. <h3 id="external-secrets.io/v1alpha1.ExternalSecretConversionStrategy">ExternalSecretConversionStrategy
  1589. (<code>string</code> alias)</p></h3>
  1590. <p>
  1591. (<em>Appears on:</em>
  1592. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>)
  1593. </p>
  1594. <p>
  1595. </p>
  1596. <table>
  1597. <thead>
  1598. <tr>
  1599. <th>Value</th>
  1600. <th>Description</th>
  1601. </tr>
  1602. </thead>
  1603. <tbody><tr><td><p>&#34;Default&#34;</p></td>
  1604. <td></td>
  1605. </tr><tr><td><p>&#34;Unicode&#34;</p></td>
  1606. <td></td>
  1607. </tr></tbody>
  1608. </table>
  1609. <h3 id="external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  1610. (<code>string</code> alias)</p></h3>
  1611. <p>
  1612. (<em>Appears on:</em>
  1613. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  1614. </p>
  1615. <p>
  1616. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  1617. </p>
  1618. <table>
  1619. <thead>
  1620. <tr>
  1621. <th>Value</th>
  1622. <th>Description</th>
  1623. </tr>
  1624. </thead>
  1625. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  1626. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  1627. </td>
  1628. </tr><tr><td><p>&#34;None&#34;</p></td>
  1629. <td><p>None does not create a Secret (future use with injector).</p>
  1630. </td>
  1631. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  1632. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  1633. </td>
  1634. </tr></tbody>
  1635. </table>
  1636. <h3 id="external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData
  1637. </h3>
  1638. <p>
  1639. (<em>Appears on:</em>
  1640. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1641. </p>
  1642. <p>
  1643. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  1644. </p>
  1645. <table>
  1646. <thead>
  1647. <tr>
  1648. <th>Field</th>
  1649. <th>Description</th>
  1650. </tr>
  1651. </thead>
  1652. <tbody>
  1653. <tr>
  1654. <td>
  1655. <code>secretKey</code></br>
  1656. <em>
  1657. string
  1658. </em>
  1659. </td>
  1660. <td>
  1661. </td>
  1662. </tr>
  1663. <tr>
  1664. <td>
  1665. <code>remoteRef</code></br>
  1666. <em>
  1667. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1668. ExternalSecretDataRemoteRef
  1669. </a>
  1670. </em>
  1671. </td>
  1672. <td>
  1673. </td>
  1674. </tr>
  1675. </tbody>
  1676. </table>
  1677. <h3 id="external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  1678. </h3>
  1679. <p>
  1680. (<em>Appears on:</em>
  1681. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData</a>,
  1682. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1683. </p>
  1684. <p>
  1685. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  1686. </p>
  1687. <table>
  1688. <thead>
  1689. <tr>
  1690. <th>Field</th>
  1691. <th>Description</th>
  1692. </tr>
  1693. </thead>
  1694. <tbody>
  1695. <tr>
  1696. <td>
  1697. <code>key</code></br>
  1698. <em>
  1699. string
  1700. </em>
  1701. </td>
  1702. <td>
  1703. <p>Key is the key used in the Provider, mandatory</p>
  1704. </td>
  1705. </tr>
  1706. <tr>
  1707. <td>
  1708. <code>version</code></br>
  1709. <em>
  1710. string
  1711. </em>
  1712. </td>
  1713. <td>
  1714. <em>(Optional)</em>
  1715. <p>Used to select a specific version of the Provider value, if supported</p>
  1716. </td>
  1717. </tr>
  1718. <tr>
  1719. <td>
  1720. <code>property</code></br>
  1721. <em>
  1722. string
  1723. </em>
  1724. </td>
  1725. <td>
  1726. <em>(Optional)</em>
  1727. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  1728. </td>
  1729. </tr>
  1730. <tr>
  1731. <td>
  1732. <code>conversionStrategy</code></br>
  1733. <em>
  1734. <a href="#external-secrets.io/v1alpha1.ExternalSecretConversionStrategy">
  1735. ExternalSecretConversionStrategy
  1736. </a>
  1737. </em>
  1738. </td>
  1739. <td>
  1740. <em>(Optional)</em>
  1741. <p>Used to define a conversion Strategy</p>
  1742. </td>
  1743. </tr>
  1744. </tbody>
  1745. </table>
  1746. <h3 id="external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec
  1747. </h3>
  1748. <p>
  1749. (<em>Appears on:</em>
  1750. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  1751. </p>
  1752. <p>
  1753. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  1754. </p>
  1755. <table>
  1756. <thead>
  1757. <tr>
  1758. <th>Field</th>
  1759. <th>Description</th>
  1760. </tr>
  1761. </thead>
  1762. <tbody>
  1763. <tr>
  1764. <td>
  1765. <code>secretStoreRef</code></br>
  1766. <em>
  1767. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  1768. SecretStoreRef
  1769. </a>
  1770. </em>
  1771. </td>
  1772. <td>
  1773. </td>
  1774. </tr>
  1775. <tr>
  1776. <td>
  1777. <code>target</code></br>
  1778. <em>
  1779. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  1780. ExternalSecretTarget
  1781. </a>
  1782. </em>
  1783. </td>
  1784. <td>
  1785. </td>
  1786. </tr>
  1787. <tr>
  1788. <td>
  1789. <code>refreshInterval</code></br>
  1790. <em>
  1791. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1792. Kubernetes meta/v1.Duration
  1793. </a>
  1794. </em>
  1795. </td>
  1796. <td>
  1797. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  1798. 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;
  1799. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  1800. </td>
  1801. </tr>
  1802. <tr>
  1803. <td>
  1804. <code>data</code></br>
  1805. <em>
  1806. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  1807. []ExternalSecretData
  1808. </a>
  1809. </em>
  1810. </td>
  1811. <td>
  1812. <em>(Optional)</em>
  1813. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  1814. </td>
  1815. </tr>
  1816. <tr>
  1817. <td>
  1818. <code>dataFrom</code></br>
  1819. <em>
  1820. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1821. []ExternalSecretDataRemoteRef
  1822. </a>
  1823. </em>
  1824. </td>
  1825. <td>
  1826. <em>(Optional)</em>
  1827. <p>DataFrom is used to fetch all properties from a specific Provider data
  1828. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  1829. </td>
  1830. </tr>
  1831. </tbody>
  1832. </table>
  1833. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus
  1834. </h3>
  1835. <p>
  1836. (<em>Appears on:</em>
  1837. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  1838. </p>
  1839. <p>
  1840. </p>
  1841. <table>
  1842. <thead>
  1843. <tr>
  1844. <th>Field</th>
  1845. <th>Description</th>
  1846. </tr>
  1847. </thead>
  1848. <tbody>
  1849. <tr>
  1850. <td>
  1851. <code>refreshTime</code></br>
  1852. <em>
  1853. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1854. Kubernetes meta/v1.Time
  1855. </a>
  1856. </em>
  1857. </td>
  1858. <td>
  1859. <p>refreshTime is the time and date the external secret was fetched and
  1860. the target secret updated</p>
  1861. </td>
  1862. </tr>
  1863. <tr>
  1864. <td>
  1865. <code>syncedResourceVersion</code></br>
  1866. <em>
  1867. string
  1868. </em>
  1869. </td>
  1870. <td>
  1871. <p>SyncedResourceVersion keeps track of the last synced version</p>
  1872. </td>
  1873. </tr>
  1874. <tr>
  1875. <td>
  1876. <code>conditions</code></br>
  1877. <em>
  1878. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">
  1879. []ExternalSecretStatusCondition
  1880. </a>
  1881. </em>
  1882. </td>
  1883. <td>
  1884. <em>(Optional)</em>
  1885. </td>
  1886. </tr>
  1887. </tbody>
  1888. </table>
  1889. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  1890. </h3>
  1891. <p>
  1892. (<em>Appears on:</em>
  1893. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus</a>)
  1894. </p>
  1895. <p>
  1896. </p>
  1897. <table>
  1898. <thead>
  1899. <tr>
  1900. <th>Field</th>
  1901. <th>Description</th>
  1902. </tr>
  1903. </thead>
  1904. <tbody>
  1905. <tr>
  1906. <td>
  1907. <code>type</code></br>
  1908. <em>
  1909. <a href="#external-secrets.io/v1alpha1.ExternalSecretConditionType">
  1910. ExternalSecretConditionType
  1911. </a>
  1912. </em>
  1913. </td>
  1914. <td>
  1915. </td>
  1916. </tr>
  1917. <tr>
  1918. <td>
  1919. <code>status</code></br>
  1920. <em>
  1921. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  1922. Kubernetes core/v1.ConditionStatus
  1923. </a>
  1924. </em>
  1925. </td>
  1926. <td>
  1927. </td>
  1928. </tr>
  1929. <tr>
  1930. <td>
  1931. <code>reason</code></br>
  1932. <em>
  1933. string
  1934. </em>
  1935. </td>
  1936. <td>
  1937. <em>(Optional)</em>
  1938. </td>
  1939. </tr>
  1940. <tr>
  1941. <td>
  1942. <code>message</code></br>
  1943. <em>
  1944. string
  1945. </em>
  1946. </td>
  1947. <td>
  1948. <em>(Optional)</em>
  1949. </td>
  1950. </tr>
  1951. <tr>
  1952. <td>
  1953. <code>lastTransitionTime</code></br>
  1954. <em>
  1955. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1956. Kubernetes meta/v1.Time
  1957. </a>
  1958. </em>
  1959. </td>
  1960. <td>
  1961. <em>(Optional)</em>
  1962. </td>
  1963. </tr>
  1964. </tbody>
  1965. </table>
  1966. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget
  1967. </h3>
  1968. <p>
  1969. (<em>Appears on:</em>
  1970. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1971. </p>
  1972. <p>
  1973. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  1974. There can be only one target per ExternalSecret.</p>
  1975. </p>
  1976. <table>
  1977. <thead>
  1978. <tr>
  1979. <th>Field</th>
  1980. <th>Description</th>
  1981. </tr>
  1982. </thead>
  1983. <tbody>
  1984. <tr>
  1985. <td>
  1986. <code>name</code></br>
  1987. <em>
  1988. string
  1989. </em>
  1990. </td>
  1991. <td>
  1992. <em>(Optional)</em>
  1993. <p>Name defines the name of the Secret resource to be managed
  1994. This field is immutable
  1995. Defaults to the .metadata.name of the ExternalSecret resource</p>
  1996. </td>
  1997. </tr>
  1998. <tr>
  1999. <td>
  2000. <code>creationPolicy</code></br>
  2001. <em>
  2002. <a href="#external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">
  2003. ExternalSecretCreationPolicy
  2004. </a>
  2005. </em>
  2006. </td>
  2007. <td>
  2008. <em>(Optional)</em>
  2009. <p>CreationPolicy defines rules on how to create the resulting Secret
  2010. Defaults to &lsquo;Owner&rsquo;</p>
  2011. </td>
  2012. </tr>
  2013. <tr>
  2014. <td>
  2015. <code>template</code></br>
  2016. <em>
  2017. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">
  2018. ExternalSecretTemplate
  2019. </a>
  2020. </em>
  2021. </td>
  2022. <td>
  2023. <em>(Optional)</em>
  2024. <p>Template defines a blueprint for the created Secret resource.</p>
  2025. </td>
  2026. </tr>
  2027. <tr>
  2028. <td>
  2029. <code>immutable</code></br>
  2030. <em>
  2031. bool
  2032. </em>
  2033. </td>
  2034. <td>
  2035. <em>(Optional)</em>
  2036. <p>Immutable defines if the final secret will be immutable</p>
  2037. </td>
  2038. </tr>
  2039. </tbody>
  2040. </table>
  2041. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate
  2042. </h3>
  2043. <p>
  2044. (<em>Appears on:</em>
  2045. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  2046. </p>
  2047. <p>
  2048. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  2049. 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>
  2050. </p>
  2051. <table>
  2052. <thead>
  2053. <tr>
  2054. <th>Field</th>
  2055. <th>Description</th>
  2056. </tr>
  2057. </thead>
  2058. <tbody>
  2059. <tr>
  2060. <td>
  2061. <code>type</code></br>
  2062. <em>
  2063. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secrettype-v1-core">
  2064. Kubernetes core/v1.SecretType
  2065. </a>
  2066. </em>
  2067. </td>
  2068. <td>
  2069. <em>(Optional)</em>
  2070. </td>
  2071. </tr>
  2072. <tr>
  2073. <td>
  2074. <code>engineVersion</code></br>
  2075. <em>
  2076. <a href="#external-secrets.io/v1alpha1.TemplateEngineVersion">
  2077. TemplateEngineVersion
  2078. </a>
  2079. </em>
  2080. </td>
  2081. <td>
  2082. <p>EngineVersion specifies the template engine version
  2083. that should be used to compile/execute the
  2084. template specified in .data and .templateFrom[].</p>
  2085. </td>
  2086. </tr>
  2087. <tr>
  2088. <td>
  2089. <code>metadata</code></br>
  2090. <em>
  2091. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">
  2092. ExternalSecretTemplateMetadata
  2093. </a>
  2094. </em>
  2095. </td>
  2096. <td>
  2097. <em>(Optional)</em>
  2098. </td>
  2099. </tr>
  2100. <tr>
  2101. <td>
  2102. <code>data</code></br>
  2103. <em>
  2104. map[string]string
  2105. </em>
  2106. </td>
  2107. <td>
  2108. <em>(Optional)</em>
  2109. </td>
  2110. </tr>
  2111. <tr>
  2112. <td>
  2113. <code>templateFrom</code></br>
  2114. <em>
  2115. <a href="#external-secrets.io/v1alpha1.TemplateFrom">
  2116. []TemplateFrom
  2117. </a>
  2118. </em>
  2119. </td>
  2120. <td>
  2121. <em>(Optional)</em>
  2122. </td>
  2123. </tr>
  2124. </tbody>
  2125. </table>
  2126. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  2127. </h3>
  2128. <p>
  2129. (<em>Appears on:</em>
  2130. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  2131. </p>
  2132. <p>
  2133. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  2134. </p>
  2135. <table>
  2136. <thead>
  2137. <tr>
  2138. <th>Field</th>
  2139. <th>Description</th>
  2140. </tr>
  2141. </thead>
  2142. <tbody>
  2143. <tr>
  2144. <td>
  2145. <code>annotations</code></br>
  2146. <em>
  2147. map[string]string
  2148. </em>
  2149. </td>
  2150. <td>
  2151. <em>(Optional)</em>
  2152. </td>
  2153. </tr>
  2154. <tr>
  2155. <td>
  2156. <code>labels</code></br>
  2157. <em>
  2158. map[string]string
  2159. </em>
  2160. </td>
  2161. <td>
  2162. <em>(Optional)</em>
  2163. </td>
  2164. </tr>
  2165. </tbody>
  2166. </table>
  2167. <h3 id="external-secrets.io/v1alpha1.FakeProvider">FakeProvider
  2168. </h3>
  2169. <p>
  2170. (<em>Appears on:</em>
  2171. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2172. </p>
  2173. <p>
  2174. <p>FakeProvider configures a fake provider that returns static values.</p>
  2175. </p>
  2176. <table>
  2177. <thead>
  2178. <tr>
  2179. <th>Field</th>
  2180. <th>Description</th>
  2181. </tr>
  2182. </thead>
  2183. <tbody>
  2184. <tr>
  2185. <td>
  2186. <code>data</code></br>
  2187. <em>
  2188. <a href="#external-secrets.io/v1alpha1.FakeProviderData">
  2189. []FakeProviderData
  2190. </a>
  2191. </em>
  2192. </td>
  2193. <td>
  2194. </td>
  2195. </tr>
  2196. </tbody>
  2197. </table>
  2198. <h3 id="external-secrets.io/v1alpha1.FakeProviderData">FakeProviderData
  2199. </h3>
  2200. <p>
  2201. (<em>Appears on:</em>
  2202. <a href="#external-secrets.io/v1alpha1.FakeProvider">FakeProvider</a>)
  2203. </p>
  2204. <p>
  2205. </p>
  2206. <table>
  2207. <thead>
  2208. <tr>
  2209. <th>Field</th>
  2210. <th>Description</th>
  2211. </tr>
  2212. </thead>
  2213. <tbody>
  2214. <tr>
  2215. <td>
  2216. <code>key</code></br>
  2217. <em>
  2218. string
  2219. </em>
  2220. </td>
  2221. <td>
  2222. </td>
  2223. </tr>
  2224. <tr>
  2225. <td>
  2226. <code>value</code></br>
  2227. <em>
  2228. string
  2229. </em>
  2230. </td>
  2231. <td>
  2232. </td>
  2233. </tr>
  2234. <tr>
  2235. <td>
  2236. <code>valueMap</code></br>
  2237. <em>
  2238. map[string]string
  2239. </em>
  2240. </td>
  2241. <td>
  2242. </td>
  2243. </tr>
  2244. <tr>
  2245. <td>
  2246. <code>version</code></br>
  2247. <em>
  2248. string
  2249. </em>
  2250. </td>
  2251. <td>
  2252. </td>
  2253. </tr>
  2254. </tbody>
  2255. </table>
  2256. <h3 id="external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth
  2257. </h3>
  2258. <p>
  2259. (<em>Appears on:</em>
  2260. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider</a>)
  2261. </p>
  2262. <p>
  2263. </p>
  2264. <table>
  2265. <thead>
  2266. <tr>
  2267. <th>Field</th>
  2268. <th>Description</th>
  2269. </tr>
  2270. </thead>
  2271. <tbody>
  2272. <tr>
  2273. <td>
  2274. <code>secretRef</code></br>
  2275. <em>
  2276. <a href="#external-secrets.io/v1alpha1.GCPSMAuthSecretRef">
  2277. GCPSMAuthSecretRef
  2278. </a>
  2279. </em>
  2280. </td>
  2281. <td>
  2282. <em>(Optional)</em>
  2283. </td>
  2284. </tr>
  2285. <tr>
  2286. <td>
  2287. <code>workloadIdentity</code></br>
  2288. <em>
  2289. <a href="#external-secrets.io/v1alpha1.GCPWorkloadIdentity">
  2290. GCPWorkloadIdentity
  2291. </a>
  2292. </em>
  2293. </td>
  2294. <td>
  2295. <em>(Optional)</em>
  2296. </td>
  2297. </tr>
  2298. </tbody>
  2299. </table>
  2300. <h3 id="external-secrets.io/v1alpha1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  2301. </h3>
  2302. <p>
  2303. (<em>Appears on:</em>
  2304. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth</a>)
  2305. </p>
  2306. <p>
  2307. </p>
  2308. <table>
  2309. <thead>
  2310. <tr>
  2311. <th>Field</th>
  2312. <th>Description</th>
  2313. </tr>
  2314. </thead>
  2315. <tbody>
  2316. <tr>
  2317. <td>
  2318. <code>secretAccessKeySecretRef</code></br>
  2319. <em>
  2320. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2321. </em>
  2322. </td>
  2323. <td>
  2324. <em>(Optional)</em>
  2325. <p>The SecretAccessKey is used for authentication</p>
  2326. </td>
  2327. </tr>
  2328. </tbody>
  2329. </table>
  2330. <h3 id="external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider
  2331. </h3>
  2332. <p>
  2333. (<em>Appears on:</em>
  2334. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2335. </p>
  2336. <p>
  2337. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  2338. </p>
  2339. <table>
  2340. <thead>
  2341. <tr>
  2342. <th>Field</th>
  2343. <th>Description</th>
  2344. </tr>
  2345. </thead>
  2346. <tbody>
  2347. <tr>
  2348. <td>
  2349. <code>auth</code></br>
  2350. <em>
  2351. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">
  2352. GCPSMAuth
  2353. </a>
  2354. </em>
  2355. </td>
  2356. <td>
  2357. <em>(Optional)</em>
  2358. <p>Auth defines the information necessary to authenticate against GCP</p>
  2359. </td>
  2360. </tr>
  2361. <tr>
  2362. <td>
  2363. <code>projectID</code></br>
  2364. <em>
  2365. string
  2366. </em>
  2367. </td>
  2368. <td>
  2369. <p>ProjectID project where secret is located</p>
  2370. </td>
  2371. </tr>
  2372. </tbody>
  2373. </table>
  2374. <h3 id="external-secrets.io/v1alpha1.GCPWorkloadIdentity">GCPWorkloadIdentity
  2375. </h3>
  2376. <p>
  2377. (<em>Appears on:</em>
  2378. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth</a>)
  2379. </p>
  2380. <p>
  2381. </p>
  2382. <table>
  2383. <thead>
  2384. <tr>
  2385. <th>Field</th>
  2386. <th>Description</th>
  2387. </tr>
  2388. </thead>
  2389. <tbody>
  2390. <tr>
  2391. <td>
  2392. <code>serviceAccountRef</code></br>
  2393. <em>
  2394. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  2395. </em>
  2396. </td>
  2397. <td>
  2398. </td>
  2399. </tr>
  2400. <tr>
  2401. <td>
  2402. <code>clusterLocation</code></br>
  2403. <em>
  2404. string
  2405. </em>
  2406. </td>
  2407. <td>
  2408. </td>
  2409. </tr>
  2410. <tr>
  2411. <td>
  2412. <code>clusterName</code></br>
  2413. <em>
  2414. string
  2415. </em>
  2416. </td>
  2417. <td>
  2418. </td>
  2419. </tr>
  2420. <tr>
  2421. <td>
  2422. <code>clusterProjectID</code></br>
  2423. <em>
  2424. string
  2425. </em>
  2426. </td>
  2427. <td>
  2428. </td>
  2429. </tr>
  2430. </tbody>
  2431. </table>
  2432. <h3 id="external-secrets.io/v1alpha1.GenericStore">GenericStore
  2433. </h3>
  2434. <p>
  2435. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  2436. or a namespaced SecretStore.</p>
  2437. </p>
  2438. <h3 id="external-secrets.io/v1alpha1.GitlabAuth">GitlabAuth
  2439. </h3>
  2440. <p>
  2441. (<em>Appears on:</em>
  2442. <a href="#external-secrets.io/v1alpha1.GitlabProvider">GitlabProvider</a>)
  2443. </p>
  2444. <p>
  2445. </p>
  2446. <table>
  2447. <thead>
  2448. <tr>
  2449. <th>Field</th>
  2450. <th>Description</th>
  2451. </tr>
  2452. </thead>
  2453. <tbody>
  2454. <tr>
  2455. <td>
  2456. <code>SecretRef</code></br>
  2457. <em>
  2458. <a href="#external-secrets.io/v1alpha1.GitlabSecretRef">
  2459. GitlabSecretRef
  2460. </a>
  2461. </em>
  2462. </td>
  2463. <td>
  2464. </td>
  2465. </tr>
  2466. </tbody>
  2467. </table>
  2468. <h3 id="external-secrets.io/v1alpha1.GitlabProvider">GitlabProvider
  2469. </h3>
  2470. <p>
  2471. (<em>Appears on:</em>
  2472. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2473. </p>
  2474. <p>
  2475. <p>Configures a store to sync secrets with a GitLab instance.</p>
  2476. </p>
  2477. <table>
  2478. <thead>
  2479. <tr>
  2480. <th>Field</th>
  2481. <th>Description</th>
  2482. </tr>
  2483. </thead>
  2484. <tbody>
  2485. <tr>
  2486. <td>
  2487. <code>url</code></br>
  2488. <em>
  2489. string
  2490. </em>
  2491. </td>
  2492. <td>
  2493. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
  2494. </td>
  2495. </tr>
  2496. <tr>
  2497. <td>
  2498. <code>auth</code></br>
  2499. <em>
  2500. <a href="#external-secrets.io/v1alpha1.GitlabAuth">
  2501. GitlabAuth
  2502. </a>
  2503. </em>
  2504. </td>
  2505. <td>
  2506. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
  2507. </td>
  2508. </tr>
  2509. <tr>
  2510. <td>
  2511. <code>projectID</code></br>
  2512. <em>
  2513. string
  2514. </em>
  2515. </td>
  2516. <td>
  2517. <p>ProjectID specifies a project where secrets are located.</p>
  2518. </td>
  2519. </tr>
  2520. </tbody>
  2521. </table>
  2522. <h3 id="external-secrets.io/v1alpha1.GitlabSecretRef">GitlabSecretRef
  2523. </h3>
  2524. <p>
  2525. (<em>Appears on:</em>
  2526. <a href="#external-secrets.io/v1alpha1.GitlabAuth">GitlabAuth</a>)
  2527. </p>
  2528. <p>
  2529. </p>
  2530. <table>
  2531. <thead>
  2532. <tr>
  2533. <th>Field</th>
  2534. <th>Description</th>
  2535. </tr>
  2536. </thead>
  2537. <tbody>
  2538. <tr>
  2539. <td>
  2540. <code>accessToken</code></br>
  2541. <em>
  2542. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2543. </em>
  2544. </td>
  2545. <td>
  2546. <p>AccessToken is used for authentication.</p>
  2547. </td>
  2548. </tr>
  2549. </tbody>
  2550. </table>
  2551. <h3 id="external-secrets.io/v1alpha1.IBMAuth">IBMAuth
  2552. </h3>
  2553. <p>
  2554. (<em>Appears on:</em>
  2555. <a href="#external-secrets.io/v1alpha1.IBMProvider">IBMProvider</a>)
  2556. </p>
  2557. <p>
  2558. </p>
  2559. <table>
  2560. <thead>
  2561. <tr>
  2562. <th>Field</th>
  2563. <th>Description</th>
  2564. </tr>
  2565. </thead>
  2566. <tbody>
  2567. <tr>
  2568. <td>
  2569. <code>secretRef</code></br>
  2570. <em>
  2571. <a href="#external-secrets.io/v1alpha1.IBMAuthSecretRef">
  2572. IBMAuthSecretRef
  2573. </a>
  2574. </em>
  2575. </td>
  2576. <td>
  2577. </td>
  2578. </tr>
  2579. </tbody>
  2580. </table>
  2581. <h3 id="external-secrets.io/v1alpha1.IBMAuthSecretRef">IBMAuthSecretRef
  2582. </h3>
  2583. <p>
  2584. (<em>Appears on:</em>
  2585. <a href="#external-secrets.io/v1alpha1.IBMAuth">IBMAuth</a>)
  2586. </p>
  2587. <p>
  2588. </p>
  2589. <table>
  2590. <thead>
  2591. <tr>
  2592. <th>Field</th>
  2593. <th>Description</th>
  2594. </tr>
  2595. </thead>
  2596. <tbody>
  2597. <tr>
  2598. <td>
  2599. <code>secretApiKeySecretRef</code></br>
  2600. <em>
  2601. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2602. </em>
  2603. </td>
  2604. <td>
  2605. <em>(Optional)</em>
  2606. <p>The SecretAccessKey is used for authentication</p>
  2607. </td>
  2608. </tr>
  2609. </tbody>
  2610. </table>
  2611. <h3 id="external-secrets.io/v1alpha1.IBMProvider">IBMProvider
  2612. </h3>
  2613. <p>
  2614. (<em>Appears on:</em>
  2615. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2616. </p>
  2617. <p>
  2618. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
  2619. backend.</p>
  2620. </p>
  2621. <table>
  2622. <thead>
  2623. <tr>
  2624. <th>Field</th>
  2625. <th>Description</th>
  2626. </tr>
  2627. </thead>
  2628. <tbody>
  2629. <tr>
  2630. <td>
  2631. <code>auth</code></br>
  2632. <em>
  2633. <a href="#external-secrets.io/v1alpha1.IBMAuth">
  2634. IBMAuth
  2635. </a>
  2636. </em>
  2637. </td>
  2638. <td>
  2639. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
  2640. </td>
  2641. </tr>
  2642. <tr>
  2643. <td>
  2644. <code>serviceUrl</code></br>
  2645. <em>
  2646. string
  2647. </em>
  2648. </td>
  2649. <td>
  2650. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
  2651. </td>
  2652. </tr>
  2653. </tbody>
  2654. </table>
  2655. <h3 id="external-secrets.io/v1alpha1.KubernetesAuth">KubernetesAuth
  2656. </h3>
  2657. <p>
  2658. (<em>Appears on:</em>
  2659. <a href="#external-secrets.io/v1alpha1.KubernetesProvider">KubernetesProvider</a>)
  2660. </p>
  2661. <p>
  2662. </p>
  2663. <table>
  2664. <thead>
  2665. <tr>
  2666. <th>Field</th>
  2667. <th>Description</th>
  2668. </tr>
  2669. </thead>
  2670. <tbody>
  2671. <tr>
  2672. <td>
  2673. <code>cert</code></br>
  2674. <em>
  2675. <a href="#external-secrets.io/v1alpha1.CertAuth">
  2676. CertAuth
  2677. </a>
  2678. </em>
  2679. </td>
  2680. <td>
  2681. <em>(Optional)</em>
  2682. <p>has both clientCert and clientKey as secretKeySelector</p>
  2683. </td>
  2684. </tr>
  2685. <tr>
  2686. <td>
  2687. <code>token</code></br>
  2688. <em>
  2689. <a href="#external-secrets.io/v1alpha1.TokenAuth">
  2690. TokenAuth
  2691. </a>
  2692. </em>
  2693. </td>
  2694. <td>
  2695. <em>(Optional)</em>
  2696. <p>use static token to authenticate with</p>
  2697. </td>
  2698. </tr>
  2699. <tr>
  2700. <td>
  2701. <code>serviceAccount</code></br>
  2702. <em>
  2703. <a href="#external-secrets.io/v1alpha1.ServiceAccountAuth">
  2704. ServiceAccountAuth
  2705. </a>
  2706. </em>
  2707. </td>
  2708. <td>
  2709. <em>(Optional)</em>
  2710. <p>points to a service account that should be used for authentication</p>
  2711. </td>
  2712. </tr>
  2713. </tbody>
  2714. </table>
  2715. <h3 id="external-secrets.io/v1alpha1.KubernetesProvider">KubernetesProvider
  2716. </h3>
  2717. <p>
  2718. (<em>Appears on:</em>
  2719. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2720. </p>
  2721. <p>
  2722. <p>Configures a store to sync secrets with a Kubernetes instance.</p>
  2723. </p>
  2724. <table>
  2725. <thead>
  2726. <tr>
  2727. <th>Field</th>
  2728. <th>Description</th>
  2729. </tr>
  2730. </thead>
  2731. <tbody>
  2732. <tr>
  2733. <td>
  2734. <code>server</code></br>
  2735. <em>
  2736. <a href="#external-secrets.io/v1alpha1.KubernetesServer">
  2737. KubernetesServer
  2738. </a>
  2739. </em>
  2740. </td>
  2741. <td>
  2742. <p>configures the Kubernetes server Address.</p>
  2743. </td>
  2744. </tr>
  2745. <tr>
  2746. <td>
  2747. <code>auth</code></br>
  2748. <em>
  2749. <a href="#external-secrets.io/v1alpha1.KubernetesAuth">
  2750. KubernetesAuth
  2751. </a>
  2752. </em>
  2753. </td>
  2754. <td>
  2755. <p>Auth configures how secret-manager authenticates with a Kubernetes instance.</p>
  2756. </td>
  2757. </tr>
  2758. <tr>
  2759. <td>
  2760. <code>remoteNamespace</code></br>
  2761. <em>
  2762. string
  2763. </em>
  2764. </td>
  2765. <td>
  2766. <em>(Optional)</em>
  2767. <p>Remote namespace to fetch the secrets from</p>
  2768. </td>
  2769. </tr>
  2770. </tbody>
  2771. </table>
  2772. <h3 id="external-secrets.io/v1alpha1.KubernetesServer">KubernetesServer
  2773. </h3>
  2774. <p>
  2775. (<em>Appears on:</em>
  2776. <a href="#external-secrets.io/v1alpha1.KubernetesProvider">KubernetesProvider</a>)
  2777. </p>
  2778. <p>
  2779. </p>
  2780. <table>
  2781. <thead>
  2782. <tr>
  2783. <th>Field</th>
  2784. <th>Description</th>
  2785. </tr>
  2786. </thead>
  2787. <tbody>
  2788. <tr>
  2789. <td>
  2790. <code>url</code></br>
  2791. <em>
  2792. string
  2793. </em>
  2794. </td>
  2795. <td>
  2796. <em>(Optional)</em>
  2797. <p>configures the Kubernetes server Address.</p>
  2798. </td>
  2799. </tr>
  2800. <tr>
  2801. <td>
  2802. <code>caBundle</code></br>
  2803. <em>
  2804. []byte
  2805. </em>
  2806. </td>
  2807. <td>
  2808. <em>(Optional)</em>
  2809. <p>CABundle is a base64-encoded CA certificate</p>
  2810. </td>
  2811. </tr>
  2812. <tr>
  2813. <td>
  2814. <code>caProvider</code></br>
  2815. <em>
  2816. <a href="#external-secrets.io/v1alpha1.CAProvider">
  2817. CAProvider
  2818. </a>
  2819. </em>
  2820. </td>
  2821. <td>
  2822. <em>(Optional)</em>
  2823. <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>
  2824. </td>
  2825. </tr>
  2826. </tbody>
  2827. </table>
  2828. <h3 id="external-secrets.io/v1alpha1.OracleAuth">OracleAuth
  2829. </h3>
  2830. <p>
  2831. (<em>Appears on:</em>
  2832. <a href="#external-secrets.io/v1alpha1.OracleProvider">OracleProvider</a>)
  2833. </p>
  2834. <p>
  2835. </p>
  2836. <table>
  2837. <thead>
  2838. <tr>
  2839. <th>Field</th>
  2840. <th>Description</th>
  2841. </tr>
  2842. </thead>
  2843. <tbody>
  2844. <tr>
  2845. <td>
  2846. <code>tenancy</code></br>
  2847. <em>
  2848. string
  2849. </em>
  2850. </td>
  2851. <td>
  2852. <p>Tenancy is the tenancy OCID where user is located.</p>
  2853. </td>
  2854. </tr>
  2855. <tr>
  2856. <td>
  2857. <code>user</code></br>
  2858. <em>
  2859. string
  2860. </em>
  2861. </td>
  2862. <td>
  2863. <p>User is an access OCID specific to the account.</p>
  2864. </td>
  2865. </tr>
  2866. <tr>
  2867. <td>
  2868. <code>secretRef</code></br>
  2869. <em>
  2870. <a href="#external-secrets.io/v1alpha1.OracleSecretRef">
  2871. OracleSecretRef
  2872. </a>
  2873. </em>
  2874. </td>
  2875. <td>
  2876. <p>SecretRef to pass through sensitive information.</p>
  2877. </td>
  2878. </tr>
  2879. </tbody>
  2880. </table>
  2881. <h3 id="external-secrets.io/v1alpha1.OracleProvider">OracleProvider
  2882. </h3>
  2883. <p>
  2884. (<em>Appears on:</em>
  2885. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2886. </p>
  2887. <p>
  2888. <p>Configures an store to sync secrets using a Oracle Vault
  2889. backend.</p>
  2890. </p>
  2891. <table>
  2892. <thead>
  2893. <tr>
  2894. <th>Field</th>
  2895. <th>Description</th>
  2896. </tr>
  2897. </thead>
  2898. <tbody>
  2899. <tr>
  2900. <td>
  2901. <code>region</code></br>
  2902. <em>
  2903. string
  2904. </em>
  2905. </td>
  2906. <td>
  2907. <p>Region is the region where vault is located.</p>
  2908. </td>
  2909. </tr>
  2910. <tr>
  2911. <td>
  2912. <code>vault</code></br>
  2913. <em>
  2914. string
  2915. </em>
  2916. </td>
  2917. <td>
  2918. <p>Vault is the vault&rsquo;s OCID of the specific vault where secret is located.</p>
  2919. </td>
  2920. </tr>
  2921. <tr>
  2922. <td>
  2923. <code>auth</code></br>
  2924. <em>
  2925. <a href="#external-secrets.io/v1alpha1.OracleAuth">
  2926. OracleAuth
  2927. </a>
  2928. </em>
  2929. </td>
  2930. <td>
  2931. <em>(Optional)</em>
  2932. <p>Auth configures how secret-manager authenticates with the Oracle Vault.
  2933. If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
  2934. </td>
  2935. </tr>
  2936. </tbody>
  2937. </table>
  2938. <h3 id="external-secrets.io/v1alpha1.OracleSecretRef">OracleSecretRef
  2939. </h3>
  2940. <p>
  2941. (<em>Appears on:</em>
  2942. <a href="#external-secrets.io/v1alpha1.OracleAuth">OracleAuth</a>)
  2943. </p>
  2944. <p>
  2945. </p>
  2946. <table>
  2947. <thead>
  2948. <tr>
  2949. <th>Field</th>
  2950. <th>Description</th>
  2951. </tr>
  2952. </thead>
  2953. <tbody>
  2954. <tr>
  2955. <td>
  2956. <code>privatekey</code></br>
  2957. <em>
  2958. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2959. </em>
  2960. </td>
  2961. <td>
  2962. <p>PrivateKey is the user&rsquo;s API Signing Key in PEM format, used for authentication.</p>
  2963. </td>
  2964. </tr>
  2965. <tr>
  2966. <td>
  2967. <code>fingerprint</code></br>
  2968. <em>
  2969. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2970. </em>
  2971. </td>
  2972. <td>
  2973. <p>Fingerprint is the fingerprint of the API private key.</p>
  2974. </td>
  2975. </tr>
  2976. </tbody>
  2977. </table>
  2978. <h3 id="external-secrets.io/v1alpha1.SecretStore">SecretStore
  2979. </h3>
  2980. <p>
  2981. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  2982. </p>
  2983. <table>
  2984. <thead>
  2985. <tr>
  2986. <th>Field</th>
  2987. <th>Description</th>
  2988. </tr>
  2989. </thead>
  2990. <tbody>
  2991. <tr>
  2992. <td>
  2993. <code>metadata</code></br>
  2994. <em>
  2995. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  2996. Kubernetes meta/v1.ObjectMeta
  2997. </a>
  2998. </em>
  2999. </td>
  3000. <td>
  3001. Refer to the Kubernetes API documentation for the fields of the
  3002. <code>metadata</code> field.
  3003. </td>
  3004. </tr>
  3005. <tr>
  3006. <td>
  3007. <code>spec</code></br>
  3008. <em>
  3009. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  3010. SecretStoreSpec
  3011. </a>
  3012. </em>
  3013. </td>
  3014. <td>
  3015. <br/>
  3016. <br/>
  3017. <table>
  3018. <tr>
  3019. <td>
  3020. <code>controller</code></br>
  3021. <em>
  3022. string
  3023. </em>
  3024. </td>
  3025. <td>
  3026. <em>(Optional)</em>
  3027. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  3028. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  3029. </td>
  3030. </tr>
  3031. <tr>
  3032. <td>
  3033. <code>provider</code></br>
  3034. <em>
  3035. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  3036. SecretStoreProvider
  3037. </a>
  3038. </em>
  3039. </td>
  3040. <td>
  3041. <p>Used to configure the provider. Only one provider may be set</p>
  3042. </td>
  3043. </tr>
  3044. <tr>
  3045. <td>
  3046. <code>retrySettings</code></br>
  3047. <em>
  3048. <a href="#external-secrets.io/v1alpha1.SecretStoreRetrySettings">
  3049. SecretStoreRetrySettings
  3050. </a>
  3051. </em>
  3052. </td>
  3053. <td>
  3054. <em>(Optional)</em>
  3055. <p>Used to configure http retries if failed</p>
  3056. </td>
  3057. </tr>
  3058. </table>
  3059. </td>
  3060. </tr>
  3061. <tr>
  3062. <td>
  3063. <code>status</code></br>
  3064. <em>
  3065. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  3066. SecretStoreStatus
  3067. </a>
  3068. </em>
  3069. </td>
  3070. <td>
  3071. </td>
  3072. </tr>
  3073. </tbody>
  3074. </table>
  3075. <h3 id="external-secrets.io/v1alpha1.SecretStoreConditionType">SecretStoreConditionType
  3076. (<code>string</code> alias)</p></h3>
  3077. <p>
  3078. (<em>Appears on:</em>
  3079. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  3080. </p>
  3081. <p>
  3082. </p>
  3083. <table>
  3084. <thead>
  3085. <tr>
  3086. <th>Value</th>
  3087. <th>Description</th>
  3088. </tr>
  3089. </thead>
  3090. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  3091. <td></td>
  3092. </tr></tbody>
  3093. </table>
  3094. <h3 id="external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider
  3095. </h3>
  3096. <p>
  3097. (<em>Appears on:</em>
  3098. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec</a>)
  3099. </p>
  3100. <p>
  3101. <p>SecretStoreProvider contains the provider-specific configration.</p>
  3102. </p>
  3103. <table>
  3104. <thead>
  3105. <tr>
  3106. <th>Field</th>
  3107. <th>Description</th>
  3108. </tr>
  3109. </thead>
  3110. <tbody>
  3111. <tr>
  3112. <td>
  3113. <code>aws</code></br>
  3114. <em>
  3115. <a href="#external-secrets.io/v1alpha1.AWSProvider">
  3116. AWSProvider
  3117. </a>
  3118. </em>
  3119. </td>
  3120. <td>
  3121. <em>(Optional)</em>
  3122. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  3123. </td>
  3124. </tr>
  3125. <tr>
  3126. <td>
  3127. <code>azurekv</code></br>
  3128. <em>
  3129. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">
  3130. AzureKVProvider
  3131. </a>
  3132. </em>
  3133. </td>
  3134. <td>
  3135. <em>(Optional)</em>
  3136. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  3137. </td>
  3138. </tr>
  3139. <tr>
  3140. <td>
  3141. <code>akeyless</code></br>
  3142. <em>
  3143. <a href="#external-secrets.io/v1alpha1.AkeylessProvider">
  3144. AkeylessProvider
  3145. </a>
  3146. </em>
  3147. </td>
  3148. <td>
  3149. <em>(Optional)</em>
  3150. <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
  3151. </td>
  3152. </tr>
  3153. <tr>
  3154. <td>
  3155. <code>vault</code></br>
  3156. <em>
  3157. <a href="#external-secrets.io/v1alpha1.VaultProvider">
  3158. VaultProvider
  3159. </a>
  3160. </em>
  3161. </td>
  3162. <td>
  3163. <em>(Optional)</em>
  3164. <p>Vault configures this store to sync secrets using Hashi provider</p>
  3165. </td>
  3166. </tr>
  3167. <tr>
  3168. <td>
  3169. <code>gcpsm</code></br>
  3170. <em>
  3171. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">
  3172. GCPSMProvider
  3173. </a>
  3174. </em>
  3175. </td>
  3176. <td>
  3177. <em>(Optional)</em>
  3178. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  3179. </td>
  3180. </tr>
  3181. <tr>
  3182. <td>
  3183. <code>oracle</code></br>
  3184. <em>
  3185. <a href="#external-secrets.io/v1alpha1.OracleProvider">
  3186. OracleProvider
  3187. </a>
  3188. </em>
  3189. </td>
  3190. <td>
  3191. <em>(Optional)</em>
  3192. <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
  3193. </td>
  3194. </tr>
  3195. <tr>
  3196. <td>
  3197. <code>ibm</code></br>
  3198. <em>
  3199. <a href="#external-secrets.io/v1alpha1.IBMProvider">
  3200. IBMProvider
  3201. </a>
  3202. </em>
  3203. </td>
  3204. <td>
  3205. <em>(Optional)</em>
  3206. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
  3207. </td>
  3208. </tr>
  3209. <tr>
  3210. <td>
  3211. <code>yandexlockbox</code></br>
  3212. <em>
  3213. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">
  3214. YandexLockboxProvider
  3215. </a>
  3216. </em>
  3217. </td>
  3218. <td>
  3219. <em>(Optional)</em>
  3220. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
  3221. </td>
  3222. </tr>
  3223. <tr>
  3224. <td>
  3225. <code>gitlab</code></br>
  3226. <em>
  3227. <a href="#external-secrets.io/v1alpha1.GitlabProvider">
  3228. GitlabProvider
  3229. </a>
  3230. </em>
  3231. </td>
  3232. <td>
  3233. <em>(Optional)</em>
  3234. <p>GItlab configures this store to sync secrets using Gitlab Variables provider</p>
  3235. </td>
  3236. </tr>
  3237. <tr>
  3238. <td>
  3239. <code>alibaba</code></br>
  3240. <em>
  3241. <a href="#external-secrets.io/v1alpha1.AlibabaProvider">
  3242. AlibabaProvider
  3243. </a>
  3244. </em>
  3245. </td>
  3246. <td>
  3247. <em>(Optional)</em>
  3248. <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
  3249. </td>
  3250. </tr>
  3251. <tr>
  3252. <td>
  3253. <code>webhook</code></br>
  3254. <em>
  3255. <a href="#external-secrets.io/v1alpha1.WebhookProvider">
  3256. WebhookProvider
  3257. </a>
  3258. </em>
  3259. </td>
  3260. <td>
  3261. <em>(Optional)</em>
  3262. <p>Webhook configures this store to sync secrets using a generic templated webhook</p>
  3263. </td>
  3264. </tr>
  3265. <tr>
  3266. <td>
  3267. <code>kubernetes</code></br>
  3268. <em>
  3269. <a href="#external-secrets.io/v1alpha1.KubernetesProvider">
  3270. KubernetesProvider
  3271. </a>
  3272. </em>
  3273. </td>
  3274. <td>
  3275. <em>(Optional)</em>
  3276. <p>Kubernetes configures this store to sync secrets using a Kubernetes cluster provider</p>
  3277. </td>
  3278. </tr>
  3279. <tr>
  3280. <td>
  3281. <code>fake</code></br>
  3282. <em>
  3283. <a href="#external-secrets.io/v1alpha1.FakeProvider">
  3284. FakeProvider
  3285. </a>
  3286. </em>
  3287. </td>
  3288. <td>
  3289. <em>(Optional)</em>
  3290. <p>Fake configures a store with static key/value pairs</p>
  3291. </td>
  3292. </tr>
  3293. </tbody>
  3294. </table>
  3295. <h3 id="external-secrets.io/v1alpha1.SecretStoreRef">SecretStoreRef
  3296. </h3>
  3297. <p>
  3298. (<em>Appears on:</em>
  3299. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  3300. </p>
  3301. <p>
  3302. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  3303. </p>
  3304. <table>
  3305. <thead>
  3306. <tr>
  3307. <th>Field</th>
  3308. <th>Description</th>
  3309. </tr>
  3310. </thead>
  3311. <tbody>
  3312. <tr>
  3313. <td>
  3314. <code>name</code></br>
  3315. <em>
  3316. string
  3317. </em>
  3318. </td>
  3319. <td>
  3320. <p>Name of the SecretStore resource</p>
  3321. </td>
  3322. </tr>
  3323. <tr>
  3324. <td>
  3325. <code>kind</code></br>
  3326. <em>
  3327. string
  3328. </em>
  3329. </td>
  3330. <td>
  3331. <em>(Optional)</em>
  3332. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  3333. Defaults to <code>SecretStore</code></p>
  3334. </td>
  3335. </tr>
  3336. </tbody>
  3337. </table>
  3338. <h3 id="external-secrets.io/v1alpha1.SecretStoreRetrySettings">SecretStoreRetrySettings
  3339. </h3>
  3340. <p>
  3341. (<em>Appears on:</em>
  3342. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec</a>)
  3343. </p>
  3344. <p>
  3345. </p>
  3346. <table>
  3347. <thead>
  3348. <tr>
  3349. <th>Field</th>
  3350. <th>Description</th>
  3351. </tr>
  3352. </thead>
  3353. <tbody>
  3354. <tr>
  3355. <td>
  3356. <code>maxRetries</code></br>
  3357. <em>
  3358. int32
  3359. </em>
  3360. </td>
  3361. <td>
  3362. </td>
  3363. </tr>
  3364. <tr>
  3365. <td>
  3366. <code>retryInterval</code></br>
  3367. <em>
  3368. string
  3369. </em>
  3370. </td>
  3371. <td>
  3372. </td>
  3373. </tr>
  3374. </tbody>
  3375. </table>
  3376. <h3 id="external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec
  3377. </h3>
  3378. <p>
  3379. (<em>Appears on:</em>
  3380. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  3381. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  3382. </p>
  3383. <p>
  3384. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  3385. </p>
  3386. <table>
  3387. <thead>
  3388. <tr>
  3389. <th>Field</th>
  3390. <th>Description</th>
  3391. </tr>
  3392. </thead>
  3393. <tbody>
  3394. <tr>
  3395. <td>
  3396. <code>controller</code></br>
  3397. <em>
  3398. string
  3399. </em>
  3400. </td>
  3401. <td>
  3402. <em>(Optional)</em>
  3403. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  3404. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  3405. </td>
  3406. </tr>
  3407. <tr>
  3408. <td>
  3409. <code>provider</code></br>
  3410. <em>
  3411. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  3412. SecretStoreProvider
  3413. </a>
  3414. </em>
  3415. </td>
  3416. <td>
  3417. <p>Used to configure the provider. Only one provider may be set</p>
  3418. </td>
  3419. </tr>
  3420. <tr>
  3421. <td>
  3422. <code>retrySettings</code></br>
  3423. <em>
  3424. <a href="#external-secrets.io/v1alpha1.SecretStoreRetrySettings">
  3425. SecretStoreRetrySettings
  3426. </a>
  3427. </em>
  3428. </td>
  3429. <td>
  3430. <em>(Optional)</em>
  3431. <p>Used to configure http retries if failed</p>
  3432. </td>
  3433. </tr>
  3434. </tbody>
  3435. </table>
  3436. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus
  3437. </h3>
  3438. <p>
  3439. (<em>Appears on:</em>
  3440. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  3441. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  3442. </p>
  3443. <p>
  3444. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  3445. </p>
  3446. <table>
  3447. <thead>
  3448. <tr>
  3449. <th>Field</th>
  3450. <th>Description</th>
  3451. </tr>
  3452. </thead>
  3453. <tbody>
  3454. <tr>
  3455. <td>
  3456. <code>conditions</code></br>
  3457. <em>
  3458. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">
  3459. []SecretStoreStatusCondition
  3460. </a>
  3461. </em>
  3462. </td>
  3463. <td>
  3464. <em>(Optional)</em>
  3465. </td>
  3466. </tr>
  3467. </tbody>
  3468. </table>
  3469. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition
  3470. </h3>
  3471. <p>
  3472. (<em>Appears on:</em>
  3473. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus</a>)
  3474. </p>
  3475. <p>
  3476. </p>
  3477. <table>
  3478. <thead>
  3479. <tr>
  3480. <th>Field</th>
  3481. <th>Description</th>
  3482. </tr>
  3483. </thead>
  3484. <tbody>
  3485. <tr>
  3486. <td>
  3487. <code>type</code></br>
  3488. <em>
  3489. <a href="#external-secrets.io/v1alpha1.SecretStoreConditionType">
  3490. SecretStoreConditionType
  3491. </a>
  3492. </em>
  3493. </td>
  3494. <td>
  3495. </td>
  3496. </tr>
  3497. <tr>
  3498. <td>
  3499. <code>status</code></br>
  3500. <em>
  3501. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  3502. Kubernetes core/v1.ConditionStatus
  3503. </a>
  3504. </em>
  3505. </td>
  3506. <td>
  3507. </td>
  3508. </tr>
  3509. <tr>
  3510. <td>
  3511. <code>reason</code></br>
  3512. <em>
  3513. string
  3514. </em>
  3515. </td>
  3516. <td>
  3517. <em>(Optional)</em>
  3518. </td>
  3519. </tr>
  3520. <tr>
  3521. <td>
  3522. <code>message</code></br>
  3523. <em>
  3524. string
  3525. </em>
  3526. </td>
  3527. <td>
  3528. <em>(Optional)</em>
  3529. </td>
  3530. </tr>
  3531. <tr>
  3532. <td>
  3533. <code>lastTransitionTime</code></br>
  3534. <em>
  3535. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  3536. Kubernetes meta/v1.Time
  3537. </a>
  3538. </em>
  3539. </td>
  3540. <td>
  3541. <em>(Optional)</em>
  3542. </td>
  3543. </tr>
  3544. </tbody>
  3545. </table>
  3546. <h3 id="external-secrets.io/v1alpha1.ServiceAccountAuth">ServiceAccountAuth
  3547. </h3>
  3548. <p>
  3549. (<em>Appears on:</em>
  3550. <a href="#external-secrets.io/v1alpha1.KubernetesAuth">KubernetesAuth</a>)
  3551. </p>
  3552. <p>
  3553. </p>
  3554. <table>
  3555. <thead>
  3556. <tr>
  3557. <th>Field</th>
  3558. <th>Description</th>
  3559. </tr>
  3560. </thead>
  3561. <tbody>
  3562. <tr>
  3563. <td>
  3564. <code>serviceAccount</code></br>
  3565. <em>
  3566. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  3567. </em>
  3568. </td>
  3569. <td>
  3570. </td>
  3571. </tr>
  3572. </tbody>
  3573. </table>
  3574. <h3 id="external-secrets.io/v1alpha1.TemplateEngineVersion">TemplateEngineVersion
  3575. (<code>string</code> alias)</p></h3>
  3576. <p>
  3577. (<em>Appears on:</em>
  3578. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  3579. </p>
  3580. <p>
  3581. </p>
  3582. <table>
  3583. <thead>
  3584. <tr>
  3585. <th>Value</th>
  3586. <th>Description</th>
  3587. </tr>
  3588. </thead>
  3589. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  3590. <td></td>
  3591. </tr><tr><td><p>&#34;v2&#34;</p></td>
  3592. <td></td>
  3593. </tr></tbody>
  3594. </table>
  3595. <h3 id="external-secrets.io/v1alpha1.TemplateFrom">TemplateFrom
  3596. </h3>
  3597. <p>
  3598. (<em>Appears on:</em>
  3599. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  3600. </p>
  3601. <p>
  3602. </p>
  3603. <table>
  3604. <thead>
  3605. <tr>
  3606. <th>Field</th>
  3607. <th>Description</th>
  3608. </tr>
  3609. </thead>
  3610. <tbody>
  3611. <tr>
  3612. <td>
  3613. <code>configMap</code></br>
  3614. <em>
  3615. <a href="#external-secrets.io/v1alpha1.TemplateRef">
  3616. TemplateRef
  3617. </a>
  3618. </em>
  3619. </td>
  3620. <td>
  3621. </td>
  3622. </tr>
  3623. <tr>
  3624. <td>
  3625. <code>secret</code></br>
  3626. <em>
  3627. <a href="#external-secrets.io/v1alpha1.TemplateRef">
  3628. TemplateRef
  3629. </a>
  3630. </em>
  3631. </td>
  3632. <td>
  3633. </td>
  3634. </tr>
  3635. </tbody>
  3636. </table>
  3637. <h3 id="external-secrets.io/v1alpha1.TemplateRef">TemplateRef
  3638. </h3>
  3639. <p>
  3640. (<em>Appears on:</em>
  3641. <a href="#external-secrets.io/v1alpha1.TemplateFrom">TemplateFrom</a>)
  3642. </p>
  3643. <p>
  3644. </p>
  3645. <table>
  3646. <thead>
  3647. <tr>
  3648. <th>Field</th>
  3649. <th>Description</th>
  3650. </tr>
  3651. </thead>
  3652. <tbody>
  3653. <tr>
  3654. <td>
  3655. <code>name</code></br>
  3656. <em>
  3657. string
  3658. </em>
  3659. </td>
  3660. <td>
  3661. </td>
  3662. </tr>
  3663. <tr>
  3664. <td>
  3665. <code>items</code></br>
  3666. <em>
  3667. <a href="#external-secrets.io/v1alpha1.TemplateRefItem">
  3668. []TemplateRefItem
  3669. </a>
  3670. </em>
  3671. </td>
  3672. <td>
  3673. </td>
  3674. </tr>
  3675. </tbody>
  3676. </table>
  3677. <h3 id="external-secrets.io/v1alpha1.TemplateRefItem">TemplateRefItem
  3678. </h3>
  3679. <p>
  3680. (<em>Appears on:</em>
  3681. <a href="#external-secrets.io/v1alpha1.TemplateRef">TemplateRef</a>)
  3682. </p>
  3683. <p>
  3684. </p>
  3685. <table>
  3686. <thead>
  3687. <tr>
  3688. <th>Field</th>
  3689. <th>Description</th>
  3690. </tr>
  3691. </thead>
  3692. <tbody>
  3693. <tr>
  3694. <td>
  3695. <code>key</code></br>
  3696. <em>
  3697. string
  3698. </em>
  3699. </td>
  3700. <td>
  3701. </td>
  3702. </tr>
  3703. </tbody>
  3704. </table>
  3705. <h3 id="external-secrets.io/v1alpha1.TokenAuth">TokenAuth
  3706. </h3>
  3707. <p>
  3708. (<em>Appears on:</em>
  3709. <a href="#external-secrets.io/v1alpha1.KubernetesAuth">KubernetesAuth</a>)
  3710. </p>
  3711. <p>
  3712. </p>
  3713. <table>
  3714. <thead>
  3715. <tr>
  3716. <th>Field</th>
  3717. <th>Description</th>
  3718. </tr>
  3719. </thead>
  3720. <tbody>
  3721. <tr>
  3722. <td>
  3723. <code>bearerToken</code></br>
  3724. <em>
  3725. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3726. </em>
  3727. </td>
  3728. <td>
  3729. </td>
  3730. </tr>
  3731. </tbody>
  3732. </table>
  3733. <h3 id="external-secrets.io/v1alpha1.VaultAppRole">VaultAppRole
  3734. </h3>
  3735. <p>
  3736. (<em>Appears on:</em>
  3737. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  3738. </p>
  3739. <p>
  3740. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  3741. with the role and secret stored in a Kubernetes Secret resource.</p>
  3742. </p>
  3743. <table>
  3744. <thead>
  3745. <tr>
  3746. <th>Field</th>
  3747. <th>Description</th>
  3748. </tr>
  3749. </thead>
  3750. <tbody>
  3751. <tr>
  3752. <td>
  3753. <code>path</code></br>
  3754. <em>
  3755. string
  3756. </em>
  3757. </td>
  3758. <td>
  3759. <p>Path where the App Role authentication backend is mounted
  3760. in Vault, e.g: &ldquo;approle&rdquo;</p>
  3761. </td>
  3762. </tr>
  3763. <tr>
  3764. <td>
  3765. <code>roleId</code></br>
  3766. <em>
  3767. string
  3768. </em>
  3769. </td>
  3770. <td>
  3771. <p>RoleID configured in the App Role authentication backend when setting
  3772. up the authentication backend in Vault.</p>
  3773. </td>
  3774. </tr>
  3775. <tr>
  3776. <td>
  3777. <code>secretRef</code></br>
  3778. <em>
  3779. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3780. </em>
  3781. </td>
  3782. <td>
  3783. <p>Reference to a key in a Secret that contains the App Role secret used
  3784. to authenticate with Vault.
  3785. The <code>key</code> field must be specified and denotes which entry within the Secret
  3786. resource is used as the app role secret.</p>
  3787. </td>
  3788. </tr>
  3789. </tbody>
  3790. </table>
  3791. <h3 id="external-secrets.io/v1alpha1.VaultAuth">VaultAuth
  3792. </h3>
  3793. <p>
  3794. (<em>Appears on:</em>
  3795. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  3796. </p>
  3797. <p>
  3798. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  3799. Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>jwt</code> or <code>cert</code>
  3800. can be specified.</p>
  3801. </p>
  3802. <table>
  3803. <thead>
  3804. <tr>
  3805. <th>Field</th>
  3806. <th>Description</th>
  3807. </tr>
  3808. </thead>
  3809. <tbody>
  3810. <tr>
  3811. <td>
  3812. <code>tokenSecretRef</code></br>
  3813. <em>
  3814. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3815. </em>
  3816. </td>
  3817. <td>
  3818. <em>(Optional)</em>
  3819. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  3820. </td>
  3821. </tr>
  3822. <tr>
  3823. <td>
  3824. <code>appRole</code></br>
  3825. <em>
  3826. <a href="#external-secrets.io/v1alpha1.VaultAppRole">
  3827. VaultAppRole
  3828. </a>
  3829. </em>
  3830. </td>
  3831. <td>
  3832. <em>(Optional)</em>
  3833. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  3834. with the role and secret stored in a Kubernetes Secret resource.</p>
  3835. </td>
  3836. </tr>
  3837. <tr>
  3838. <td>
  3839. <code>kubernetes</code></br>
  3840. <em>
  3841. <a href="#external-secrets.io/v1alpha1.VaultKubernetesAuth">
  3842. VaultKubernetesAuth
  3843. </a>
  3844. </em>
  3845. </td>
  3846. <td>
  3847. <em>(Optional)</em>
  3848. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  3849. token stored in the named Secret resource to the Vault server.</p>
  3850. </td>
  3851. </tr>
  3852. <tr>
  3853. <td>
  3854. <code>ldap</code></br>
  3855. <em>
  3856. <a href="#external-secrets.io/v1alpha1.VaultLdapAuth">
  3857. VaultLdapAuth
  3858. </a>
  3859. </em>
  3860. </td>
  3861. <td>
  3862. <em>(Optional)</em>
  3863. <p>Ldap authenticates with Vault by passing username/password pair using
  3864. the LDAP authentication method</p>
  3865. </td>
  3866. </tr>
  3867. <tr>
  3868. <td>
  3869. <code>jwt</code></br>
  3870. <em>
  3871. <a href="#external-secrets.io/v1alpha1.VaultJwtAuth">
  3872. VaultJwtAuth
  3873. </a>
  3874. </em>
  3875. </td>
  3876. <td>
  3877. <em>(Optional)</em>
  3878. <p>Jwt authenticates with Vault by passing role and JWT token using the
  3879. JWT/OIDC authentication method</p>
  3880. </td>
  3881. </tr>
  3882. <tr>
  3883. <td>
  3884. <code>cert</code></br>
  3885. <em>
  3886. <a href="#external-secrets.io/v1alpha1.VaultCertAuth">
  3887. VaultCertAuth
  3888. </a>
  3889. </em>
  3890. </td>
  3891. <td>
  3892. <em>(Optional)</em>
  3893. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  3894. Cert authentication method</p>
  3895. </td>
  3896. </tr>
  3897. </tbody>
  3898. </table>
  3899. <h3 id="external-secrets.io/v1alpha1.VaultCertAuth">VaultCertAuth
  3900. </h3>
  3901. <p>
  3902. (<em>Appears on:</em>
  3903. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  3904. </p>
  3905. <p>
  3906. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  3907. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  3908. </p>
  3909. <table>
  3910. <thead>
  3911. <tr>
  3912. <th>Field</th>
  3913. <th>Description</th>
  3914. </tr>
  3915. </thead>
  3916. <tbody>
  3917. <tr>
  3918. <td>
  3919. <code>clientCert</code></br>
  3920. <em>
  3921. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3922. </em>
  3923. </td>
  3924. <td>
  3925. <em>(Optional)</em>
  3926. <p>ClientCert is a certificate to authenticate using the Cert Vault
  3927. authentication method</p>
  3928. </td>
  3929. </tr>
  3930. <tr>
  3931. <td>
  3932. <code>secretRef</code></br>
  3933. <em>
  3934. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3935. </em>
  3936. </td>
  3937. <td>
  3938. <p>SecretRef to a key in a Secret resource containing client private key to
  3939. authenticate with Vault using the Cert authentication method</p>
  3940. </td>
  3941. </tr>
  3942. </tbody>
  3943. </table>
  3944. <h3 id="external-secrets.io/v1alpha1.VaultJwtAuth">VaultJwtAuth
  3945. </h3>
  3946. <p>
  3947. (<em>Appears on:</em>
  3948. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  3949. </p>
  3950. <p>
  3951. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  3952. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  3953. </p>
  3954. <table>
  3955. <thead>
  3956. <tr>
  3957. <th>Field</th>
  3958. <th>Description</th>
  3959. </tr>
  3960. </thead>
  3961. <tbody>
  3962. <tr>
  3963. <td>
  3964. <code>path</code></br>
  3965. <em>
  3966. string
  3967. </em>
  3968. </td>
  3969. <td>
  3970. <p>Path where the JWT authentication backend is mounted
  3971. in Vault, e.g: &ldquo;jwt&rdquo;</p>
  3972. </td>
  3973. </tr>
  3974. <tr>
  3975. <td>
  3976. <code>role</code></br>
  3977. <em>
  3978. string
  3979. </em>
  3980. </td>
  3981. <td>
  3982. <em>(Optional)</em>
  3983. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  3984. authentication method</p>
  3985. </td>
  3986. </tr>
  3987. <tr>
  3988. <td>
  3989. <code>secretRef</code></br>
  3990. <em>
  3991. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3992. </em>
  3993. </td>
  3994. <td>
  3995. <p>SecretRef to a key in a Secret resource containing JWT token to
  3996. authenticate with Vault using the JWT/OIDC authentication method</p>
  3997. </td>
  3998. </tr>
  3999. </tbody>
  4000. </table>
  4001. <h3 id="external-secrets.io/v1alpha1.VaultKVStoreVersion">VaultKVStoreVersion
  4002. (<code>string</code> alias)</p></h3>
  4003. <p>
  4004. (<em>Appears on:</em>
  4005. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  4006. </p>
  4007. <p>
  4008. </p>
  4009. <table>
  4010. <thead>
  4011. <tr>
  4012. <th>Value</th>
  4013. <th>Description</th>
  4014. </tr>
  4015. </thead>
  4016. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  4017. <td></td>
  4018. </tr><tr><td><p>&#34;v2&#34;</p></td>
  4019. <td></td>
  4020. </tr></tbody>
  4021. </table>
  4022. <h3 id="external-secrets.io/v1alpha1.VaultKubernetesAuth">VaultKubernetesAuth
  4023. </h3>
  4024. <p>
  4025. (<em>Appears on:</em>
  4026. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  4027. </p>
  4028. <p>
  4029. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  4030. a Secret.</p>
  4031. </p>
  4032. <table>
  4033. <thead>
  4034. <tr>
  4035. <th>Field</th>
  4036. <th>Description</th>
  4037. </tr>
  4038. </thead>
  4039. <tbody>
  4040. <tr>
  4041. <td>
  4042. <code>mountPath</code></br>
  4043. <em>
  4044. string
  4045. </em>
  4046. </td>
  4047. <td>
  4048. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  4049. &ldquo;kubernetes&rdquo;</p>
  4050. </td>
  4051. </tr>
  4052. <tr>
  4053. <td>
  4054. <code>serviceAccountRef</code></br>
  4055. <em>
  4056. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  4057. </em>
  4058. </td>
  4059. <td>
  4060. <em>(Optional)</em>
  4061. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  4062. If the service account is specified, the service account secret token JWT will be used
  4063. for authenticating with Vault. If the service account selector is not supplied,
  4064. the secretRef will be used instead.</p>
  4065. </td>
  4066. </tr>
  4067. <tr>
  4068. <td>
  4069. <code>secretRef</code></br>
  4070. <em>
  4071. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4072. </em>
  4073. </td>
  4074. <td>
  4075. <em>(Optional)</em>
  4076. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  4077. for authenticating with Vault. If a name is specified without a key,
  4078. <code>token</code> is the default. If one is not specified, the one bound to
  4079. the controller will be used.</p>
  4080. </td>
  4081. </tr>
  4082. <tr>
  4083. <td>
  4084. <code>role</code></br>
  4085. <em>
  4086. string
  4087. </em>
  4088. </td>
  4089. <td>
  4090. <p>A required field containing the Vault Role to assume. A Role binds a
  4091. Kubernetes ServiceAccount with a set of Vault policies.</p>
  4092. </td>
  4093. </tr>
  4094. </tbody>
  4095. </table>
  4096. <h3 id="external-secrets.io/v1alpha1.VaultLdapAuth">VaultLdapAuth
  4097. </h3>
  4098. <p>
  4099. (<em>Appears on:</em>
  4100. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  4101. </p>
  4102. <p>
  4103. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  4104. with the username and password stored in a Kubernetes Secret resource.</p>
  4105. </p>
  4106. <table>
  4107. <thead>
  4108. <tr>
  4109. <th>Field</th>
  4110. <th>Description</th>
  4111. </tr>
  4112. </thead>
  4113. <tbody>
  4114. <tr>
  4115. <td>
  4116. <code>path</code></br>
  4117. <em>
  4118. string
  4119. </em>
  4120. </td>
  4121. <td>
  4122. <p>Path where the LDAP authentication backend is mounted
  4123. in Vault, e.g: &ldquo;ldap&rdquo;</p>
  4124. </td>
  4125. </tr>
  4126. <tr>
  4127. <td>
  4128. <code>username</code></br>
  4129. <em>
  4130. string
  4131. </em>
  4132. </td>
  4133. <td>
  4134. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  4135. authentication method</p>
  4136. </td>
  4137. </tr>
  4138. <tr>
  4139. <td>
  4140. <code>secretRef</code></br>
  4141. <em>
  4142. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4143. </em>
  4144. </td>
  4145. <td>
  4146. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  4147. user used to authenticate with Vault using the LDAP authentication
  4148. method</p>
  4149. </td>
  4150. </tr>
  4151. </tbody>
  4152. </table>
  4153. <h3 id="external-secrets.io/v1alpha1.VaultProvider">VaultProvider
  4154. </h3>
  4155. <p>
  4156. (<em>Appears on:</em>
  4157. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  4158. </p>
  4159. <p>
  4160. <p>Configures an store to sync secrets using a HashiCorp Vault
  4161. KV backend.</p>
  4162. </p>
  4163. <table>
  4164. <thead>
  4165. <tr>
  4166. <th>Field</th>
  4167. <th>Description</th>
  4168. </tr>
  4169. </thead>
  4170. <tbody>
  4171. <tr>
  4172. <td>
  4173. <code>auth</code></br>
  4174. <em>
  4175. <a href="#external-secrets.io/v1alpha1.VaultAuth">
  4176. VaultAuth
  4177. </a>
  4178. </em>
  4179. </td>
  4180. <td>
  4181. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  4182. </td>
  4183. </tr>
  4184. <tr>
  4185. <td>
  4186. <code>server</code></br>
  4187. <em>
  4188. string
  4189. </em>
  4190. </td>
  4191. <td>
  4192. <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>
  4193. </td>
  4194. </tr>
  4195. <tr>
  4196. <td>
  4197. <code>path</code></br>
  4198. <em>
  4199. string
  4200. </em>
  4201. </td>
  4202. <td>
  4203. <em>(Optional)</em>
  4204. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  4205. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  4206. for fetching secrets from Vault is optional and will be appended
  4207. if not present in specified path.</p>
  4208. </td>
  4209. </tr>
  4210. <tr>
  4211. <td>
  4212. <code>version</code></br>
  4213. <em>
  4214. <a href="#external-secrets.io/v1alpha1.VaultKVStoreVersion">
  4215. VaultKVStoreVersion
  4216. </a>
  4217. </em>
  4218. </td>
  4219. <td>
  4220. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  4221. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  4222. </td>
  4223. </tr>
  4224. <tr>
  4225. <td>
  4226. <code>namespace</code></br>
  4227. <em>
  4228. string
  4229. </em>
  4230. </td>
  4231. <td>
  4232. <em>(Optional)</em>
  4233. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  4234. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  4235. 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>
  4236. </td>
  4237. </tr>
  4238. <tr>
  4239. <td>
  4240. <code>caBundle</code></br>
  4241. <em>
  4242. []byte
  4243. </em>
  4244. </td>
  4245. <td>
  4246. <em>(Optional)</em>
  4247. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  4248. if the Server URL is using HTTPS protocol. This parameter is ignored for
  4249. plain HTTP protocol connection. If not set the system root certificates
  4250. are used to validate the TLS connection.</p>
  4251. </td>
  4252. </tr>
  4253. <tr>
  4254. <td>
  4255. <code>caProvider</code></br>
  4256. <em>
  4257. <a href="#external-secrets.io/v1alpha1.CAProvider">
  4258. CAProvider
  4259. </a>
  4260. </em>
  4261. </td>
  4262. <td>
  4263. <em>(Optional)</em>
  4264. <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
  4265. </td>
  4266. </tr>
  4267. <tr>
  4268. <td>
  4269. <code>readYourWrites</code></br>
  4270. <em>
  4271. bool
  4272. </em>
  4273. </td>
  4274. <td>
  4275. <em>(Optional)</em>
  4276. <p>ReadYourWrites ensures isolated read-after-write semantics by
  4277. providing discovered cluster replication states in each request.
  4278. More information about eventual consistency in Vault can be found here
  4279. <a href="https://www.vaultproject.io/docs/enterprise/consistency">https://www.vaultproject.io/docs/enterprise/consistency</a></p>
  4280. </td>
  4281. </tr>
  4282. <tr>
  4283. <td>
  4284. <code>forwardInconsistent</code></br>
  4285. <em>
  4286. bool
  4287. </em>
  4288. </td>
  4289. <td>
  4290. <em>(Optional)</em>
  4291. <p>ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
  4292. leader instead of simply retrying within a loop. This can increase performance if
  4293. the option is enabled serverside.
  4294. <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>
  4295. </td>
  4296. </tr>
  4297. </tbody>
  4298. </table>
  4299. <h3 id="external-secrets.io/v1alpha1.WebhookCAProvider">WebhookCAProvider
  4300. </h3>
  4301. <p>
  4302. (<em>Appears on:</em>
  4303. <a href="#external-secrets.io/v1alpha1.WebhookProvider">WebhookProvider</a>)
  4304. </p>
  4305. <p>
  4306. <p>Defines a location to fetch the cert for the webhook provider from.</p>
  4307. </p>
  4308. <table>
  4309. <thead>
  4310. <tr>
  4311. <th>Field</th>
  4312. <th>Description</th>
  4313. </tr>
  4314. </thead>
  4315. <tbody>
  4316. <tr>
  4317. <td>
  4318. <code>type</code></br>
  4319. <em>
  4320. <a href="#external-secrets.io/v1alpha1.WebhookCAProviderType">
  4321. WebhookCAProviderType
  4322. </a>
  4323. </em>
  4324. </td>
  4325. <td>
  4326. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  4327. </td>
  4328. </tr>
  4329. <tr>
  4330. <td>
  4331. <code>name</code></br>
  4332. <em>
  4333. string
  4334. </em>
  4335. </td>
  4336. <td>
  4337. <p>The name of the object located at the provider type.</p>
  4338. </td>
  4339. </tr>
  4340. <tr>
  4341. <td>
  4342. <code>key</code></br>
  4343. <em>
  4344. string
  4345. </em>
  4346. </td>
  4347. <td>
  4348. <p>The key the value inside of the provider type to use, only used with &ldquo;Secret&rdquo; type</p>
  4349. </td>
  4350. </tr>
  4351. <tr>
  4352. <td>
  4353. <code>namespace</code></br>
  4354. <em>
  4355. string
  4356. </em>
  4357. </td>
  4358. <td>
  4359. <em>(Optional)</em>
  4360. <p>The namespace the Provider type is in.</p>
  4361. </td>
  4362. </tr>
  4363. </tbody>
  4364. </table>
  4365. <h3 id="external-secrets.io/v1alpha1.WebhookCAProviderType">WebhookCAProviderType
  4366. (<code>string</code> alias)</p></h3>
  4367. <p>
  4368. (<em>Appears on:</em>
  4369. <a href="#external-secrets.io/v1alpha1.WebhookCAProvider">WebhookCAProvider</a>)
  4370. </p>
  4371. <p>
  4372. </p>
  4373. <table>
  4374. <thead>
  4375. <tr>
  4376. <th>Value</th>
  4377. <th>Description</th>
  4378. </tr>
  4379. </thead>
  4380. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  4381. <td></td>
  4382. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  4383. <td></td>
  4384. </tr></tbody>
  4385. </table>
  4386. <h3 id="external-secrets.io/v1alpha1.WebhookProvider">WebhookProvider
  4387. </h3>
  4388. <p>
  4389. (<em>Appears on:</em>
  4390. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  4391. </p>
  4392. <p>
  4393. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  4394. </p>
  4395. <table>
  4396. <thead>
  4397. <tr>
  4398. <th>Field</th>
  4399. <th>Description</th>
  4400. </tr>
  4401. </thead>
  4402. <tbody>
  4403. <tr>
  4404. <td>
  4405. <code>method</code></br>
  4406. <em>
  4407. string
  4408. </em>
  4409. </td>
  4410. <td>
  4411. <p>Webhook Method</p>
  4412. </td>
  4413. </tr>
  4414. <tr>
  4415. <td>
  4416. <code>url</code></br>
  4417. <em>
  4418. string
  4419. </em>
  4420. </td>
  4421. <td>
  4422. <p>Webhook url to call</p>
  4423. </td>
  4424. </tr>
  4425. <tr>
  4426. <td>
  4427. <code>headers</code></br>
  4428. <em>
  4429. map[string]string
  4430. </em>
  4431. </td>
  4432. <td>
  4433. <em>(Optional)</em>
  4434. <p>Headers</p>
  4435. </td>
  4436. </tr>
  4437. <tr>
  4438. <td>
  4439. <code>body</code></br>
  4440. <em>
  4441. string
  4442. </em>
  4443. </td>
  4444. <td>
  4445. <em>(Optional)</em>
  4446. <p>Body</p>
  4447. </td>
  4448. </tr>
  4449. <tr>
  4450. <td>
  4451. <code>timeout</code></br>
  4452. <em>
  4453. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  4454. Kubernetes meta/v1.Duration
  4455. </a>
  4456. </em>
  4457. </td>
  4458. <td>
  4459. <em>(Optional)</em>
  4460. <p>Timeout</p>
  4461. </td>
  4462. </tr>
  4463. <tr>
  4464. <td>
  4465. <code>result</code></br>
  4466. <em>
  4467. <a href="#external-secrets.io/v1alpha1.WebhookResult">
  4468. WebhookResult
  4469. </a>
  4470. </em>
  4471. </td>
  4472. <td>
  4473. <p>Result formatting</p>
  4474. </td>
  4475. </tr>
  4476. <tr>
  4477. <td>
  4478. <code>secrets</code></br>
  4479. <em>
  4480. <a href="#external-secrets.io/v1alpha1.WebhookSecret">
  4481. []WebhookSecret
  4482. </a>
  4483. </em>
  4484. </td>
  4485. <td>
  4486. <em>(Optional)</em>
  4487. <p>Secrets to fill in templates
  4488. These secrets will be passed to the templating function as key value pairs under the given name</p>
  4489. </td>
  4490. </tr>
  4491. <tr>
  4492. <td>
  4493. <code>caBundle</code></br>
  4494. <em>
  4495. []byte
  4496. </em>
  4497. </td>
  4498. <td>
  4499. <em>(Optional)</em>
  4500. <p>PEM encoded CA bundle used to validate webhook server certificate. Only used
  4501. if the Server URL is using HTTPS protocol. This parameter is ignored for
  4502. plain HTTP protocol connection. If not set the system root certificates
  4503. are used to validate the TLS connection.</p>
  4504. </td>
  4505. </tr>
  4506. <tr>
  4507. <td>
  4508. <code>caProvider</code></br>
  4509. <em>
  4510. <a href="#external-secrets.io/v1alpha1.WebhookCAProvider">
  4511. WebhookCAProvider
  4512. </a>
  4513. </em>
  4514. </td>
  4515. <td>
  4516. <em>(Optional)</em>
  4517. <p>The provider for the CA bundle to use to validate webhook server certificate.</p>
  4518. </td>
  4519. </tr>
  4520. </tbody>
  4521. </table>
  4522. <h3 id="external-secrets.io/v1alpha1.WebhookResult">WebhookResult
  4523. </h3>
  4524. <p>
  4525. (<em>Appears on:</em>
  4526. <a href="#external-secrets.io/v1alpha1.WebhookProvider">WebhookProvider</a>)
  4527. </p>
  4528. <p>
  4529. </p>
  4530. <table>
  4531. <thead>
  4532. <tr>
  4533. <th>Field</th>
  4534. <th>Description</th>
  4535. </tr>
  4536. </thead>
  4537. <tbody>
  4538. <tr>
  4539. <td>
  4540. <code>jsonPath</code></br>
  4541. <em>
  4542. string
  4543. </em>
  4544. </td>
  4545. <td>
  4546. <em>(Optional)</em>
  4547. <p>Json path of return value</p>
  4548. </td>
  4549. </tr>
  4550. </tbody>
  4551. </table>
  4552. <h3 id="external-secrets.io/v1alpha1.WebhookSecret">WebhookSecret
  4553. </h3>
  4554. <p>
  4555. (<em>Appears on:</em>
  4556. <a href="#external-secrets.io/v1alpha1.WebhookProvider">WebhookProvider</a>)
  4557. </p>
  4558. <p>
  4559. </p>
  4560. <table>
  4561. <thead>
  4562. <tr>
  4563. <th>Field</th>
  4564. <th>Description</th>
  4565. </tr>
  4566. </thead>
  4567. <tbody>
  4568. <tr>
  4569. <td>
  4570. <code>name</code></br>
  4571. <em>
  4572. string
  4573. </em>
  4574. </td>
  4575. <td>
  4576. <p>Name of this secret in templates</p>
  4577. </td>
  4578. </tr>
  4579. <tr>
  4580. <td>
  4581. <code>secretRef</code></br>
  4582. <em>
  4583. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4584. </em>
  4585. </td>
  4586. <td>
  4587. <p>Secret ref to fill in credentials</p>
  4588. </td>
  4589. </tr>
  4590. </tbody>
  4591. </table>
  4592. <h3 id="external-secrets.io/v1alpha1.YandexLockboxAuth">YandexLockboxAuth
  4593. </h3>
  4594. <p>
  4595. (<em>Appears on:</em>
  4596. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider</a>)
  4597. </p>
  4598. <p>
  4599. </p>
  4600. <table>
  4601. <thead>
  4602. <tr>
  4603. <th>Field</th>
  4604. <th>Description</th>
  4605. </tr>
  4606. </thead>
  4607. <tbody>
  4608. <tr>
  4609. <td>
  4610. <code>authorizedKeySecretRef</code></br>
  4611. <em>
  4612. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4613. </em>
  4614. </td>
  4615. <td>
  4616. <em>(Optional)</em>
  4617. <p>The authorized key used for authentication</p>
  4618. </td>
  4619. </tr>
  4620. </tbody>
  4621. </table>
  4622. <h3 id="external-secrets.io/v1alpha1.YandexLockboxCAProvider">YandexLockboxCAProvider
  4623. </h3>
  4624. <p>
  4625. (<em>Appears on:</em>
  4626. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider</a>)
  4627. </p>
  4628. <p>
  4629. </p>
  4630. <table>
  4631. <thead>
  4632. <tr>
  4633. <th>Field</th>
  4634. <th>Description</th>
  4635. </tr>
  4636. </thead>
  4637. <tbody>
  4638. <tr>
  4639. <td>
  4640. <code>certSecretRef</code></br>
  4641. <em>
  4642. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  4643. </em>
  4644. </td>
  4645. <td>
  4646. </td>
  4647. </tr>
  4648. </tbody>
  4649. </table>
  4650. <h3 id="external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider
  4651. </h3>
  4652. <p>
  4653. (<em>Appears on:</em>
  4654. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  4655. </p>
  4656. <p>
  4657. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
  4658. </p>
  4659. <table>
  4660. <thead>
  4661. <tr>
  4662. <th>Field</th>
  4663. <th>Description</th>
  4664. </tr>
  4665. </thead>
  4666. <tbody>
  4667. <tr>
  4668. <td>
  4669. <code>apiEndpoint</code></br>
  4670. <em>
  4671. string
  4672. </em>
  4673. </td>
  4674. <td>
  4675. <em>(Optional)</em>
  4676. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  4677. </td>
  4678. </tr>
  4679. <tr>
  4680. <td>
  4681. <code>auth</code></br>
  4682. <em>
  4683. <a href="#external-secrets.io/v1alpha1.YandexLockboxAuth">
  4684. YandexLockboxAuth
  4685. </a>
  4686. </em>
  4687. </td>
  4688. <td>
  4689. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
  4690. </td>
  4691. </tr>
  4692. <tr>
  4693. <td>
  4694. <code>caProvider</code></br>
  4695. <em>
  4696. <a href="#external-secrets.io/v1alpha1.YandexLockboxCAProvider">
  4697. YandexLockboxCAProvider
  4698. </a>
  4699. </em>
  4700. </td>
  4701. <td>
  4702. <em>(Optional)</em>
  4703. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  4704. </td>
  4705. </tr>
  4706. </tbody>
  4707. </table>
  4708. <hr/>
  4709. <p><em>
  4710. Generated with <code>gen-crd-api-reference-docs</code>.
  4711. </em></p>
  4712. </article>
  4713. </div>
  4714. </div>
  4715. </main>
  4716. <footer class="md-footer">
  4717. <nav class="md-footer__inner md-grid" aria-label="Footer">
  4718. <a href="../eso-blogs/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Blogs" rel="prev">
  4719. <div class="md-footer__button md-icon">
  4720. <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>
  4721. </div>
  4722. <div class="md-footer__title">
  4723. <div class="md-ellipsis">
  4724. <span class="md-footer__direction">
  4725. Previous
  4726. </span>
  4727. Blogs
  4728. </div>
  4729. </div>
  4730. </a>
  4731. <a href="../contributing-devguide/" class="md-footer__link md-footer__link--next" aria-label="Next: Developer guide" rel="next">
  4732. <div class="md-footer__title">
  4733. <div class="md-ellipsis">
  4734. <span class="md-footer__direction">
  4735. Next
  4736. </span>
  4737. Developer guide
  4738. </div>
  4739. </div>
  4740. <div class="md-footer__button md-icon">
  4741. <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>
  4742. </div>
  4743. </a>
  4744. </nav>
  4745. <div class="md-footer-meta md-typeset">
  4746. <div class="md-footer-meta__inner md-grid">
  4747. <div class="md-copyright">
  4748. Made with
  4749. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  4750. Material for MkDocs
  4751. </a>
  4752. </div>
  4753. </div>
  4754. </div>
  4755. </footer>
  4756. </div>
  4757. <div class="md-dialog" data-md-component="dialog">
  4758. <div class="md-dialog__inner md-typeset"></div>
  4759. </div>
  4760. <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>
  4761. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  4762. </body>
  4763. </html>