index.html 76 KB

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