index.html 82 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210
  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.1, mkdocs-material-7.1.8">
  8. <title>API specification - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.ca7ac06f.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.f1a3b89f.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-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
  14. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){"undefined"!=typeof location$&&location$.subscribe(function(t){gtag("config","G-QP38TD8K7V",{page_path:t.pathname})})})</script>
  15. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  16. </head>
  17. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  18. <script>function __prefix(e){return new URL("..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  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. <header class="md-header" data-md-component="header">
  27. <nav class="md-header__inner md-grid" aria-label="Header">
  28. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  29. <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>
  30. </a>
  31. <label class="md-header__button md-icon" for="__drawer">
  32. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  33. </label>
  34. <div class="md-header__title" data-md-component="header-title">
  35. <div class="md-header__ellipsis">
  36. <div class="md-header__topic">
  37. <span class="md-ellipsis">
  38. External Secrets Operator
  39. </span>
  40. </div>
  41. <div class="md-header__topic" data-md-component="header-topic">
  42. <span class="md-ellipsis">
  43. API specification
  44. </span>
  45. </div>
  46. </div>
  47. </div>
  48. <label class="md-header__button md-icon" for="__search">
  49. <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>
  50. </label>
  51. <div class="md-search" data-md-component="search" role="dialog">
  52. <label class="md-search__overlay" for="__search"></label>
  53. <div class="md-search__inner" role="search">
  54. <form class="md-search__form" name="search">
  55. <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" data-md-state="active" required>
  56. <label class="md-search__icon md-icon" for="__search">
  57. <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>
  58. <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>
  59. </label>
  60. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  61. <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>
  62. </button>
  63. </form>
  64. <div class="md-search__output">
  65. <div class="md-search__scrollwrap" data-md-scrollfix>
  66. <div class="md-search-result" data-md-component="search-result">
  67. <div class="md-search-result__meta">
  68. Initializing search
  69. </div>
  70. <ol class="md-search-result__list"></ol>
  71. </div>
  72. </div>
  73. </div>
  74. </div>
  75. </div>
  76. <div class="md-header__source">
  77. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  78. <div class="md-source__icon md-icon">
  79. <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>
  80. </div>
  81. <div class="md-source__repository">
  82. External Secrets Operator
  83. </div>
  84. </a>
  85. </div>
  86. </nav>
  87. </header>
  88. <div class="md-container" data-md-component="container">
  89. <main class="md-main" data-md-component="main">
  90. <div class="md-main__inner md-grid">
  91. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  92. <div class="md-sidebar__scrollwrap">
  93. <div class="md-sidebar__inner">
  94. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  95. <label class="md-nav__title" for="__drawer">
  96. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  97. <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>
  98. </a>
  99. External Secrets Operator
  100. </label>
  101. <div class="md-nav__source">
  102. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  103. <div class="md-source__icon md-icon">
  104. <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>
  105. </div>
  106. <div class="md-source__repository">
  107. External Secrets Operator
  108. </div>
  109. </a>
  110. </div>
  111. <ul class="md-nav__list" data-md-scrollfix>
  112. <li class="md-nav__item">
  113. <a href=".." class="md-nav__link">
  114. Introduction
  115. </a>
  116. </li>
  117. <li class="md-nav__item">
  118. <a href="../api-overview/" class="md-nav__link">
  119. Overview
  120. </a>
  121. </li>
  122. <li class="md-nav__item md-nav__item--nested">
  123. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  124. <label class="md-nav__link" for="__nav_3">
  125. API Types
  126. <span class="md-nav__icon md-icon"></span>
  127. </label>
  128. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  129. <label class="md-nav__title" for="__nav_3">
  130. <span class="md-nav__icon md-icon"></span>
  131. API Types
  132. </label>
  133. <ul class="md-nav__list" data-md-scrollfix>
  134. <li class="md-nav__item">
  135. <a href="../api-externalsecret/" class="md-nav__link">
  136. ExternalSecret
  137. </a>
  138. </li>
  139. <li class="md-nav__item">
  140. <a href="../api-secretstore/" class="md-nav__link">
  141. SecretStore
  142. </a>
  143. </li>
  144. <li class="md-nav__item">
  145. <a href="../api-clustersecretstore/" class="md-nav__link">
  146. ClusterSecretStore
  147. </a>
  148. </li>
  149. </ul>
  150. </nav>
  151. </li>
  152. <li class="md-nav__item md-nav__item--nested">
  153. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  154. <label class="md-nav__link" for="__nav_4">
  155. Guides
  156. <span class="md-nav__icon md-icon"></span>
  157. </label>
  158. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  159. <label class="md-nav__title" for="__nav_4">
  160. <span class="md-nav__icon md-icon"></span>
  161. Guides
  162. </label>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item">
  165. <a href="../guides-introduction/" class="md-nav__link">
  166. Introduction
  167. </a>
  168. </li>
  169. <li class="md-nav__item">
  170. <a href="../guides-getting-started/" class="md-nav__link">
  171. Getting started
  172. </a>
  173. </li>
  174. <li class="md-nav__item">
  175. <a href="../guides-templating/" class="md-nav__link">
  176. Advanced Templating
  177. </a>
  178. </li>
  179. <li class="md-nav__item">
  180. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  181. All keys, One secret
  182. </a>
  183. </li>
  184. <li class="md-nav__item">
  185. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  186. Common K8S Secret Types
  187. </a>
  188. </li>
  189. <li class="md-nav__item">
  190. <a href="../guides-multi-tenancy/" class="md-nav__link">
  191. Multi Tenancy
  192. </a>
  193. </li>
  194. <li class="md-nav__item">
  195. <a href="../guides-metrics/" class="md-nav__link">
  196. Metrics
  197. </a>
  198. </li>
  199. <li class="md-nav__item">
  200. <a href="../guides-using-latest-image/" class="md-nav__link">
  201. Using Latest Image
  202. </a>
  203. </li>
  204. </ul>
  205. </nav>
  206. </li>
  207. <li class="md-nav__item md-nav__item--nested">
  208. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  209. <label class="md-nav__link" for="__nav_5">
  210. Provider
  211. <span class="md-nav__icon md-icon"></span>
  212. </label>
  213. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  214. <label class="md-nav__title" for="__nav_5">
  215. <span class="md-nav__icon md-icon"></span>
  216. Provider
  217. </label>
  218. <ul class="md-nav__list" data-md-scrollfix>
  219. <li class="md-nav__item md-nav__item--nested">
  220. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  221. <label class="md-nav__link" for="__nav_5_1">
  222. AWS
  223. <span class="md-nav__icon md-icon"></span>
  224. </label>
  225. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  226. <label class="md-nav__title" for="__nav_5_1">
  227. <span class="md-nav__icon md-icon"></span>
  228. AWS
  229. </label>
  230. <ul class="md-nav__list" data-md-scrollfix>
  231. <li class="md-nav__item">
  232. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  233. Secrets Manager
  234. </a>
  235. </li>
  236. <li class="md-nav__item">
  237. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  238. Parameter Store
  239. </a>
  240. </li>
  241. </ul>
  242. </nav>
  243. </li>
  244. <li class="md-nav__item md-nav__item--nested">
  245. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  246. <label class="md-nav__link" for="__nav_5_2">
  247. Azure
  248. <span class="md-nav__icon md-icon"></span>
  249. </label>
  250. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  251. <label class="md-nav__title" for="__nav_5_2">
  252. <span class="md-nav__icon md-icon"></span>
  253. Azure
  254. </label>
  255. <ul class="md-nav__list" data-md-scrollfix>
  256. <li class="md-nav__item">
  257. <a href="../provider-azure-key-vault/" class="md-nav__link">
  258. Key Vault
  259. </a>
  260. </li>
  261. </ul>
  262. </nav>
  263. </li>
  264. <li class="md-nav__item md-nav__item--nested">
  265. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  266. <label class="md-nav__link" for="__nav_5_3">
  267. Google
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. <nav class="md-nav" aria-label="Google" data-md-level="2">
  271. <label class="md-nav__title" for="__nav_5_3">
  272. <span class="md-nav__icon md-icon"></span>
  273. Google
  274. </label>
  275. <ul class="md-nav__list" data-md-scrollfix>
  276. <li class="md-nav__item">
  277. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  278. Secrets Manager
  279. </a>
  280. </li>
  281. </ul>
  282. </nav>
  283. </li>
  284. <li class="md-nav__item md-nav__item--nested">
  285. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  286. <label class="md-nav__link" for="__nav_5_4">
  287. IBM
  288. <span class="md-nav__icon md-icon"></span>
  289. </label>
  290. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  291. <label class="md-nav__title" for="__nav_5_4">
  292. <span class="md-nav__icon md-icon"></span>
  293. IBM
  294. </label>
  295. <ul class="md-nav__list" data-md-scrollfix>
  296. <li class="md-nav__item">
  297. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  298. Secrets Manager
  299. </a>
  300. </li>
  301. </ul>
  302. </nav>
  303. </li>
  304. <li class="md-nav__item">
  305. <a href="../provider-akeyless/" class="md-nav__link">
  306. Akeyless
  307. </a>
  308. </li>
  309. <li class="md-nav__item">
  310. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  311. HashiCorp Vault
  312. </a>
  313. </li>
  314. <li class="md-nav__item md-nav__item--nested">
  315. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  316. <label class="md-nav__link" for="__nav_5_7">
  317. Yandex
  318. <span class="md-nav__icon md-icon"></span>
  319. </label>
  320. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  321. <label class="md-nav__title" for="__nav_5_7">
  322. <span class="md-nav__icon md-icon"></span>
  323. Yandex
  324. </label>
  325. <ul class="md-nav__list" data-md-scrollfix>
  326. <li class="md-nav__item">
  327. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  328. Lockbox
  329. </a>
  330. </li>
  331. </ul>
  332. </nav>
  333. </li>
  334. <li class="md-nav__item md-nav__item--nested">
  335. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  336. <label class="md-nav__link" for="__nav_5_8">
  337. Gitlab
  338. <span class="md-nav__icon md-icon"></span>
  339. </label>
  340. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  341. <label class="md-nav__title" for="__nav_5_8">
  342. <span class="md-nav__icon md-icon"></span>
  343. Gitlab
  344. </label>
  345. <ul class="md-nav__list" data-md-scrollfix>
  346. <li class="md-nav__item">
  347. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  348. Gitlab Project Variables
  349. </a>
  350. </li>
  351. </ul>
  352. </nav>
  353. </li>
  354. <li class="md-nav__item md-nav__item--nested">
  355. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  356. <label class="md-nav__link" for="__nav_5_9">
  357. Oracle
  358. <span class="md-nav__icon md-icon"></span>
  359. </label>
  360. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  361. <label class="md-nav__title" for="__nav_5_9">
  362. <span class="md-nav__icon md-icon"></span>
  363. Oracle
  364. </label>
  365. <ul class="md-nav__list" data-md-scrollfix>
  366. <li class="md-nav__item">
  367. <a href="../provider-oracle-vault/" class="md-nav__link">
  368. Oracle Vault
  369. </a>
  370. </li>
  371. </ul>
  372. </nav>
  373. </li>
  374. </ul>
  375. </nav>
  376. </li>
  377. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  378. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
  379. <label class="md-nav__link" for="__nav_6">
  380. References
  381. <span class="md-nav__icon md-icon"></span>
  382. </label>
  383. <nav class="md-nav" aria-label="References" data-md-level="1">
  384. <label class="md-nav__title" for="__nav_6">
  385. <span class="md-nav__icon md-icon"></span>
  386. References
  387. </label>
  388. <ul class="md-nav__list" data-md-scrollfix>
  389. <li class="md-nav__item md-nav__item--active">
  390. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  391. <a href="./" class="md-nav__link md-nav__link--active">
  392. API specification
  393. </a>
  394. </li>
  395. </ul>
  396. </nav>
  397. </li>
  398. <li class="md-nav__item md-nav__item--nested">
  399. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  400. <label class="md-nav__link" for="__nav_7">
  401. Contributing
  402. <span class="md-nav__icon md-icon"></span>
  403. </label>
  404. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  405. <label class="md-nav__title" for="__nav_7">
  406. <span class="md-nav__icon md-icon"></span>
  407. Contributing
  408. </label>
  409. <ul class="md-nav__list" data-md-scrollfix>
  410. <li class="md-nav__item">
  411. <a href="../contributing-devguide/" class="md-nav__link">
  412. Developer guide
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../contributing-process/" class="md-nav__link">
  417. Contributing Process
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../contributing-coc/" class="md-nav__link">
  422. Code of Conduct
  423. </a>
  424. </li>
  425. </ul>
  426. </nav>
  427. </li>
  428. <li class="md-nav__item">
  429. <a href="../deprecation-policy/" class="md-nav__link">
  430. Deprecation Policy
  431. </a>
  432. </li>
  433. </ul>
  434. </nav>
  435. </div>
  436. </div>
  437. </div>
  438. <div class="md-content" data-md-component="content">
  439. <article class="md-content__inner md-typeset">
  440. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/spec.md" title="Edit this page" class="md-content__button md-icon">
  441. <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>
  442. </a>
  443. <h1>API specification</h1>
  444. <p>Packages:</p>
  445. <ul>
  446. <li>
  447. <a href="#external-secrets.io%2fv1alpha1">external-secrets.io/v1alpha1</a>
  448. </li>
  449. </ul>
  450. <h2 id="external-secrets.io/v1alpha1">external-secrets.io/v1alpha1</h2>
  451. <p>
  452. <p>Package v1alpha1 contains resources for external-secrets</p>
  453. </p>
  454. <p>Resource Types:
  455. <ul></ul>
  456. <h3 id="external-secrets.io/v1alpha1.AWSAuth">AWSAuth
  457. </h3>
  458. <p>
  459. (<em>Appears on:</em>
  460. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
  461. </p>
  462. <p>
  463. <p>AWSAuth tells the controller how to do authentication with aws.
  464. Only one of secretRef or jwt can be specified.
  465. if none is specified the controller will load credentials using the aws sdk defaults.</p>
  466. </p>
  467. <table>
  468. <thead>
  469. <tr>
  470. <th>Field</th>
  471. <th>Description</th>
  472. </tr>
  473. </thead>
  474. <tbody>
  475. <tr>
  476. <td>
  477. <code>secretRef</code></br>
  478. <em>
  479. <a href="#external-secrets.io/v1alpha1.AWSAuthSecretRef">
  480. AWSAuthSecretRef
  481. </a>
  482. </em>
  483. </td>
  484. <td>
  485. <em>(Optional)</em>
  486. </td>
  487. </tr>
  488. <tr>
  489. <td>
  490. <code>jwt</code></br>
  491. <em>
  492. <a href="#external-secrets.io/v1alpha1.AWSJWTAuth">
  493. AWSJWTAuth
  494. </a>
  495. </em>
  496. </td>
  497. <td>
  498. <em>(Optional)</em>
  499. </td>
  500. </tr>
  501. </tbody>
  502. </table>
  503. <h3 id="external-secrets.io/v1alpha1.AWSAuthSecretRef">AWSAuthSecretRef
  504. </h3>
  505. <p>
  506. (<em>Appears on:</em>
  507. <a href="#external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
  508. </p>
  509. <p>
  510. <p>AWSAuthSecretRef holds secret references for AWS credentials
  511. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  512. </p>
  513. <table>
  514. <thead>
  515. <tr>
  516. <th>Field</th>
  517. <th>Description</th>
  518. </tr>
  519. </thead>
  520. <tbody>
  521. <tr>
  522. <td>
  523. <code>accessKeyIDSecretRef</code></br>
  524. <em>
  525. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  526. </em>
  527. </td>
  528. <td>
  529. <p>The AccessKeyID is used for authentication</p>
  530. </td>
  531. </tr>
  532. <tr>
  533. <td>
  534. <code>secretAccessKeySecretRef</code></br>
  535. <em>
  536. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  537. </em>
  538. </td>
  539. <td>
  540. <p>The SecretAccessKey is used for authentication</p>
  541. </td>
  542. </tr>
  543. </tbody>
  544. </table>
  545. <h3 id="external-secrets.io/v1alpha1.AWSJWTAuth">AWSJWTAuth
  546. </h3>
  547. <p>
  548. (<em>Appears on:</em>
  549. <a href="#external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
  550. </p>
  551. <p>
  552. <p>Authenticate against AWS using service account tokens.</p>
  553. </p>
  554. <table>
  555. <thead>
  556. <tr>
  557. <th>Field</th>
  558. <th>Description</th>
  559. </tr>
  560. </thead>
  561. <tbody>
  562. <tr>
  563. <td>
  564. <code>serviceAccountRef</code></br>
  565. <em>
  566. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  567. </em>
  568. </td>
  569. <td>
  570. </td>
  571. </tr>
  572. </tbody>
  573. </table>
  574. <h3 id="external-secrets.io/v1alpha1.AWSProvider">AWSProvider
  575. </h3>
  576. <p>
  577. (<em>Appears on:</em>
  578. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  579. </p>
  580. <p>
  581. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  582. </p>
  583. <table>
  584. <thead>
  585. <tr>
  586. <th>Field</th>
  587. <th>Description</th>
  588. </tr>
  589. </thead>
  590. <tbody>
  591. <tr>
  592. <td>
  593. <code>service</code></br>
  594. <em>
  595. <a href="#external-secrets.io/v1alpha1.AWSServiceType">
  596. AWSServiceType
  597. </a>
  598. </em>
  599. </td>
  600. <td>
  601. <p>Service defines which service should be used to fetch the secrets</p>
  602. </td>
  603. </tr>
  604. <tr>
  605. <td>
  606. <code>auth</code></br>
  607. <em>
  608. <a href="#external-secrets.io/v1alpha1.AWSAuth">
  609. AWSAuth
  610. </a>
  611. </em>
  612. </td>
  613. <td>
  614. <em>(Optional)</em>
  615. <p>Auth defines the information necessary to authenticate against AWS
  616. if not set aws sdk will infer credentials from your environment
  617. 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>
  618. </td>
  619. </tr>
  620. <tr>
  621. <td>
  622. <code>role</code></br>
  623. <em>
  624. string
  625. </em>
  626. </td>
  627. <td>
  628. <em>(Optional)</em>
  629. <p>Role is a Role ARN which the SecretManager provider will assume</p>
  630. </td>
  631. </tr>
  632. <tr>
  633. <td>
  634. <code>region</code></br>
  635. <em>
  636. string
  637. </em>
  638. </td>
  639. <td>
  640. <p>AWS Region to be used for the provider</p>
  641. </td>
  642. </tr>
  643. </tbody>
  644. </table>
  645. <h3 id="external-secrets.io/v1alpha1.AWSServiceType">AWSServiceType
  646. (<code>string</code> alias)</p></h3>
  647. <p>
  648. (<em>Appears on:</em>
  649. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
  650. </p>
  651. <p>
  652. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  653. </p>
  654. <table>
  655. <thead>
  656. <tr>
  657. <th>Value</th>
  658. <th>Description</th>
  659. </tr>
  660. </thead>
  661. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  662. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore.
  663. 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>
  664. </td>
  665. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  666. <td><p>AWSServiceSecretsManager is the AWS SecretsManager.
  667. 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>
  668. </td>
  669. </tr></tbody>
  670. </table>
  671. <h3 id="external-secrets.io/v1alpha1.AkeylessAuth">AkeylessAuth
  672. </h3>
  673. <p>
  674. (<em>Appears on:</em>
  675. <a href="#external-secrets.io/v1alpha1.AkeylessProvider">AkeylessProvider</a>)
  676. </p>
  677. <p>
  678. </p>
  679. <table>
  680. <thead>
  681. <tr>
  682. <th>Field</th>
  683. <th>Description</th>
  684. </tr>
  685. </thead>
  686. <tbody>
  687. <tr>
  688. <td>
  689. <code>secretRef</code></br>
  690. <em>
  691. <a href="#external-secrets.io/v1alpha1.AkeylessAuthSecretRef">
  692. AkeylessAuthSecretRef
  693. </a>
  694. </em>
  695. </td>
  696. <td>
  697. </td>
  698. </tr>
  699. </tbody>
  700. </table>
  701. <h3 id="external-secrets.io/v1alpha1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
  702. </h3>
  703. <p>
  704. (<em>Appears on:</em>
  705. <a href="#external-secrets.io/v1alpha1.AkeylessAuth">AkeylessAuth</a>)
  706. </p>
  707. <p>
  708. <p>AkeylessAuthSecretRef
  709. AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
  710. </p>
  711. <table>
  712. <thead>
  713. <tr>
  714. <th>Field</th>
  715. <th>Description</th>
  716. </tr>
  717. </thead>
  718. <tbody>
  719. <tr>
  720. <td>
  721. <code>accessID</code></br>
  722. <em>
  723. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  724. </em>
  725. </td>
  726. <td>
  727. <p>The SecretAccessID is used for authentication</p>
  728. </td>
  729. </tr>
  730. <tr>
  731. <td>
  732. <code>accessType</code></br>
  733. <em>
  734. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  735. </em>
  736. </td>
  737. <td>
  738. </td>
  739. </tr>
  740. <tr>
  741. <td>
  742. <code>accessTypeParam</code></br>
  743. <em>
  744. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  745. </em>
  746. </td>
  747. <td>
  748. </td>
  749. </tr>
  750. </tbody>
  751. </table>
  752. <h3 id="external-secrets.io/v1alpha1.AkeylessProvider">AkeylessProvider
  753. </h3>
  754. <p>
  755. (<em>Appears on:</em>
  756. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  757. </p>
  758. <p>
  759. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  760. </p>
  761. <table>
  762. <thead>
  763. <tr>
  764. <th>Field</th>
  765. <th>Description</th>
  766. </tr>
  767. </thead>
  768. <tbody>
  769. <tr>
  770. <td>
  771. <code>akeylessGWApiURL</code></br>
  772. <em>
  773. string
  774. </em>
  775. </td>
  776. <td>
  777. <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
  778. </td>
  779. </tr>
  780. <tr>
  781. <td>
  782. <code>authSecretRef</code></br>
  783. <em>
  784. <a href="#external-secrets.io/v1alpha1.AkeylessAuth">
  785. AkeylessAuth
  786. </a>
  787. </em>
  788. </td>
  789. <td>
  790. <p>Auth configures how the operator authenticates with Akeyless.</p>
  791. </td>
  792. </tr>
  793. </tbody>
  794. </table>
  795. <h3 id="external-secrets.io/v1alpha1.AlibabaAuth">AlibabaAuth
  796. </h3>
  797. <p>
  798. (<em>Appears on:</em>
  799. <a href="#external-secrets.io/v1alpha1.AlibabaProvider">AlibabaProvider</a>)
  800. </p>
  801. <p>
  802. <p>AlibabaAuth contains a secretRef for credentials.</p>
  803. </p>
  804. <table>
  805. <thead>
  806. <tr>
  807. <th>Field</th>
  808. <th>Description</th>
  809. </tr>
  810. </thead>
  811. <tbody>
  812. <tr>
  813. <td>
  814. <code>secretRef</code></br>
  815. <em>
  816. <a href="#external-secrets.io/v1alpha1.AlibabaAuthSecretRef">
  817. AlibabaAuthSecretRef
  818. </a>
  819. </em>
  820. </td>
  821. <td>
  822. </td>
  823. </tr>
  824. </tbody>
  825. </table>
  826. <h3 id="external-secrets.io/v1alpha1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
  827. </h3>
  828. <p>
  829. (<em>Appears on:</em>
  830. <a href="#external-secrets.io/v1alpha1.AlibabaAuth">AlibabaAuth</a>)
  831. </p>
  832. <p>
  833. <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
  834. </p>
  835. <table>
  836. <thead>
  837. <tr>
  838. <th>Field</th>
  839. <th>Description</th>
  840. </tr>
  841. </thead>
  842. <tbody>
  843. <tr>
  844. <td>
  845. <code>accessKeyIDSecretRef</code></br>
  846. <em>
  847. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  848. </em>
  849. </td>
  850. <td>
  851. <p>The AccessKeyID is used for authentication</p>
  852. </td>
  853. </tr>
  854. <tr>
  855. <td>
  856. <code>accessKeySecretSecretRef</code></br>
  857. <em>
  858. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  859. </em>
  860. </td>
  861. <td>
  862. <p>The AccessKeySecret is used for authentication</p>
  863. </td>
  864. </tr>
  865. </tbody>
  866. </table>
  867. <h3 id="external-secrets.io/v1alpha1.AlibabaProvider">AlibabaProvider
  868. </h3>
  869. <p>
  870. (<em>Appears on:</em>
  871. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  872. </p>
  873. <p>
  874. <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
  875. </p>
  876. <table>
  877. <thead>
  878. <tr>
  879. <th>Field</th>
  880. <th>Description</th>
  881. </tr>
  882. </thead>
  883. <tbody>
  884. <tr>
  885. <td>
  886. <code>auth</code></br>
  887. <em>
  888. <a href="#external-secrets.io/v1alpha1.AlibabaAuth">
  889. AlibabaAuth
  890. </a>
  891. </em>
  892. </td>
  893. <td>
  894. </td>
  895. </tr>
  896. <tr>
  897. <td>
  898. <code>endpoint</code></br>
  899. <em>
  900. string
  901. </em>
  902. </td>
  903. <td>
  904. <em>(Optional)</em>
  905. </td>
  906. </tr>
  907. <tr>
  908. <td>
  909. <code>regionID</code></br>
  910. <em>
  911. string
  912. </em>
  913. </td>
  914. <td>
  915. <p>Alibaba Region to be used for the provider</p>
  916. </td>
  917. </tr>
  918. </tbody>
  919. </table>
  920. <h3 id="external-secrets.io/v1alpha1.AuthType">AuthType
  921. (<code>string</code> alias)</p></h3>
  922. <p>
  923. (<em>Appears on:</em>
  924. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider</a>)
  925. </p>
  926. <p>
  927. <p>AuthType describes how to authenticate to the Azure Keyvault
  928. Only one of the following auth types may be specified.
  929. If none of the following auth type is specified, the default one
  930. is ServicePrincipal.</p>
  931. </p>
  932. <table>
  933. <thead>
  934. <tr>
  935. <th>Value</th>
  936. <th>Description</th>
  937. </tr>
  938. </thead>
  939. <tbody><tr><td><p>&#34;ManagedIdentity&#34;</p></td>
  940. <td><p>Using Managed Identity to authenticate. Used with aad-pod-identity instelled in the clister.</p>
  941. </td>
  942. </tr><tr><td><p>&#34;ServicePrincipal&#34;</p></td>
  943. <td><p>Using service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.</p>
  944. </td>
  945. </tr></tbody>
  946. </table>
  947. <h3 id="external-secrets.io/v1alpha1.AzureKVAuth">AzureKVAuth
  948. </h3>
  949. <p>
  950. (<em>Appears on:</em>
  951. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider</a>)
  952. </p>
  953. <p>
  954. <p>Configuration used to authenticate with Azure.</p>
  955. </p>
  956. <table>
  957. <thead>
  958. <tr>
  959. <th>Field</th>
  960. <th>Description</th>
  961. </tr>
  962. </thead>
  963. <tbody>
  964. <tr>
  965. <td>
  966. <code>clientId</code></br>
  967. <em>
  968. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  969. </em>
  970. </td>
  971. <td>
  972. <p>The Azure clientId of the service principle used for authentication.</p>
  973. </td>
  974. </tr>
  975. <tr>
  976. <td>
  977. <code>clientSecret</code></br>
  978. <em>
  979. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  980. </em>
  981. </td>
  982. <td>
  983. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  984. </td>
  985. </tr>
  986. </tbody>
  987. </table>
  988. <h3 id="external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider
  989. </h3>
  990. <p>
  991. (<em>Appears on:</em>
  992. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  993. </p>
  994. <p>
  995. <p>Configures an store to sync secrets using Azure KV.</p>
  996. </p>
  997. <table>
  998. <thead>
  999. <tr>
  1000. <th>Field</th>
  1001. <th>Description</th>
  1002. </tr>
  1003. </thead>
  1004. <tbody>
  1005. <tr>
  1006. <td>
  1007. <code>authType</code></br>
  1008. <em>
  1009. <a href="#external-secrets.io/v1alpha1.AuthType">
  1010. AuthType
  1011. </a>
  1012. </em>
  1013. </td>
  1014. <td>
  1015. <em>(Optional)</em>
  1016. <p>Auth type defines how to authenticate to the keyvault service.
  1017. Valid values are:
  1018. - &ldquo;ServicePrincipal&rdquo; (default): Using a service principal (tenantId, clientId, clientSecret)
  1019. - &ldquo;ManagedIdentity&rdquo;: Using Managed Identity assigned to the pod (see aad-pod-identity)</p>
  1020. </td>
  1021. </tr>
  1022. <tr>
  1023. <td>
  1024. <code>vaultUrl</code></br>
  1025. <em>
  1026. string
  1027. </em>
  1028. </td>
  1029. <td>
  1030. <p>Vault Url from which the secrets to be fetched from.</p>
  1031. </td>
  1032. </tr>
  1033. <tr>
  1034. <td>
  1035. <code>tenantId</code></br>
  1036. <em>
  1037. string
  1038. </em>
  1039. </td>
  1040. <td>
  1041. <em>(Optional)</em>
  1042. <p>TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type.</p>
  1043. </td>
  1044. </tr>
  1045. <tr>
  1046. <td>
  1047. <code>authSecretRef</code></br>
  1048. <em>
  1049. <a href="#external-secrets.io/v1alpha1.AzureKVAuth">
  1050. AzureKVAuth
  1051. </a>
  1052. </em>
  1053. </td>
  1054. <td>
  1055. <em>(Optional)</em>
  1056. <p>Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type.</p>
  1057. </td>
  1058. </tr>
  1059. <tr>
  1060. <td>
  1061. <code>identityId</code></br>
  1062. <em>
  1063. string
  1064. </em>
  1065. </td>
  1066. <td>
  1067. <em>(Optional)</em>
  1068. <p>If multiple Managed Identity is assigned to the pod, you can select the one to be used</p>
  1069. </td>
  1070. </tr>
  1071. </tbody>
  1072. </table>
  1073. <h3 id="external-secrets.io/v1alpha1.CAProvider">CAProvider
  1074. </h3>
  1075. <p>
  1076. (<em>Appears on:</em>
  1077. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  1078. </p>
  1079. <p>
  1080. <p>Defines a location to fetch the cert for the vault provider from.</p>
  1081. </p>
  1082. <table>
  1083. <thead>
  1084. <tr>
  1085. <th>Field</th>
  1086. <th>Description</th>
  1087. </tr>
  1088. </thead>
  1089. <tbody>
  1090. <tr>
  1091. <td>
  1092. <code>type</code></br>
  1093. <em>
  1094. <a href="#external-secrets.io/v1alpha1.CAProviderType">
  1095. CAProviderType
  1096. </a>
  1097. </em>
  1098. </td>
  1099. <td>
  1100. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  1101. </td>
  1102. </tr>
  1103. <tr>
  1104. <td>
  1105. <code>name</code></br>
  1106. <em>
  1107. string
  1108. </em>
  1109. </td>
  1110. <td>
  1111. <p>The name of the object located at the provider type.</p>
  1112. </td>
  1113. </tr>
  1114. <tr>
  1115. <td>
  1116. <code>key</code></br>
  1117. <em>
  1118. string
  1119. </em>
  1120. </td>
  1121. <td>
  1122. <p>The key the value inside of the provider type to use, only used with &ldquo;Secret&rdquo; type</p>
  1123. </td>
  1124. </tr>
  1125. <tr>
  1126. <td>
  1127. <code>namespace</code></br>
  1128. <em>
  1129. string
  1130. </em>
  1131. </td>
  1132. <td>
  1133. <p>The namespace the Provider type is in.</p>
  1134. </td>
  1135. </tr>
  1136. </tbody>
  1137. </table>
  1138. <h3 id="external-secrets.io/v1alpha1.CAProviderType">CAProviderType
  1139. (<code>string</code> alias)</p></h3>
  1140. <p>
  1141. (<em>Appears on:</em>
  1142. <a href="#external-secrets.io/v1alpha1.CAProvider">CAProvider</a>)
  1143. </p>
  1144. <p>
  1145. </p>
  1146. <table>
  1147. <thead>
  1148. <tr>
  1149. <th>Value</th>
  1150. <th>Description</th>
  1151. </tr>
  1152. </thead>
  1153. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  1154. <td></td>
  1155. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  1156. <td></td>
  1157. </tr></tbody>
  1158. </table>
  1159. <h3 id="external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore
  1160. </h3>
  1161. <p>
  1162. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  1163. </p>
  1164. <table>
  1165. <thead>
  1166. <tr>
  1167. <th>Field</th>
  1168. <th>Description</th>
  1169. </tr>
  1170. </thead>
  1171. <tbody>
  1172. <tr>
  1173. <td>
  1174. <code>metadata</code></br>
  1175. <em>
  1176. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1177. Kubernetes meta/v1.ObjectMeta
  1178. </a>
  1179. </em>
  1180. </td>
  1181. <td>
  1182. Refer to the Kubernetes API documentation for the fields of the
  1183. <code>metadata</code> field.
  1184. </td>
  1185. </tr>
  1186. <tr>
  1187. <td>
  1188. <code>spec</code></br>
  1189. <em>
  1190. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  1191. SecretStoreSpec
  1192. </a>
  1193. </em>
  1194. </td>
  1195. <td>
  1196. <br/>
  1197. <br/>
  1198. <table>
  1199. <tr>
  1200. <td>
  1201. <code>controller</code></br>
  1202. <em>
  1203. string
  1204. </em>
  1205. </td>
  1206. <td>
  1207. <em>(Optional)</em>
  1208. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  1209. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  1210. </td>
  1211. </tr>
  1212. <tr>
  1213. <td>
  1214. <code>provider</code></br>
  1215. <em>
  1216. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  1217. SecretStoreProvider
  1218. </a>
  1219. </em>
  1220. </td>
  1221. <td>
  1222. <p>Used to configure the provider. Only one provider may be set</p>
  1223. </td>
  1224. </tr>
  1225. <tr>
  1226. <td>
  1227. <code>retrySettings</code></br>
  1228. <em>
  1229. <a href="#external-secrets.io/v1alpha1.SecretStoreRetrySettings">
  1230. SecretStoreRetrySettings
  1231. </a>
  1232. </em>
  1233. </td>
  1234. <td>
  1235. <em>(Optional)</em>
  1236. <p>Used to configure http retries if failed</p>
  1237. </td>
  1238. </tr>
  1239. </table>
  1240. </td>
  1241. </tr>
  1242. <tr>
  1243. <td>
  1244. <code>status</code></br>
  1245. <em>
  1246. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  1247. SecretStoreStatus
  1248. </a>
  1249. </em>
  1250. </td>
  1251. <td>
  1252. </td>
  1253. </tr>
  1254. </tbody>
  1255. </table>
  1256. <h3 id="external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret
  1257. </h3>
  1258. <p>
  1259. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  1260. </p>
  1261. <table>
  1262. <thead>
  1263. <tr>
  1264. <th>Field</th>
  1265. <th>Description</th>
  1266. </tr>
  1267. </thead>
  1268. <tbody>
  1269. <tr>
  1270. <td>
  1271. <code>metadata</code></br>
  1272. <em>
  1273. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1274. Kubernetes meta/v1.ObjectMeta
  1275. </a>
  1276. </em>
  1277. </td>
  1278. <td>
  1279. Refer to the Kubernetes API documentation for the fields of the
  1280. <code>metadata</code> field.
  1281. </td>
  1282. </tr>
  1283. <tr>
  1284. <td>
  1285. <code>spec</code></br>
  1286. <em>
  1287. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">
  1288. ExternalSecretSpec
  1289. </a>
  1290. </em>
  1291. </td>
  1292. <td>
  1293. <br/>
  1294. <br/>
  1295. <table>
  1296. <tr>
  1297. <td>
  1298. <code>secretStoreRef</code></br>
  1299. <em>
  1300. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  1301. SecretStoreRef
  1302. </a>
  1303. </em>
  1304. </td>
  1305. <td>
  1306. </td>
  1307. </tr>
  1308. <tr>
  1309. <td>
  1310. <code>target</code></br>
  1311. <em>
  1312. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  1313. ExternalSecretTarget
  1314. </a>
  1315. </em>
  1316. </td>
  1317. <td>
  1318. </td>
  1319. </tr>
  1320. <tr>
  1321. <td>
  1322. <code>refreshInterval</code></br>
  1323. <em>
  1324. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1325. Kubernetes meta/v1.Duration
  1326. </a>
  1327. </em>
  1328. </td>
  1329. <td>
  1330. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  1331. 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;
  1332. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  1333. </td>
  1334. </tr>
  1335. <tr>
  1336. <td>
  1337. <code>data</code></br>
  1338. <em>
  1339. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  1340. []ExternalSecretData
  1341. </a>
  1342. </em>
  1343. </td>
  1344. <td>
  1345. <em>(Optional)</em>
  1346. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  1347. </td>
  1348. </tr>
  1349. <tr>
  1350. <td>
  1351. <code>dataFrom</code></br>
  1352. <em>
  1353. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1354. []ExternalSecretDataRemoteRef
  1355. </a>
  1356. </em>
  1357. </td>
  1358. <td>
  1359. <em>(Optional)</em>
  1360. <p>DataFrom is used to fetch all properties from a specific Provider data
  1361. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  1362. </td>
  1363. </tr>
  1364. </table>
  1365. </td>
  1366. </tr>
  1367. <tr>
  1368. <td>
  1369. <code>status</code></br>
  1370. <em>
  1371. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">
  1372. ExternalSecretStatus
  1373. </a>
  1374. </em>
  1375. </td>
  1376. <td>
  1377. </td>
  1378. </tr>
  1379. </tbody>
  1380. </table>
  1381. <h3 id="external-secrets.io/v1alpha1.ExternalSecretConditionType">ExternalSecretConditionType
  1382. (<code>string</code> alias)</p></h3>
  1383. <p>
  1384. (<em>Appears on:</em>
  1385. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  1386. </p>
  1387. <p>
  1388. </p>
  1389. <table>
  1390. <thead>
  1391. <tr>
  1392. <th>Value</th>
  1393. <th>Description</th>
  1394. </tr>
  1395. </thead>
  1396. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
  1397. <td></td>
  1398. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  1399. <td></td>
  1400. </tr></tbody>
  1401. </table>
  1402. <h3 id="external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  1403. (<code>string</code> alias)</p></h3>
  1404. <p>
  1405. (<em>Appears on:</em>
  1406. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  1407. </p>
  1408. <p>
  1409. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  1410. </p>
  1411. <table>
  1412. <thead>
  1413. <tr>
  1414. <th>Value</th>
  1415. <th>Description</th>
  1416. </tr>
  1417. </thead>
  1418. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  1419. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  1420. </td>
  1421. </tr><tr><td><p>&#34;None&#34;</p></td>
  1422. <td><p>None does not create a Secret (future use with injector).</p>
  1423. </td>
  1424. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  1425. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  1426. </td>
  1427. </tr></tbody>
  1428. </table>
  1429. <h3 id="external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData
  1430. </h3>
  1431. <p>
  1432. (<em>Appears on:</em>
  1433. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1434. </p>
  1435. <p>
  1436. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  1437. </p>
  1438. <table>
  1439. <thead>
  1440. <tr>
  1441. <th>Field</th>
  1442. <th>Description</th>
  1443. </tr>
  1444. </thead>
  1445. <tbody>
  1446. <tr>
  1447. <td>
  1448. <code>secretKey</code></br>
  1449. <em>
  1450. string
  1451. </em>
  1452. </td>
  1453. <td>
  1454. </td>
  1455. </tr>
  1456. <tr>
  1457. <td>
  1458. <code>remoteRef</code></br>
  1459. <em>
  1460. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1461. ExternalSecretDataRemoteRef
  1462. </a>
  1463. </em>
  1464. </td>
  1465. <td>
  1466. </td>
  1467. </tr>
  1468. </tbody>
  1469. </table>
  1470. <h3 id="external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  1471. </h3>
  1472. <p>
  1473. (<em>Appears on:</em>
  1474. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData</a>,
  1475. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1476. </p>
  1477. <p>
  1478. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  1479. </p>
  1480. <table>
  1481. <thead>
  1482. <tr>
  1483. <th>Field</th>
  1484. <th>Description</th>
  1485. </tr>
  1486. </thead>
  1487. <tbody>
  1488. <tr>
  1489. <td>
  1490. <code>key</code></br>
  1491. <em>
  1492. string
  1493. </em>
  1494. </td>
  1495. <td>
  1496. <p>Key is the key used in the Provider, mandatory</p>
  1497. </td>
  1498. </tr>
  1499. <tr>
  1500. <td>
  1501. <code>version</code></br>
  1502. <em>
  1503. string
  1504. </em>
  1505. </td>
  1506. <td>
  1507. <em>(Optional)</em>
  1508. <p>Used to select a specific version of the Provider value, if supported</p>
  1509. </td>
  1510. </tr>
  1511. <tr>
  1512. <td>
  1513. <code>property</code></br>
  1514. <em>
  1515. string
  1516. </em>
  1517. </td>
  1518. <td>
  1519. <em>(Optional)</em>
  1520. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  1521. </td>
  1522. </tr>
  1523. </tbody>
  1524. </table>
  1525. <h3 id="external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec
  1526. </h3>
  1527. <p>
  1528. (<em>Appears on:</em>
  1529. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  1530. </p>
  1531. <p>
  1532. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  1533. </p>
  1534. <table>
  1535. <thead>
  1536. <tr>
  1537. <th>Field</th>
  1538. <th>Description</th>
  1539. </tr>
  1540. </thead>
  1541. <tbody>
  1542. <tr>
  1543. <td>
  1544. <code>secretStoreRef</code></br>
  1545. <em>
  1546. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  1547. SecretStoreRef
  1548. </a>
  1549. </em>
  1550. </td>
  1551. <td>
  1552. </td>
  1553. </tr>
  1554. <tr>
  1555. <td>
  1556. <code>target</code></br>
  1557. <em>
  1558. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  1559. ExternalSecretTarget
  1560. </a>
  1561. </em>
  1562. </td>
  1563. <td>
  1564. </td>
  1565. </tr>
  1566. <tr>
  1567. <td>
  1568. <code>refreshInterval</code></br>
  1569. <em>
  1570. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1571. Kubernetes meta/v1.Duration
  1572. </a>
  1573. </em>
  1574. </td>
  1575. <td>
  1576. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  1577. 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;
  1578. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  1579. </td>
  1580. </tr>
  1581. <tr>
  1582. <td>
  1583. <code>data</code></br>
  1584. <em>
  1585. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  1586. []ExternalSecretData
  1587. </a>
  1588. </em>
  1589. </td>
  1590. <td>
  1591. <em>(Optional)</em>
  1592. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  1593. </td>
  1594. </tr>
  1595. <tr>
  1596. <td>
  1597. <code>dataFrom</code></br>
  1598. <em>
  1599. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1600. []ExternalSecretDataRemoteRef
  1601. </a>
  1602. </em>
  1603. </td>
  1604. <td>
  1605. <em>(Optional)</em>
  1606. <p>DataFrom is used to fetch all properties from a specific Provider data
  1607. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  1608. </td>
  1609. </tr>
  1610. </tbody>
  1611. </table>
  1612. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus
  1613. </h3>
  1614. <p>
  1615. (<em>Appears on:</em>
  1616. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  1617. </p>
  1618. <p>
  1619. </p>
  1620. <table>
  1621. <thead>
  1622. <tr>
  1623. <th>Field</th>
  1624. <th>Description</th>
  1625. </tr>
  1626. </thead>
  1627. <tbody>
  1628. <tr>
  1629. <td>
  1630. <code>refreshTime</code></br>
  1631. <em>
  1632. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1633. Kubernetes meta/v1.Time
  1634. </a>
  1635. </em>
  1636. </td>
  1637. <td>
  1638. <p>refreshTime is the time and date the external secret was fetched and
  1639. the target secret updated</p>
  1640. </td>
  1641. </tr>
  1642. <tr>
  1643. <td>
  1644. <code>syncedResourceVersion</code></br>
  1645. <em>
  1646. string
  1647. </em>
  1648. </td>
  1649. <td>
  1650. <p>SyncedResourceVersion keeps track of the last synced version</p>
  1651. </td>
  1652. </tr>
  1653. <tr>
  1654. <td>
  1655. <code>conditions</code></br>
  1656. <em>
  1657. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">
  1658. []ExternalSecretStatusCondition
  1659. </a>
  1660. </em>
  1661. </td>
  1662. <td>
  1663. <em>(Optional)</em>
  1664. </td>
  1665. </tr>
  1666. </tbody>
  1667. </table>
  1668. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  1669. </h3>
  1670. <p>
  1671. (<em>Appears on:</em>
  1672. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus</a>)
  1673. </p>
  1674. <p>
  1675. </p>
  1676. <table>
  1677. <thead>
  1678. <tr>
  1679. <th>Field</th>
  1680. <th>Description</th>
  1681. </tr>
  1682. </thead>
  1683. <tbody>
  1684. <tr>
  1685. <td>
  1686. <code>type</code></br>
  1687. <em>
  1688. <a href="#external-secrets.io/v1alpha1.ExternalSecretConditionType">
  1689. ExternalSecretConditionType
  1690. </a>
  1691. </em>
  1692. </td>
  1693. <td>
  1694. </td>
  1695. </tr>
  1696. <tr>
  1697. <td>
  1698. <code>status</code></br>
  1699. <em>
  1700. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  1701. Kubernetes core/v1.ConditionStatus
  1702. </a>
  1703. </em>
  1704. </td>
  1705. <td>
  1706. </td>
  1707. </tr>
  1708. <tr>
  1709. <td>
  1710. <code>reason</code></br>
  1711. <em>
  1712. string
  1713. </em>
  1714. </td>
  1715. <td>
  1716. <em>(Optional)</em>
  1717. </td>
  1718. </tr>
  1719. <tr>
  1720. <td>
  1721. <code>message</code></br>
  1722. <em>
  1723. string
  1724. </em>
  1725. </td>
  1726. <td>
  1727. <em>(Optional)</em>
  1728. </td>
  1729. </tr>
  1730. <tr>
  1731. <td>
  1732. <code>lastTransitionTime</code></br>
  1733. <em>
  1734. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1735. Kubernetes meta/v1.Time
  1736. </a>
  1737. </em>
  1738. </td>
  1739. <td>
  1740. <em>(Optional)</em>
  1741. </td>
  1742. </tr>
  1743. </tbody>
  1744. </table>
  1745. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget
  1746. </h3>
  1747. <p>
  1748. (<em>Appears on:</em>
  1749. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1750. </p>
  1751. <p>
  1752. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  1753. There can be only one target per ExternalSecret.</p>
  1754. </p>
  1755. <table>
  1756. <thead>
  1757. <tr>
  1758. <th>Field</th>
  1759. <th>Description</th>
  1760. </tr>
  1761. </thead>
  1762. <tbody>
  1763. <tr>
  1764. <td>
  1765. <code>name</code></br>
  1766. <em>
  1767. string
  1768. </em>
  1769. </td>
  1770. <td>
  1771. <em>(Optional)</em>
  1772. <p>Name defines the name of the Secret resource to be managed
  1773. This field is immutable
  1774. Defaults to the .metadata.name of the ExternalSecret resource</p>
  1775. </td>
  1776. </tr>
  1777. <tr>
  1778. <td>
  1779. <code>creationPolicy</code></br>
  1780. <em>
  1781. <a href="#external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">
  1782. ExternalSecretCreationPolicy
  1783. </a>
  1784. </em>
  1785. </td>
  1786. <td>
  1787. <em>(Optional)</em>
  1788. <p>CreationPolicy defines rules on how to create the resulting Secret
  1789. Defaults to &lsquo;Owner&rsquo;</p>
  1790. </td>
  1791. </tr>
  1792. <tr>
  1793. <td>
  1794. <code>template</code></br>
  1795. <em>
  1796. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">
  1797. ExternalSecretTemplate
  1798. </a>
  1799. </em>
  1800. </td>
  1801. <td>
  1802. <em>(Optional)</em>
  1803. <p>Template defines a blueprint for the created Secret resource.</p>
  1804. </td>
  1805. </tr>
  1806. <tr>
  1807. <td>
  1808. <code>immutable</code></br>
  1809. <em>
  1810. bool
  1811. </em>
  1812. </td>
  1813. <td>
  1814. <em>(Optional)</em>
  1815. <p>Immutable defines if the final secret will be immutable</p>
  1816. </td>
  1817. </tr>
  1818. </tbody>
  1819. </table>
  1820. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate
  1821. </h3>
  1822. <p>
  1823. (<em>Appears on:</em>
  1824. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  1825. </p>
  1826. <p>
  1827. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  1828. 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>
  1829. </p>
  1830. <table>
  1831. <thead>
  1832. <tr>
  1833. <th>Field</th>
  1834. <th>Description</th>
  1835. </tr>
  1836. </thead>
  1837. <tbody>
  1838. <tr>
  1839. <td>
  1840. <code>type</code></br>
  1841. <em>
  1842. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secrettype-v1-core">
  1843. Kubernetes core/v1.SecretType
  1844. </a>
  1845. </em>
  1846. </td>
  1847. <td>
  1848. <em>(Optional)</em>
  1849. </td>
  1850. </tr>
  1851. <tr>
  1852. <td>
  1853. <code>metadata</code></br>
  1854. <em>
  1855. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">
  1856. ExternalSecretTemplateMetadata
  1857. </a>
  1858. </em>
  1859. </td>
  1860. <td>
  1861. <em>(Optional)</em>
  1862. </td>
  1863. </tr>
  1864. <tr>
  1865. <td>
  1866. <code>data</code></br>
  1867. <em>
  1868. map[string]string
  1869. </em>
  1870. </td>
  1871. <td>
  1872. <em>(Optional)</em>
  1873. </td>
  1874. </tr>
  1875. <tr>
  1876. <td>
  1877. <code>templateFrom</code></br>
  1878. <em>
  1879. <a href="#external-secrets.io/v1alpha1.TemplateFrom">
  1880. []TemplateFrom
  1881. </a>
  1882. </em>
  1883. </td>
  1884. <td>
  1885. <em>(Optional)</em>
  1886. </td>
  1887. </tr>
  1888. </tbody>
  1889. </table>
  1890. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  1891. </h3>
  1892. <p>
  1893. (<em>Appears on:</em>
  1894. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  1895. </p>
  1896. <p>
  1897. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  1898. </p>
  1899. <table>
  1900. <thead>
  1901. <tr>
  1902. <th>Field</th>
  1903. <th>Description</th>
  1904. </tr>
  1905. </thead>
  1906. <tbody>
  1907. <tr>
  1908. <td>
  1909. <code>annotations</code></br>
  1910. <em>
  1911. map[string]string
  1912. </em>
  1913. </td>
  1914. <td>
  1915. <em>(Optional)</em>
  1916. </td>
  1917. </tr>
  1918. <tr>
  1919. <td>
  1920. <code>labels</code></br>
  1921. <em>
  1922. map[string]string
  1923. </em>
  1924. </td>
  1925. <td>
  1926. <em>(Optional)</em>
  1927. </td>
  1928. </tr>
  1929. </tbody>
  1930. </table>
  1931. <h3 id="external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth
  1932. </h3>
  1933. <p>
  1934. (<em>Appears on:</em>
  1935. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider</a>)
  1936. </p>
  1937. <p>
  1938. </p>
  1939. <table>
  1940. <thead>
  1941. <tr>
  1942. <th>Field</th>
  1943. <th>Description</th>
  1944. </tr>
  1945. </thead>
  1946. <tbody>
  1947. <tr>
  1948. <td>
  1949. <code>secretRef</code></br>
  1950. <em>
  1951. <a href="#external-secrets.io/v1alpha1.GCPSMAuthSecretRef">
  1952. GCPSMAuthSecretRef
  1953. </a>
  1954. </em>
  1955. </td>
  1956. <td>
  1957. </td>
  1958. </tr>
  1959. </tbody>
  1960. </table>
  1961. <h3 id="external-secrets.io/v1alpha1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  1962. </h3>
  1963. <p>
  1964. (<em>Appears on:</em>
  1965. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth</a>)
  1966. </p>
  1967. <p>
  1968. </p>
  1969. <table>
  1970. <thead>
  1971. <tr>
  1972. <th>Field</th>
  1973. <th>Description</th>
  1974. </tr>
  1975. </thead>
  1976. <tbody>
  1977. <tr>
  1978. <td>
  1979. <code>secretAccessKeySecretRef</code></br>
  1980. <em>
  1981. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1982. </em>
  1983. </td>
  1984. <td>
  1985. <em>(Optional)</em>
  1986. <p>The SecretAccessKey is used for authentication</p>
  1987. </td>
  1988. </tr>
  1989. </tbody>
  1990. </table>
  1991. <h3 id="external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider
  1992. </h3>
  1993. <p>
  1994. (<em>Appears on:</em>
  1995. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  1996. </p>
  1997. <p>
  1998. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  1999. </p>
  2000. <table>
  2001. <thead>
  2002. <tr>
  2003. <th>Field</th>
  2004. <th>Description</th>
  2005. </tr>
  2006. </thead>
  2007. <tbody>
  2008. <tr>
  2009. <td>
  2010. <code>auth</code></br>
  2011. <em>
  2012. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">
  2013. GCPSMAuth
  2014. </a>
  2015. </em>
  2016. </td>
  2017. <td>
  2018. <em>(Optional)</em>
  2019. <p>Auth defines the information necessary to authenticate against GCP</p>
  2020. </td>
  2021. </tr>
  2022. <tr>
  2023. <td>
  2024. <code>projectID</code></br>
  2025. <em>
  2026. string
  2027. </em>
  2028. </td>
  2029. <td>
  2030. <p>ProjectID project where secret is located</p>
  2031. </td>
  2032. </tr>
  2033. </tbody>
  2034. </table>
  2035. <h3 id="external-secrets.io/v1alpha1.GenericStore">GenericStore
  2036. </h3>
  2037. <p>
  2038. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  2039. or a namespaced SecretStore.</p>
  2040. </p>
  2041. <h3 id="external-secrets.io/v1alpha1.GitlabAuth">GitlabAuth
  2042. </h3>
  2043. <p>
  2044. (<em>Appears on:</em>
  2045. <a href="#external-secrets.io/v1alpha1.GitlabProvider">GitlabProvider</a>)
  2046. </p>
  2047. <p>
  2048. </p>
  2049. <table>
  2050. <thead>
  2051. <tr>
  2052. <th>Field</th>
  2053. <th>Description</th>
  2054. </tr>
  2055. </thead>
  2056. <tbody>
  2057. <tr>
  2058. <td>
  2059. <code>SecretRef</code></br>
  2060. <em>
  2061. <a href="#external-secrets.io/v1alpha1.GitlabSecretRef">
  2062. GitlabSecretRef
  2063. </a>
  2064. </em>
  2065. </td>
  2066. <td>
  2067. </td>
  2068. </tr>
  2069. </tbody>
  2070. </table>
  2071. <h3 id="external-secrets.io/v1alpha1.GitlabProvider">GitlabProvider
  2072. </h3>
  2073. <p>
  2074. (<em>Appears on:</em>
  2075. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2076. </p>
  2077. <p>
  2078. <p>Configures a store to sync secrets with a GitLab instance.</p>
  2079. </p>
  2080. <table>
  2081. <thead>
  2082. <tr>
  2083. <th>Field</th>
  2084. <th>Description</th>
  2085. </tr>
  2086. </thead>
  2087. <tbody>
  2088. <tr>
  2089. <td>
  2090. <code>url</code></br>
  2091. <em>
  2092. string
  2093. </em>
  2094. </td>
  2095. <td>
  2096. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
  2097. </td>
  2098. </tr>
  2099. <tr>
  2100. <td>
  2101. <code>auth</code></br>
  2102. <em>
  2103. <a href="#external-secrets.io/v1alpha1.GitlabAuth">
  2104. GitlabAuth
  2105. </a>
  2106. </em>
  2107. </td>
  2108. <td>
  2109. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
  2110. </td>
  2111. </tr>
  2112. <tr>
  2113. <td>
  2114. <code>projectID</code></br>
  2115. <em>
  2116. string
  2117. </em>
  2118. </td>
  2119. <td>
  2120. <p>ProjectID specifies a project where secrets are located.</p>
  2121. </td>
  2122. </tr>
  2123. </tbody>
  2124. </table>
  2125. <h3 id="external-secrets.io/v1alpha1.GitlabSecretRef">GitlabSecretRef
  2126. </h3>
  2127. <p>
  2128. (<em>Appears on:</em>
  2129. <a href="#external-secrets.io/v1alpha1.GitlabAuth">GitlabAuth</a>)
  2130. </p>
  2131. <p>
  2132. </p>
  2133. <table>
  2134. <thead>
  2135. <tr>
  2136. <th>Field</th>
  2137. <th>Description</th>
  2138. </tr>
  2139. </thead>
  2140. <tbody>
  2141. <tr>
  2142. <td>
  2143. <code>accessToken</code></br>
  2144. <em>
  2145. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2146. </em>
  2147. </td>
  2148. <td>
  2149. <p>AccessToken is used for authentication.</p>
  2150. </td>
  2151. </tr>
  2152. </tbody>
  2153. </table>
  2154. <h3 id="external-secrets.io/v1alpha1.IBMAuth">IBMAuth
  2155. </h3>
  2156. <p>
  2157. (<em>Appears on:</em>
  2158. <a href="#external-secrets.io/v1alpha1.IBMProvider">IBMProvider</a>)
  2159. </p>
  2160. <p>
  2161. </p>
  2162. <table>
  2163. <thead>
  2164. <tr>
  2165. <th>Field</th>
  2166. <th>Description</th>
  2167. </tr>
  2168. </thead>
  2169. <tbody>
  2170. <tr>
  2171. <td>
  2172. <code>secretRef</code></br>
  2173. <em>
  2174. <a href="#external-secrets.io/v1alpha1.IBMAuthSecretRef">
  2175. IBMAuthSecretRef
  2176. </a>
  2177. </em>
  2178. </td>
  2179. <td>
  2180. </td>
  2181. </tr>
  2182. </tbody>
  2183. </table>
  2184. <h3 id="external-secrets.io/v1alpha1.IBMAuthSecretRef">IBMAuthSecretRef
  2185. </h3>
  2186. <p>
  2187. (<em>Appears on:</em>
  2188. <a href="#external-secrets.io/v1alpha1.IBMAuth">IBMAuth</a>)
  2189. </p>
  2190. <p>
  2191. </p>
  2192. <table>
  2193. <thead>
  2194. <tr>
  2195. <th>Field</th>
  2196. <th>Description</th>
  2197. </tr>
  2198. </thead>
  2199. <tbody>
  2200. <tr>
  2201. <td>
  2202. <code>secretApiKeySecretRef</code></br>
  2203. <em>
  2204. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2205. </em>
  2206. </td>
  2207. <td>
  2208. <em>(Optional)</em>
  2209. <p>The SecretAccessKey is used for authentication</p>
  2210. </td>
  2211. </tr>
  2212. </tbody>
  2213. </table>
  2214. <h3 id="external-secrets.io/v1alpha1.IBMProvider">IBMProvider
  2215. </h3>
  2216. <p>
  2217. (<em>Appears on:</em>
  2218. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2219. </p>
  2220. <p>
  2221. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
  2222. backend.</p>
  2223. </p>
  2224. <table>
  2225. <thead>
  2226. <tr>
  2227. <th>Field</th>
  2228. <th>Description</th>
  2229. </tr>
  2230. </thead>
  2231. <tbody>
  2232. <tr>
  2233. <td>
  2234. <code>auth</code></br>
  2235. <em>
  2236. <a href="#external-secrets.io/v1alpha1.IBMAuth">
  2237. IBMAuth
  2238. </a>
  2239. </em>
  2240. </td>
  2241. <td>
  2242. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
  2243. </td>
  2244. </tr>
  2245. <tr>
  2246. <td>
  2247. <code>serviceUrl</code></br>
  2248. <em>
  2249. string
  2250. </em>
  2251. </td>
  2252. <td>
  2253. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
  2254. </td>
  2255. </tr>
  2256. </tbody>
  2257. </table>
  2258. <h3 id="external-secrets.io/v1alpha1.OracleAuth">OracleAuth
  2259. </h3>
  2260. <p>
  2261. (<em>Appears on:</em>
  2262. <a href="#external-secrets.io/v1alpha1.OracleProvider">OracleProvider</a>)
  2263. </p>
  2264. <p>
  2265. </p>
  2266. <table>
  2267. <thead>
  2268. <tr>
  2269. <th>Field</th>
  2270. <th>Description</th>
  2271. </tr>
  2272. </thead>
  2273. <tbody>
  2274. <tr>
  2275. <td>
  2276. <code>secretRef</code></br>
  2277. <em>
  2278. <a href="#external-secrets.io/v1alpha1.OracleSecretRef">
  2279. OracleSecretRef
  2280. </a>
  2281. </em>
  2282. </td>
  2283. <td>
  2284. <p>SecretRef to pass through sensitive information.</p>
  2285. </td>
  2286. </tr>
  2287. </tbody>
  2288. </table>
  2289. <h3 id="external-secrets.io/v1alpha1.OracleProvider">OracleProvider
  2290. </h3>
  2291. <p>
  2292. (<em>Appears on:</em>
  2293. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2294. </p>
  2295. <p>
  2296. <p>Configures an store to sync secrets using a Oracle Vault
  2297. backend.</p>
  2298. </p>
  2299. <table>
  2300. <thead>
  2301. <tr>
  2302. <th>Field</th>
  2303. <th>Description</th>
  2304. </tr>
  2305. </thead>
  2306. <tbody>
  2307. <tr>
  2308. <td>
  2309. <code>auth</code></br>
  2310. <em>
  2311. <a href="#external-secrets.io/v1alpha1.OracleAuth">
  2312. OracleAuth
  2313. </a>
  2314. </em>
  2315. </td>
  2316. <td>
  2317. <p>Auth configures how secret-manager authenticates with the Oracle Vault.</p>
  2318. </td>
  2319. </tr>
  2320. <tr>
  2321. <td>
  2322. <code>user</code></br>
  2323. <em>
  2324. string
  2325. </em>
  2326. </td>
  2327. <td>
  2328. <p>User is an access OCID specific to the account.</p>
  2329. </td>
  2330. </tr>
  2331. <tr>
  2332. <td>
  2333. <code>tenancy</code></br>
  2334. <em>
  2335. string
  2336. </em>
  2337. </td>
  2338. <td>
  2339. <p>projectID is an access token specific to the secret.</p>
  2340. </td>
  2341. </tr>
  2342. <tr>
  2343. <td>
  2344. <code>region</code></br>
  2345. <em>
  2346. string
  2347. </em>
  2348. </td>
  2349. <td>
  2350. <p>projectID is an access token specific to the secret.</p>
  2351. </td>
  2352. </tr>
  2353. </tbody>
  2354. </table>
  2355. <h3 id="external-secrets.io/v1alpha1.OracleSecretRef">OracleSecretRef
  2356. </h3>
  2357. <p>
  2358. (<em>Appears on:</em>
  2359. <a href="#external-secrets.io/v1alpha1.OracleAuth">OracleAuth</a>)
  2360. </p>
  2361. <p>
  2362. </p>
  2363. <table>
  2364. <thead>
  2365. <tr>
  2366. <th>Field</th>
  2367. <th>Description</th>
  2368. </tr>
  2369. </thead>
  2370. <tbody>
  2371. <tr>
  2372. <td>
  2373. <code>privatekey</code></br>
  2374. <em>
  2375. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2376. </em>
  2377. </td>
  2378. <td>
  2379. <p>The Access Token is used for authentication</p>
  2380. </td>
  2381. </tr>
  2382. <tr>
  2383. <td>
  2384. <code>fingerprint</code></br>
  2385. <em>
  2386. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2387. </em>
  2388. </td>
  2389. <td>
  2390. <p>projectID is an access token specific to the secret.</p>
  2391. </td>
  2392. </tr>
  2393. </tbody>
  2394. </table>
  2395. <h3 id="external-secrets.io/v1alpha1.SecretStore">SecretStore
  2396. </h3>
  2397. <p>
  2398. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  2399. </p>
  2400. <table>
  2401. <thead>
  2402. <tr>
  2403. <th>Field</th>
  2404. <th>Description</th>
  2405. </tr>
  2406. </thead>
  2407. <tbody>
  2408. <tr>
  2409. <td>
  2410. <code>metadata</code></br>
  2411. <em>
  2412. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  2413. Kubernetes meta/v1.ObjectMeta
  2414. </a>
  2415. </em>
  2416. </td>
  2417. <td>
  2418. Refer to the Kubernetes API documentation for the fields of the
  2419. <code>metadata</code> field.
  2420. </td>
  2421. </tr>
  2422. <tr>
  2423. <td>
  2424. <code>spec</code></br>
  2425. <em>
  2426. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  2427. SecretStoreSpec
  2428. </a>
  2429. </em>
  2430. </td>
  2431. <td>
  2432. <br/>
  2433. <br/>
  2434. <table>
  2435. <tr>
  2436. <td>
  2437. <code>controller</code></br>
  2438. <em>
  2439. string
  2440. </em>
  2441. </td>
  2442. <td>
  2443. <em>(Optional)</em>
  2444. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  2445. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  2446. </td>
  2447. </tr>
  2448. <tr>
  2449. <td>
  2450. <code>provider</code></br>
  2451. <em>
  2452. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  2453. SecretStoreProvider
  2454. </a>
  2455. </em>
  2456. </td>
  2457. <td>
  2458. <p>Used to configure the provider. Only one provider may be set</p>
  2459. </td>
  2460. </tr>
  2461. <tr>
  2462. <td>
  2463. <code>retrySettings</code></br>
  2464. <em>
  2465. <a href="#external-secrets.io/v1alpha1.SecretStoreRetrySettings">
  2466. SecretStoreRetrySettings
  2467. </a>
  2468. </em>
  2469. </td>
  2470. <td>
  2471. <em>(Optional)</em>
  2472. <p>Used to configure http retries if failed</p>
  2473. </td>
  2474. </tr>
  2475. </table>
  2476. </td>
  2477. </tr>
  2478. <tr>
  2479. <td>
  2480. <code>status</code></br>
  2481. <em>
  2482. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  2483. SecretStoreStatus
  2484. </a>
  2485. </em>
  2486. </td>
  2487. <td>
  2488. </td>
  2489. </tr>
  2490. </tbody>
  2491. </table>
  2492. <h3 id="external-secrets.io/v1alpha1.SecretStoreConditionType">SecretStoreConditionType
  2493. (<code>string</code> alias)</p></h3>
  2494. <p>
  2495. (<em>Appears on:</em>
  2496. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  2497. </p>
  2498. <p>
  2499. </p>
  2500. <table>
  2501. <thead>
  2502. <tr>
  2503. <th>Value</th>
  2504. <th>Description</th>
  2505. </tr>
  2506. </thead>
  2507. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  2508. <td></td>
  2509. </tr></tbody>
  2510. </table>
  2511. <h3 id="external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider
  2512. </h3>
  2513. <p>
  2514. (<em>Appears on:</em>
  2515. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec</a>)
  2516. </p>
  2517. <p>
  2518. <p>SecretStoreProvider contains the provider-specific configration.</p>
  2519. </p>
  2520. <table>
  2521. <thead>
  2522. <tr>
  2523. <th>Field</th>
  2524. <th>Description</th>
  2525. </tr>
  2526. </thead>
  2527. <tbody>
  2528. <tr>
  2529. <td>
  2530. <code>aws</code></br>
  2531. <em>
  2532. <a href="#external-secrets.io/v1alpha1.AWSProvider">
  2533. AWSProvider
  2534. </a>
  2535. </em>
  2536. </td>
  2537. <td>
  2538. <em>(Optional)</em>
  2539. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  2540. </td>
  2541. </tr>
  2542. <tr>
  2543. <td>
  2544. <code>azurekv</code></br>
  2545. <em>
  2546. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">
  2547. AzureKVProvider
  2548. </a>
  2549. </em>
  2550. </td>
  2551. <td>
  2552. <em>(Optional)</em>
  2553. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  2554. </td>
  2555. </tr>
  2556. <tr>
  2557. <td>
  2558. <code>akeyless</code></br>
  2559. <em>
  2560. <a href="#external-secrets.io/v1alpha1.AkeylessProvider">
  2561. AkeylessProvider
  2562. </a>
  2563. </em>
  2564. </td>
  2565. <td>
  2566. <em>(Optional)</em>
  2567. <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
  2568. </td>
  2569. </tr>
  2570. <tr>
  2571. <td>
  2572. <code>vault</code></br>
  2573. <em>
  2574. <a href="#external-secrets.io/v1alpha1.VaultProvider">
  2575. VaultProvider
  2576. </a>
  2577. </em>
  2578. </td>
  2579. <td>
  2580. <em>(Optional)</em>
  2581. <p>Vault configures this store to sync secrets using Hashi provider</p>
  2582. </td>
  2583. </tr>
  2584. <tr>
  2585. <td>
  2586. <code>gcpsm</code></br>
  2587. <em>
  2588. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">
  2589. GCPSMProvider
  2590. </a>
  2591. </em>
  2592. </td>
  2593. <td>
  2594. <em>(Optional)</em>
  2595. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  2596. </td>
  2597. </tr>
  2598. <tr>
  2599. <td>
  2600. <code>oracle</code></br>
  2601. <em>
  2602. <a href="#external-secrets.io/v1alpha1.OracleProvider">
  2603. OracleProvider
  2604. </a>
  2605. </em>
  2606. </td>
  2607. <td>
  2608. <em>(Optional)</em>
  2609. <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
  2610. </td>
  2611. </tr>
  2612. <tr>
  2613. <td>
  2614. <code>ibm</code></br>
  2615. <em>
  2616. <a href="#external-secrets.io/v1alpha1.IBMProvider">
  2617. IBMProvider
  2618. </a>
  2619. </em>
  2620. </td>
  2621. <td>
  2622. <em>(Optional)</em>
  2623. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
  2624. </td>
  2625. </tr>
  2626. <tr>
  2627. <td>
  2628. <code>yandexlockbox</code></br>
  2629. <em>
  2630. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">
  2631. YandexLockboxProvider
  2632. </a>
  2633. </em>
  2634. </td>
  2635. <td>
  2636. <em>(Optional)</em>
  2637. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
  2638. </td>
  2639. </tr>
  2640. <tr>
  2641. <td>
  2642. <code>gitlab</code></br>
  2643. <em>
  2644. <a href="#external-secrets.io/v1alpha1.GitlabProvider">
  2645. GitlabProvider
  2646. </a>
  2647. </em>
  2648. </td>
  2649. <td>
  2650. <em>(Optional)</em>
  2651. <p>GItlab configures this store to sync secrets using Gitlab Variables provider</p>
  2652. </td>
  2653. </tr>
  2654. <tr>
  2655. <td>
  2656. <code>alibaba</code></br>
  2657. <em>
  2658. <a href="#external-secrets.io/v1alpha1.AlibabaProvider">
  2659. AlibabaProvider
  2660. </a>
  2661. </em>
  2662. </td>
  2663. <td>
  2664. <em>(Optional)</em>
  2665. <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
  2666. </td>
  2667. </tr>
  2668. </tbody>
  2669. </table>
  2670. <h3 id="external-secrets.io/v1alpha1.SecretStoreRef">SecretStoreRef
  2671. </h3>
  2672. <p>
  2673. (<em>Appears on:</em>
  2674. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2675. </p>
  2676. <p>
  2677. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  2678. </p>
  2679. <table>
  2680. <thead>
  2681. <tr>
  2682. <th>Field</th>
  2683. <th>Description</th>
  2684. </tr>
  2685. </thead>
  2686. <tbody>
  2687. <tr>
  2688. <td>
  2689. <code>name</code></br>
  2690. <em>
  2691. string
  2692. </em>
  2693. </td>
  2694. <td>
  2695. <p>Name of the SecretStore resource</p>
  2696. </td>
  2697. </tr>
  2698. <tr>
  2699. <td>
  2700. <code>kind</code></br>
  2701. <em>
  2702. string
  2703. </em>
  2704. </td>
  2705. <td>
  2706. <em>(Optional)</em>
  2707. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  2708. Defaults to <code>SecretStore</code></p>
  2709. </td>
  2710. </tr>
  2711. </tbody>
  2712. </table>
  2713. <h3 id="external-secrets.io/v1alpha1.SecretStoreRetrySettings">SecretStoreRetrySettings
  2714. </h3>
  2715. <p>
  2716. (<em>Appears on:</em>
  2717. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec</a>)
  2718. </p>
  2719. <p>
  2720. </p>
  2721. <table>
  2722. <thead>
  2723. <tr>
  2724. <th>Field</th>
  2725. <th>Description</th>
  2726. </tr>
  2727. </thead>
  2728. <tbody>
  2729. <tr>
  2730. <td>
  2731. <code>maxRetries</code></br>
  2732. <em>
  2733. int32
  2734. </em>
  2735. </td>
  2736. <td>
  2737. </td>
  2738. </tr>
  2739. <tr>
  2740. <td>
  2741. <code>retryInterval</code></br>
  2742. <em>
  2743. string
  2744. </em>
  2745. </td>
  2746. <td>
  2747. </td>
  2748. </tr>
  2749. </tbody>
  2750. </table>
  2751. <h3 id="external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec
  2752. </h3>
  2753. <p>
  2754. (<em>Appears on:</em>
  2755. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  2756. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  2757. </p>
  2758. <p>
  2759. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  2760. </p>
  2761. <table>
  2762. <thead>
  2763. <tr>
  2764. <th>Field</th>
  2765. <th>Description</th>
  2766. </tr>
  2767. </thead>
  2768. <tbody>
  2769. <tr>
  2770. <td>
  2771. <code>controller</code></br>
  2772. <em>
  2773. string
  2774. </em>
  2775. </td>
  2776. <td>
  2777. <em>(Optional)</em>
  2778. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  2779. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  2780. </td>
  2781. </tr>
  2782. <tr>
  2783. <td>
  2784. <code>provider</code></br>
  2785. <em>
  2786. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  2787. SecretStoreProvider
  2788. </a>
  2789. </em>
  2790. </td>
  2791. <td>
  2792. <p>Used to configure the provider. Only one provider may be set</p>
  2793. </td>
  2794. </tr>
  2795. <tr>
  2796. <td>
  2797. <code>retrySettings</code></br>
  2798. <em>
  2799. <a href="#external-secrets.io/v1alpha1.SecretStoreRetrySettings">
  2800. SecretStoreRetrySettings
  2801. </a>
  2802. </em>
  2803. </td>
  2804. <td>
  2805. <em>(Optional)</em>
  2806. <p>Used to configure http retries if failed</p>
  2807. </td>
  2808. </tr>
  2809. </tbody>
  2810. </table>
  2811. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus
  2812. </h3>
  2813. <p>
  2814. (<em>Appears on:</em>
  2815. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  2816. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  2817. </p>
  2818. <p>
  2819. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  2820. </p>
  2821. <table>
  2822. <thead>
  2823. <tr>
  2824. <th>Field</th>
  2825. <th>Description</th>
  2826. </tr>
  2827. </thead>
  2828. <tbody>
  2829. <tr>
  2830. <td>
  2831. <code>conditions</code></br>
  2832. <em>
  2833. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">
  2834. []SecretStoreStatusCondition
  2835. </a>
  2836. </em>
  2837. </td>
  2838. <td>
  2839. <em>(Optional)</em>
  2840. </td>
  2841. </tr>
  2842. </tbody>
  2843. </table>
  2844. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition
  2845. </h3>
  2846. <p>
  2847. (<em>Appears on:</em>
  2848. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus</a>)
  2849. </p>
  2850. <p>
  2851. </p>
  2852. <table>
  2853. <thead>
  2854. <tr>
  2855. <th>Field</th>
  2856. <th>Description</th>
  2857. </tr>
  2858. </thead>
  2859. <tbody>
  2860. <tr>
  2861. <td>
  2862. <code>type</code></br>
  2863. <em>
  2864. <a href="#external-secrets.io/v1alpha1.SecretStoreConditionType">
  2865. SecretStoreConditionType
  2866. </a>
  2867. </em>
  2868. </td>
  2869. <td>
  2870. </td>
  2871. </tr>
  2872. <tr>
  2873. <td>
  2874. <code>status</code></br>
  2875. <em>
  2876. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  2877. Kubernetes core/v1.ConditionStatus
  2878. </a>
  2879. </em>
  2880. </td>
  2881. <td>
  2882. </td>
  2883. </tr>
  2884. <tr>
  2885. <td>
  2886. <code>reason</code></br>
  2887. <em>
  2888. string
  2889. </em>
  2890. </td>
  2891. <td>
  2892. <em>(Optional)</em>
  2893. </td>
  2894. </tr>
  2895. <tr>
  2896. <td>
  2897. <code>message</code></br>
  2898. <em>
  2899. string
  2900. </em>
  2901. </td>
  2902. <td>
  2903. <em>(Optional)</em>
  2904. </td>
  2905. </tr>
  2906. <tr>
  2907. <td>
  2908. <code>lastTransitionTime</code></br>
  2909. <em>
  2910. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  2911. Kubernetes meta/v1.Time
  2912. </a>
  2913. </em>
  2914. </td>
  2915. <td>
  2916. <em>(Optional)</em>
  2917. </td>
  2918. </tr>
  2919. </tbody>
  2920. </table>
  2921. <h3 id="external-secrets.io/v1alpha1.TemplateFrom">TemplateFrom
  2922. </h3>
  2923. <p>
  2924. (<em>Appears on:</em>
  2925. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  2926. </p>
  2927. <p>
  2928. </p>
  2929. <table>
  2930. <thead>
  2931. <tr>
  2932. <th>Field</th>
  2933. <th>Description</th>
  2934. </tr>
  2935. </thead>
  2936. <tbody>
  2937. <tr>
  2938. <td>
  2939. <code>configMap</code></br>
  2940. <em>
  2941. <a href="#external-secrets.io/v1alpha1.TemplateRef">
  2942. TemplateRef
  2943. </a>
  2944. </em>
  2945. </td>
  2946. <td>
  2947. </td>
  2948. </tr>
  2949. <tr>
  2950. <td>
  2951. <code>secret</code></br>
  2952. <em>
  2953. <a href="#external-secrets.io/v1alpha1.TemplateRef">
  2954. TemplateRef
  2955. </a>
  2956. </em>
  2957. </td>
  2958. <td>
  2959. </td>
  2960. </tr>
  2961. </tbody>
  2962. </table>
  2963. <h3 id="external-secrets.io/v1alpha1.TemplateRef">TemplateRef
  2964. </h3>
  2965. <p>
  2966. (<em>Appears on:</em>
  2967. <a href="#external-secrets.io/v1alpha1.TemplateFrom">TemplateFrom</a>)
  2968. </p>
  2969. <p>
  2970. </p>
  2971. <table>
  2972. <thead>
  2973. <tr>
  2974. <th>Field</th>
  2975. <th>Description</th>
  2976. </tr>
  2977. </thead>
  2978. <tbody>
  2979. <tr>
  2980. <td>
  2981. <code>name</code></br>
  2982. <em>
  2983. string
  2984. </em>
  2985. </td>
  2986. <td>
  2987. </td>
  2988. </tr>
  2989. <tr>
  2990. <td>
  2991. <code>items</code></br>
  2992. <em>
  2993. <a href="#external-secrets.io/v1alpha1.TemplateRefItem">
  2994. []TemplateRefItem
  2995. </a>
  2996. </em>
  2997. </td>
  2998. <td>
  2999. </td>
  3000. </tr>
  3001. </tbody>
  3002. </table>
  3003. <h3 id="external-secrets.io/v1alpha1.TemplateRefItem">TemplateRefItem
  3004. </h3>
  3005. <p>
  3006. (<em>Appears on:</em>
  3007. <a href="#external-secrets.io/v1alpha1.TemplateRef">TemplateRef</a>)
  3008. </p>
  3009. <p>
  3010. </p>
  3011. <table>
  3012. <thead>
  3013. <tr>
  3014. <th>Field</th>
  3015. <th>Description</th>
  3016. </tr>
  3017. </thead>
  3018. <tbody>
  3019. <tr>
  3020. <td>
  3021. <code>key</code></br>
  3022. <em>
  3023. string
  3024. </em>
  3025. </td>
  3026. <td>
  3027. </td>
  3028. </tr>
  3029. </tbody>
  3030. </table>
  3031. <h3 id="external-secrets.io/v1alpha1.VaultAppRole">VaultAppRole
  3032. </h3>
  3033. <p>
  3034. (<em>Appears on:</em>
  3035. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  3036. </p>
  3037. <p>
  3038. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  3039. with the role and secret stored in a Kubernetes Secret resource.</p>
  3040. </p>
  3041. <table>
  3042. <thead>
  3043. <tr>
  3044. <th>Field</th>
  3045. <th>Description</th>
  3046. </tr>
  3047. </thead>
  3048. <tbody>
  3049. <tr>
  3050. <td>
  3051. <code>path</code></br>
  3052. <em>
  3053. string
  3054. </em>
  3055. </td>
  3056. <td>
  3057. <p>Path where the App Role authentication backend is mounted
  3058. in Vault, e.g: &ldquo;approle&rdquo;</p>
  3059. </td>
  3060. </tr>
  3061. <tr>
  3062. <td>
  3063. <code>roleId</code></br>
  3064. <em>
  3065. string
  3066. </em>
  3067. </td>
  3068. <td>
  3069. <p>RoleID configured in the App Role authentication backend when setting
  3070. up the authentication backend in Vault.</p>
  3071. </td>
  3072. </tr>
  3073. <tr>
  3074. <td>
  3075. <code>secretRef</code></br>
  3076. <em>
  3077. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3078. </em>
  3079. </td>
  3080. <td>
  3081. <p>Reference to a key in a Secret that contains the App Role secret used
  3082. to authenticate with Vault.
  3083. The <code>key</code> field must be specified and denotes which entry within the Secret
  3084. resource is used as the app role secret.</p>
  3085. </td>
  3086. </tr>
  3087. </tbody>
  3088. </table>
  3089. <h3 id="external-secrets.io/v1alpha1.VaultAuth">VaultAuth
  3090. </h3>
  3091. <p>
  3092. (<em>Appears on:</em>
  3093. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  3094. </p>
  3095. <p>
  3096. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  3097. Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>jwt</code> or <code>cert</code>
  3098. can be specified.</p>
  3099. </p>
  3100. <table>
  3101. <thead>
  3102. <tr>
  3103. <th>Field</th>
  3104. <th>Description</th>
  3105. </tr>
  3106. </thead>
  3107. <tbody>
  3108. <tr>
  3109. <td>
  3110. <code>tokenSecretRef</code></br>
  3111. <em>
  3112. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3113. </em>
  3114. </td>
  3115. <td>
  3116. <em>(Optional)</em>
  3117. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  3118. </td>
  3119. </tr>
  3120. <tr>
  3121. <td>
  3122. <code>appRole</code></br>
  3123. <em>
  3124. <a href="#external-secrets.io/v1alpha1.VaultAppRole">
  3125. VaultAppRole
  3126. </a>
  3127. </em>
  3128. </td>
  3129. <td>
  3130. <em>(Optional)</em>
  3131. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  3132. with the role and secret stored in a Kubernetes Secret resource.</p>
  3133. </td>
  3134. </tr>
  3135. <tr>
  3136. <td>
  3137. <code>kubernetes</code></br>
  3138. <em>
  3139. <a href="#external-secrets.io/v1alpha1.VaultKubernetesAuth">
  3140. VaultKubernetesAuth
  3141. </a>
  3142. </em>
  3143. </td>
  3144. <td>
  3145. <em>(Optional)</em>
  3146. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  3147. token stored in the named Secret resource to the Vault server.</p>
  3148. </td>
  3149. </tr>
  3150. <tr>
  3151. <td>
  3152. <code>ldap</code></br>
  3153. <em>
  3154. <a href="#external-secrets.io/v1alpha1.VaultLdapAuth">
  3155. VaultLdapAuth
  3156. </a>
  3157. </em>
  3158. </td>
  3159. <td>
  3160. <em>(Optional)</em>
  3161. <p>Ldap authenticates with Vault by passing username/password pair using
  3162. the LDAP authentication method</p>
  3163. </td>
  3164. </tr>
  3165. <tr>
  3166. <td>
  3167. <code>jwt</code></br>
  3168. <em>
  3169. <a href="#external-secrets.io/v1alpha1.VaultJwtAuth">
  3170. VaultJwtAuth
  3171. </a>
  3172. </em>
  3173. </td>
  3174. <td>
  3175. <em>(Optional)</em>
  3176. <p>Jwt authenticates with Vault by passing role and JWT token using the
  3177. JWT/OIDC authentication method</p>
  3178. </td>
  3179. </tr>
  3180. <tr>
  3181. <td>
  3182. <code>cert</code></br>
  3183. <em>
  3184. <a href="#external-secrets.io/v1alpha1.VaultCertAuth">
  3185. VaultCertAuth
  3186. </a>
  3187. </em>
  3188. </td>
  3189. <td>
  3190. <em>(Optional)</em>
  3191. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  3192. Cert authentication method</p>
  3193. </td>
  3194. </tr>
  3195. </tbody>
  3196. </table>
  3197. <h3 id="external-secrets.io/v1alpha1.VaultCertAuth">VaultCertAuth
  3198. </h3>
  3199. <p>
  3200. (<em>Appears on:</em>
  3201. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  3202. </p>
  3203. <p>
  3204. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  3205. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  3206. </p>
  3207. <table>
  3208. <thead>
  3209. <tr>
  3210. <th>Field</th>
  3211. <th>Description</th>
  3212. </tr>
  3213. </thead>
  3214. <tbody>
  3215. <tr>
  3216. <td>
  3217. <code>clientCert</code></br>
  3218. <em>
  3219. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3220. </em>
  3221. </td>
  3222. <td>
  3223. <em>(Optional)</em>
  3224. <p>ClientCert is a certificate to authenticate using the Cert Vault
  3225. authentication method</p>
  3226. </td>
  3227. </tr>
  3228. <tr>
  3229. <td>
  3230. <code>secretRef</code></br>
  3231. <em>
  3232. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3233. </em>
  3234. </td>
  3235. <td>
  3236. <p>SecretRef to a key in a Secret resource containing client private key to
  3237. authenticate with Vault using the Cert authentication method</p>
  3238. </td>
  3239. </tr>
  3240. </tbody>
  3241. </table>
  3242. <h3 id="external-secrets.io/v1alpha1.VaultJwtAuth">VaultJwtAuth
  3243. </h3>
  3244. <p>
  3245. (<em>Appears on:</em>
  3246. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  3247. </p>
  3248. <p>
  3249. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  3250. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  3251. </p>
  3252. <table>
  3253. <thead>
  3254. <tr>
  3255. <th>Field</th>
  3256. <th>Description</th>
  3257. </tr>
  3258. </thead>
  3259. <tbody>
  3260. <tr>
  3261. <td>
  3262. <code>role</code></br>
  3263. <em>
  3264. string
  3265. </em>
  3266. </td>
  3267. <td>
  3268. <em>(Optional)</em>
  3269. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  3270. authentication method</p>
  3271. </td>
  3272. </tr>
  3273. <tr>
  3274. <td>
  3275. <code>secretRef</code></br>
  3276. <em>
  3277. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3278. </em>
  3279. </td>
  3280. <td>
  3281. <p>SecretRef to a key in a Secret resource containing JWT token to
  3282. authenticate with Vault using the JWT/OIDC authentication method</p>
  3283. </td>
  3284. </tr>
  3285. </tbody>
  3286. </table>
  3287. <h3 id="external-secrets.io/v1alpha1.VaultKVStoreVersion">VaultKVStoreVersion
  3288. (<code>string</code> alias)</p></h3>
  3289. <p>
  3290. (<em>Appears on:</em>
  3291. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  3292. </p>
  3293. <p>
  3294. </p>
  3295. <table>
  3296. <thead>
  3297. <tr>
  3298. <th>Value</th>
  3299. <th>Description</th>
  3300. </tr>
  3301. </thead>
  3302. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  3303. <td></td>
  3304. </tr><tr><td><p>&#34;v2&#34;</p></td>
  3305. <td></td>
  3306. </tr></tbody>
  3307. </table>
  3308. <h3 id="external-secrets.io/v1alpha1.VaultKubernetesAuth">VaultKubernetesAuth
  3309. </h3>
  3310. <p>
  3311. (<em>Appears on:</em>
  3312. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  3313. </p>
  3314. <p>
  3315. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  3316. a Secret.</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>mountPath</code></br>
  3329. <em>
  3330. string
  3331. </em>
  3332. </td>
  3333. <td>
  3334. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  3335. &ldquo;kubernetes&rdquo;</p>
  3336. </td>
  3337. </tr>
  3338. <tr>
  3339. <td>
  3340. <code>serviceAccountRef</code></br>
  3341. <em>
  3342. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  3343. </em>
  3344. </td>
  3345. <td>
  3346. <em>(Optional)</em>
  3347. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  3348. If the service account is specified, the service account secret token JWT will be used
  3349. for authenticating with Vault. If the service account selector is not supplied,
  3350. the secretRef will be used instead.</p>
  3351. </td>
  3352. </tr>
  3353. <tr>
  3354. <td>
  3355. <code>secretRef</code></br>
  3356. <em>
  3357. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3358. </em>
  3359. </td>
  3360. <td>
  3361. <em>(Optional)</em>
  3362. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  3363. for authenticating with Vault. If a name is specified without a key,
  3364. <code>token</code> is the default. If one is not specified, the one bound to
  3365. the controller will be used.</p>
  3366. </td>
  3367. </tr>
  3368. <tr>
  3369. <td>
  3370. <code>role</code></br>
  3371. <em>
  3372. string
  3373. </em>
  3374. </td>
  3375. <td>
  3376. <p>A required field containing the Vault Role to assume. A Role binds a
  3377. Kubernetes ServiceAccount with a set of Vault policies.</p>
  3378. </td>
  3379. </tr>
  3380. </tbody>
  3381. </table>
  3382. <h3 id="external-secrets.io/v1alpha1.VaultLdapAuth">VaultLdapAuth
  3383. </h3>
  3384. <p>
  3385. (<em>Appears on:</em>
  3386. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  3387. </p>
  3388. <p>
  3389. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  3390. with the username and password stored in a Kubernetes Secret resource.</p>
  3391. </p>
  3392. <table>
  3393. <thead>
  3394. <tr>
  3395. <th>Field</th>
  3396. <th>Description</th>
  3397. </tr>
  3398. </thead>
  3399. <tbody>
  3400. <tr>
  3401. <td>
  3402. <code>username</code></br>
  3403. <em>
  3404. string
  3405. </em>
  3406. </td>
  3407. <td>
  3408. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  3409. authentication method</p>
  3410. </td>
  3411. </tr>
  3412. <tr>
  3413. <td>
  3414. <code>secretRef</code></br>
  3415. <em>
  3416. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3417. </em>
  3418. </td>
  3419. <td>
  3420. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  3421. user used to authenticate with Vault using the LDAP authentication
  3422. method</p>
  3423. </td>
  3424. </tr>
  3425. </tbody>
  3426. </table>
  3427. <h3 id="external-secrets.io/v1alpha1.VaultProvider">VaultProvider
  3428. </h3>
  3429. <p>
  3430. (<em>Appears on:</em>
  3431. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  3432. </p>
  3433. <p>
  3434. <p>Configures an store to sync secrets using a HashiCorp Vault
  3435. KV backend.</p>
  3436. </p>
  3437. <table>
  3438. <thead>
  3439. <tr>
  3440. <th>Field</th>
  3441. <th>Description</th>
  3442. </tr>
  3443. </thead>
  3444. <tbody>
  3445. <tr>
  3446. <td>
  3447. <code>auth</code></br>
  3448. <em>
  3449. <a href="#external-secrets.io/v1alpha1.VaultAuth">
  3450. VaultAuth
  3451. </a>
  3452. </em>
  3453. </td>
  3454. <td>
  3455. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  3456. </td>
  3457. </tr>
  3458. <tr>
  3459. <td>
  3460. <code>server</code></br>
  3461. <em>
  3462. string
  3463. </em>
  3464. </td>
  3465. <td>
  3466. <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>
  3467. </td>
  3468. </tr>
  3469. <tr>
  3470. <td>
  3471. <code>path</code></br>
  3472. <em>
  3473. string
  3474. </em>
  3475. </td>
  3476. <td>
  3477. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  3478. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  3479. for fetching secrets from Vault is optional and will be appended
  3480. if not present in specified path.</p>
  3481. </td>
  3482. </tr>
  3483. <tr>
  3484. <td>
  3485. <code>version</code></br>
  3486. <em>
  3487. <a href="#external-secrets.io/v1alpha1.VaultKVStoreVersion">
  3488. VaultKVStoreVersion
  3489. </a>
  3490. </em>
  3491. </td>
  3492. <td>
  3493. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  3494. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  3495. </td>
  3496. </tr>
  3497. <tr>
  3498. <td>
  3499. <code>namespace</code></br>
  3500. <em>
  3501. string
  3502. </em>
  3503. </td>
  3504. <td>
  3505. <em>(Optional)</em>
  3506. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  3507. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  3508. 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>
  3509. </td>
  3510. </tr>
  3511. <tr>
  3512. <td>
  3513. <code>caBundle</code></br>
  3514. <em>
  3515. []byte
  3516. </em>
  3517. </td>
  3518. <td>
  3519. <em>(Optional)</em>
  3520. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  3521. if the Server URL is using HTTPS protocol. This parameter is ignored for
  3522. plain HTTP protocol connection. If not set the system root certificates
  3523. are used to validate the TLS connection.</p>
  3524. </td>
  3525. </tr>
  3526. <tr>
  3527. <td>
  3528. <code>caProvider</code></br>
  3529. <em>
  3530. <a href="#external-secrets.io/v1alpha1.CAProvider">
  3531. CAProvider
  3532. </a>
  3533. </em>
  3534. </td>
  3535. <td>
  3536. <em>(Optional)</em>
  3537. <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
  3538. </td>
  3539. </tr>
  3540. </tbody>
  3541. </table>
  3542. <h3 id="external-secrets.io/v1alpha1.YandexLockboxAuth">YandexLockboxAuth
  3543. </h3>
  3544. <p>
  3545. (<em>Appears on:</em>
  3546. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider</a>)
  3547. </p>
  3548. <p>
  3549. </p>
  3550. <table>
  3551. <thead>
  3552. <tr>
  3553. <th>Field</th>
  3554. <th>Description</th>
  3555. </tr>
  3556. </thead>
  3557. <tbody>
  3558. <tr>
  3559. <td>
  3560. <code>authorizedKeySecretRef</code></br>
  3561. <em>
  3562. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3563. </em>
  3564. </td>
  3565. <td>
  3566. <em>(Optional)</em>
  3567. <p>The authorized key used for authentication</p>
  3568. </td>
  3569. </tr>
  3570. </tbody>
  3571. </table>
  3572. <h3 id="external-secrets.io/v1alpha1.YandexLockboxCAProvider">YandexLockboxCAProvider
  3573. </h3>
  3574. <p>
  3575. (<em>Appears on:</em>
  3576. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider</a>)
  3577. </p>
  3578. <p>
  3579. </p>
  3580. <table>
  3581. <thead>
  3582. <tr>
  3583. <th>Field</th>
  3584. <th>Description</th>
  3585. </tr>
  3586. </thead>
  3587. <tbody>
  3588. <tr>
  3589. <td>
  3590. <code>certSecretRef</code></br>
  3591. <em>
  3592. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3593. </em>
  3594. </td>
  3595. <td>
  3596. </td>
  3597. </tr>
  3598. </tbody>
  3599. </table>
  3600. <h3 id="external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider
  3601. </h3>
  3602. <p>
  3603. (<em>Appears on:</em>
  3604. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  3605. </p>
  3606. <p>
  3607. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
  3608. </p>
  3609. <table>
  3610. <thead>
  3611. <tr>
  3612. <th>Field</th>
  3613. <th>Description</th>
  3614. </tr>
  3615. </thead>
  3616. <tbody>
  3617. <tr>
  3618. <td>
  3619. <code>apiEndpoint</code></br>
  3620. <em>
  3621. string
  3622. </em>
  3623. </td>
  3624. <td>
  3625. <em>(Optional)</em>
  3626. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  3627. </td>
  3628. </tr>
  3629. <tr>
  3630. <td>
  3631. <code>auth</code></br>
  3632. <em>
  3633. <a href="#external-secrets.io/v1alpha1.YandexLockboxAuth">
  3634. YandexLockboxAuth
  3635. </a>
  3636. </em>
  3637. </td>
  3638. <td>
  3639. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
  3640. </td>
  3641. </tr>
  3642. <tr>
  3643. <td>
  3644. <code>caProvider</code></br>
  3645. <em>
  3646. <a href="#external-secrets.io/v1alpha1.YandexLockboxCAProvider">
  3647. YandexLockboxCAProvider
  3648. </a>
  3649. </em>
  3650. </td>
  3651. <td>
  3652. <em>(Optional)</em>
  3653. <p>The provider for the CA bundle to use to validate Yandex.Cloud server certificate.</p>
  3654. </td>
  3655. </tr>
  3656. </tbody>
  3657. </table>
  3658. <hr/>
  3659. <p><em>
  3660. Generated with <code>gen-crd-api-reference-docs</code>.
  3661. </em></p></p>
  3662. </article>
  3663. </div>
  3664. </div>
  3665. </main>
  3666. <footer class="md-footer">
  3667. <nav class="md-footer__inner md-grid" aria-label="Footer">
  3668. <a href="../provider-oracle-vault/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Oracle Vault" rel="prev">
  3669. <div class="md-footer__button md-icon">
  3670. <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>
  3671. </div>
  3672. <div class="md-footer__title">
  3673. <div class="md-ellipsis">
  3674. <span class="md-footer__direction">
  3675. Previous
  3676. </span>
  3677. Oracle Vault
  3678. </div>
  3679. </div>
  3680. </a>
  3681. <a href="../contributing-devguide/" class="md-footer__link md-footer__link--next" aria-label="Next: Developer guide" rel="next">
  3682. <div class="md-footer__title">
  3683. <div class="md-ellipsis">
  3684. <span class="md-footer__direction">
  3685. Next
  3686. </span>
  3687. Developer guide
  3688. </div>
  3689. </div>
  3690. <div class="md-footer__button md-icon">
  3691. <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>
  3692. </div>
  3693. </a>
  3694. </nav>
  3695. <div class="md-footer-meta md-typeset">
  3696. <div class="md-footer-meta__inner md-grid">
  3697. <div class="md-footer-copyright">
  3698. Made with
  3699. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  3700. Material for MkDocs
  3701. </a>
  3702. </div>
  3703. </div>
  3704. </div>
  3705. </footer>
  3706. </div>
  3707. <div class="md-dialog" data-md-component="dialog">
  3708. <div class="md-dialog__inner md-typeset"></div>
  3709. </div>
  3710. <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.b0710199.min.js", "version": null}</script>
  3711. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  3712. </body>
  3713. </html>