index.html 106 KB

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