index.html 96 KB

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