index.html 57 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707
  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-multi-tenancy/" class="md-nav__link">
  181. Multi Tenancy
  182. </a>
  183. </li>
  184. <li class="md-nav__item">
  185. <a href="../guides-metrics/" class="md-nav__link">
  186. Metrics
  187. </a>
  188. </li>
  189. </ul>
  190. </nav>
  191. </li>
  192. <li class="md-nav__item md-nav__item--nested">
  193. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  194. <label class="md-nav__link" for="__nav_5">
  195. Provider
  196. <span class="md-nav__icon md-icon"></span>
  197. </label>
  198. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  199. <label class="md-nav__title" for="__nav_5">
  200. <span class="md-nav__icon md-icon"></span>
  201. Provider
  202. </label>
  203. <ul class="md-nav__list" data-md-scrollfix>
  204. <li class="md-nav__item md-nav__item--nested">
  205. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  206. <label class="md-nav__link" for="__nav_5_1">
  207. AWS
  208. <span class="md-nav__icon md-icon"></span>
  209. </label>
  210. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  211. <label class="md-nav__title" for="__nav_5_1">
  212. <span class="md-nav__icon md-icon"></span>
  213. AWS
  214. </label>
  215. <ul class="md-nav__list" data-md-scrollfix>
  216. <li class="md-nav__item">
  217. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  218. Secrets Manager
  219. </a>
  220. </li>
  221. <li class="md-nav__item">
  222. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  223. Parameter Store
  224. </a>
  225. </li>
  226. </ul>
  227. </nav>
  228. </li>
  229. <li class="md-nav__item md-nav__item--nested">
  230. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  231. <label class="md-nav__link" for="__nav_5_2">
  232. Azure
  233. <span class="md-nav__icon md-icon"></span>
  234. </label>
  235. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  236. <label class="md-nav__title" for="__nav_5_2">
  237. <span class="md-nav__icon md-icon"></span>
  238. Azure
  239. </label>
  240. <ul class="md-nav__list" data-md-scrollfix>
  241. <li class="md-nav__item">
  242. <a href="../provider-azure-key-vault/" class="md-nav__link">
  243. Key Vault
  244. </a>
  245. </li>
  246. </ul>
  247. </nav>
  248. </li>
  249. <li class="md-nav__item md-nav__item--nested">
  250. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  251. <label class="md-nav__link" for="__nav_5_3">
  252. Google
  253. <span class="md-nav__icon md-icon"></span>
  254. </label>
  255. <nav class="md-nav" aria-label="Google" data-md-level="2">
  256. <label class="md-nav__title" for="__nav_5_3">
  257. <span class="md-nav__icon md-icon"></span>
  258. Google
  259. </label>
  260. <ul class="md-nav__list" data-md-scrollfix>
  261. <li class="md-nav__item">
  262. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  263. Secrets Manager
  264. </a>
  265. </li>
  266. </ul>
  267. </nav>
  268. </li>
  269. <li class="md-nav__item">
  270. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  271. HashiCorp Vault
  272. </a>
  273. </li>
  274. </ul>
  275. </nav>
  276. </li>
  277. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  278. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
  279. <label class="md-nav__link" for="__nav_6">
  280. References
  281. <span class="md-nav__icon md-icon"></span>
  282. </label>
  283. <nav class="md-nav" aria-label="References" data-md-level="1">
  284. <label class="md-nav__title" for="__nav_6">
  285. <span class="md-nav__icon md-icon"></span>
  286. References
  287. </label>
  288. <ul class="md-nav__list" data-md-scrollfix>
  289. <li class="md-nav__item md-nav__item--active">
  290. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  291. <a href="./" class="md-nav__link md-nav__link--active">
  292. API specification
  293. </a>
  294. </li>
  295. </ul>
  296. </nav>
  297. </li>
  298. <li class="md-nav__item md-nav__item--nested">
  299. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  300. <label class="md-nav__link" for="__nav_7">
  301. Contributing
  302. <span class="md-nav__icon md-icon"></span>
  303. </label>
  304. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  305. <label class="md-nav__title" for="__nav_7">
  306. <span class="md-nav__icon md-icon"></span>
  307. Contributing
  308. </label>
  309. <ul class="md-nav__list" data-md-scrollfix>
  310. <li class="md-nav__item">
  311. <a href="../contributing-devguide/" class="md-nav__link">
  312. Developer guide
  313. </a>
  314. </li>
  315. <li class="md-nav__item">
  316. <a href="../contributing-process/" class="md-nav__link">
  317. Contributing Process
  318. </a>
  319. </li>
  320. <li class="md-nav__item">
  321. <a href="../contributing-coc/" class="md-nav__link">
  322. Code of Conduct
  323. </a>
  324. </li>
  325. </ul>
  326. </nav>
  327. </li>
  328. </ul>
  329. </nav>
  330. </div>
  331. </div>
  332. </div>
  333. <div class="md-content" data-md-component="content">
  334. <article class="md-content__inner md-typeset">
  335. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/spec.md" title="Edit this page" class="md-content__button md-icon">
  336. <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>
  337. </a>
  338. <h1>API specification</h1>
  339. <p>Packages:</p>
  340. <ul>
  341. <li>
  342. <a href="#external-secrets.io%2fv1alpha1">external-secrets.io/v1alpha1</a>
  343. </li>
  344. </ul>
  345. <h2 id="external-secrets.io/v1alpha1">external-secrets.io/v1alpha1</h2>
  346. <p>
  347. <p>Package v1alpha1 contains resources for external-secrets</p>
  348. </p>
  349. <p>Resource Types:
  350. <ul></ul>
  351. <h3 id="external-secrets.io/v1alpha1.AWSAuth">AWSAuth
  352. </h3>
  353. <p>
  354. (<em>Appears on:</em>
  355. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
  356. </p>
  357. <p>
  358. <p>AWSAuth contains a secretRef for credentials.</p>
  359. </p>
  360. <table>
  361. <thead>
  362. <tr>
  363. <th>Field</th>
  364. <th>Description</th>
  365. </tr>
  366. </thead>
  367. <tbody>
  368. <tr>
  369. <td>
  370. <code>secretRef</code></br>
  371. <em>
  372. <a href="#external-secrets.io/v1alpha1.AWSAuthSecretRef">
  373. AWSAuthSecretRef
  374. </a>
  375. </em>
  376. </td>
  377. <td>
  378. </td>
  379. </tr>
  380. </tbody>
  381. </table>
  382. <h3 id="external-secrets.io/v1alpha1.AWSAuthSecretRef">AWSAuthSecretRef
  383. </h3>
  384. <p>
  385. (<em>Appears on:</em>
  386. <a href="#external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
  387. </p>
  388. <p>
  389. <p>AWSAuthSecretRef holds secret references for aws credentials
  390. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  391. </p>
  392. <table>
  393. <thead>
  394. <tr>
  395. <th>Field</th>
  396. <th>Description</th>
  397. </tr>
  398. </thead>
  399. <tbody>
  400. <tr>
  401. <td>
  402. <code>accessKeyIDSecretRef</code></br>
  403. <em>
  404. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  405. </em>
  406. </td>
  407. <td>
  408. <p>The AccessKeyID is used for authentication</p>
  409. </td>
  410. </tr>
  411. <tr>
  412. <td>
  413. <code>secretAccessKeySecretRef</code></br>
  414. <em>
  415. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  416. </em>
  417. </td>
  418. <td>
  419. <p>The SecretAccessKey is used for authentication</p>
  420. </td>
  421. </tr>
  422. </tbody>
  423. </table>
  424. <h3 id="external-secrets.io/v1alpha1.AWSProvider">AWSProvider
  425. </h3>
  426. <p>
  427. (<em>Appears on:</em>
  428. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  429. </p>
  430. <p>
  431. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  432. </p>
  433. <table>
  434. <thead>
  435. <tr>
  436. <th>Field</th>
  437. <th>Description</th>
  438. </tr>
  439. </thead>
  440. <tbody>
  441. <tr>
  442. <td>
  443. <code>service</code></br>
  444. <em>
  445. <a href="#external-secrets.io/v1alpha1.AWSServiceType">
  446. AWSServiceType
  447. </a>
  448. </em>
  449. </td>
  450. <td>
  451. <p>Service defines which service should be used to fetch the secrets</p>
  452. </td>
  453. </tr>
  454. <tr>
  455. <td>
  456. <code>auth</code></br>
  457. <em>
  458. <a href="#external-secrets.io/v1alpha1.AWSAuth">
  459. AWSAuth
  460. </a>
  461. </em>
  462. </td>
  463. <td>
  464. <em>(Optional)</em>
  465. <p>Auth defines the information necessary to authenticate against AWS
  466. if not set aws sdk will infer credentials from your environment
  467. 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>
  468. </td>
  469. </tr>
  470. <tr>
  471. <td>
  472. <code>role</code></br>
  473. <em>
  474. string
  475. </em>
  476. </td>
  477. <td>
  478. <em>(Optional)</em>
  479. <p>Role is a Role ARN which the SecretManager provider will assume</p>
  480. </td>
  481. </tr>
  482. <tr>
  483. <td>
  484. <code>region</code></br>
  485. <em>
  486. string
  487. </em>
  488. </td>
  489. <td>
  490. <p>AWS Region to be used for the provider</p>
  491. </td>
  492. </tr>
  493. </tbody>
  494. </table>
  495. <h3 id="external-secrets.io/v1alpha1.AWSServiceType">AWSServiceType
  496. (<code>string</code> alias)</p></h3>
  497. <p>
  498. (<em>Appears on:</em>
  499. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
  500. </p>
  501. <p>
  502. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  503. </p>
  504. <table>
  505. <thead>
  506. <tr>
  507. <th>Value</th>
  508. <th>Description</th>
  509. </tr>
  510. </thead>
  511. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  512. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore.
  513. 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>
  514. </td>
  515. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  516. <td><p>AWSServiceSecretsManager is the AWS SecretsManager.
  517. 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>
  518. </td>
  519. </tr></tbody>
  520. </table>
  521. <h3 id="external-secrets.io/v1alpha1.AzureKVAuth">AzureKVAuth
  522. </h3>
  523. <p>
  524. (<em>Appears on:</em>
  525. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider</a>)
  526. </p>
  527. <p>
  528. <p>Configuration used to authenticate with Azure.</p>
  529. </p>
  530. <table>
  531. <thead>
  532. <tr>
  533. <th>Field</th>
  534. <th>Description</th>
  535. </tr>
  536. </thead>
  537. <tbody>
  538. <tr>
  539. <td>
  540. <code>clientId</code></br>
  541. <em>
  542. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  543. </em>
  544. </td>
  545. <td>
  546. <p>The Azure clientId of the service principle used for authentication.</p>
  547. </td>
  548. </tr>
  549. <tr>
  550. <td>
  551. <code>clientSecret</code></br>
  552. <em>
  553. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  554. </em>
  555. </td>
  556. <td>
  557. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  558. </td>
  559. </tr>
  560. </tbody>
  561. </table>
  562. <h3 id="external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider
  563. </h3>
  564. <p>
  565. (<em>Appears on:</em>
  566. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  567. </p>
  568. <p>
  569. <p>Configures an store to sync secrets using Azure KV.</p>
  570. </p>
  571. <table>
  572. <thead>
  573. <tr>
  574. <th>Field</th>
  575. <th>Description</th>
  576. </tr>
  577. </thead>
  578. <tbody>
  579. <tr>
  580. <td>
  581. <code>vaultUrl</code></br>
  582. <em>
  583. string
  584. </em>
  585. </td>
  586. <td>
  587. <p>Vault Url from which the secrets to be fetched from.</p>
  588. </td>
  589. </tr>
  590. <tr>
  591. <td>
  592. <code>tenantId</code></br>
  593. <em>
  594. string
  595. </em>
  596. </td>
  597. <td>
  598. <p>TenantID configures the Azure Tenant to send requests to.</p>
  599. </td>
  600. </tr>
  601. <tr>
  602. <td>
  603. <code>authSecretRef</code></br>
  604. <em>
  605. <a href="#external-secrets.io/v1alpha1.AzureKVAuth">
  606. AzureKVAuth
  607. </a>
  608. </em>
  609. </td>
  610. <td>
  611. <p>Auth configures how the operator authenticates with Azure.</p>
  612. </td>
  613. </tr>
  614. </tbody>
  615. </table>
  616. <h3 id="external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore
  617. </h3>
  618. <p>
  619. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  620. </p>
  621. <table>
  622. <thead>
  623. <tr>
  624. <th>Field</th>
  625. <th>Description</th>
  626. </tr>
  627. </thead>
  628. <tbody>
  629. <tr>
  630. <td>
  631. <code>metadata</code></br>
  632. <em>
  633. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  634. Kubernetes meta/v1.ObjectMeta
  635. </a>
  636. </em>
  637. </td>
  638. <td>
  639. Refer to the Kubernetes API documentation for the fields of the
  640. <code>metadata</code> field.
  641. </td>
  642. </tr>
  643. <tr>
  644. <td>
  645. <code>spec</code></br>
  646. <em>
  647. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  648. SecretStoreSpec
  649. </a>
  650. </em>
  651. </td>
  652. <td>
  653. <br/>
  654. <br/>
  655. <table>
  656. <tr>
  657. <td>
  658. <code>controller</code></br>
  659. <em>
  660. string
  661. </em>
  662. </td>
  663. <td>
  664. <em>(Optional)</em>
  665. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  666. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  667. </td>
  668. </tr>
  669. <tr>
  670. <td>
  671. <code>provider</code></br>
  672. <em>
  673. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  674. SecretStoreProvider
  675. </a>
  676. </em>
  677. </td>
  678. <td>
  679. <p>Used to configure the provider. Only one provider may be set</p>
  680. </td>
  681. </tr>
  682. </table>
  683. </td>
  684. </tr>
  685. <tr>
  686. <td>
  687. <code>status</code></br>
  688. <em>
  689. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  690. SecretStoreStatus
  691. </a>
  692. </em>
  693. </td>
  694. <td>
  695. </td>
  696. </tr>
  697. </tbody>
  698. </table>
  699. <h3 id="external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret
  700. </h3>
  701. <p>
  702. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  703. </p>
  704. <table>
  705. <thead>
  706. <tr>
  707. <th>Field</th>
  708. <th>Description</th>
  709. </tr>
  710. </thead>
  711. <tbody>
  712. <tr>
  713. <td>
  714. <code>metadata</code></br>
  715. <em>
  716. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  717. Kubernetes meta/v1.ObjectMeta
  718. </a>
  719. </em>
  720. </td>
  721. <td>
  722. Refer to the Kubernetes API documentation for the fields of the
  723. <code>metadata</code> field.
  724. </td>
  725. </tr>
  726. <tr>
  727. <td>
  728. <code>spec</code></br>
  729. <em>
  730. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">
  731. ExternalSecretSpec
  732. </a>
  733. </em>
  734. </td>
  735. <td>
  736. <br/>
  737. <br/>
  738. <table>
  739. <tr>
  740. <td>
  741. <code>secretStoreRef</code></br>
  742. <em>
  743. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  744. SecretStoreRef
  745. </a>
  746. </em>
  747. </td>
  748. <td>
  749. </td>
  750. </tr>
  751. <tr>
  752. <td>
  753. <code>target</code></br>
  754. <em>
  755. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  756. ExternalSecretTarget
  757. </a>
  758. </em>
  759. </td>
  760. <td>
  761. </td>
  762. </tr>
  763. <tr>
  764. <td>
  765. <code>refreshInterval</code></br>
  766. <em>
  767. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  768. Kubernetes meta/v1.Duration
  769. </a>
  770. </em>
  771. </td>
  772. <td>
  773. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  774. 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;
  775. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  776. </td>
  777. </tr>
  778. <tr>
  779. <td>
  780. <code>data</code></br>
  781. <em>
  782. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  783. []ExternalSecretData
  784. </a>
  785. </em>
  786. </td>
  787. <td>
  788. <em>(Optional)</em>
  789. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  790. </td>
  791. </tr>
  792. <tr>
  793. <td>
  794. <code>dataFrom</code></br>
  795. <em>
  796. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  797. []ExternalSecretDataRemoteRef
  798. </a>
  799. </em>
  800. </td>
  801. <td>
  802. <em>(Optional)</em>
  803. <p>DataFrom is used to fetch all properties from a specific Provider data
  804. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  805. </td>
  806. </tr>
  807. </table>
  808. </td>
  809. </tr>
  810. <tr>
  811. <td>
  812. <code>status</code></br>
  813. <em>
  814. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">
  815. ExternalSecretStatus
  816. </a>
  817. </em>
  818. </td>
  819. <td>
  820. </td>
  821. </tr>
  822. </tbody>
  823. </table>
  824. <h3 id="external-secrets.io/v1alpha1.ExternalSecretConditionType">ExternalSecretConditionType
  825. (<code>string</code> alias)</p></h3>
  826. <p>
  827. (<em>Appears on:</em>
  828. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  829. </p>
  830. <p>
  831. </p>
  832. <table>
  833. <thead>
  834. <tr>
  835. <th>Value</th>
  836. <th>Description</th>
  837. </tr>
  838. </thead>
  839. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  840. <td></td>
  841. </tr></tbody>
  842. </table>
  843. <h3 id="external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  844. (<code>string</code> alias)</p></h3>
  845. <p>
  846. (<em>Appears on:</em>
  847. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  848. </p>
  849. <p>
  850. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  851. </p>
  852. <table>
  853. <thead>
  854. <tr>
  855. <th>Value</th>
  856. <th>Description</th>
  857. </tr>
  858. </thead>
  859. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  860. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  861. </td>
  862. </tr><tr><td><p>&#34;None&#34;</p></td>
  863. <td><p>None does not create a Secret (future use with injector).</p>
  864. </td>
  865. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  866. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  867. </td>
  868. </tr></tbody>
  869. </table>
  870. <h3 id="external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData
  871. </h3>
  872. <p>
  873. (<em>Appears on:</em>
  874. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  875. </p>
  876. <p>
  877. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  878. </p>
  879. <table>
  880. <thead>
  881. <tr>
  882. <th>Field</th>
  883. <th>Description</th>
  884. </tr>
  885. </thead>
  886. <tbody>
  887. <tr>
  888. <td>
  889. <code>secretKey</code></br>
  890. <em>
  891. string
  892. </em>
  893. </td>
  894. <td>
  895. </td>
  896. </tr>
  897. <tr>
  898. <td>
  899. <code>remoteRef</code></br>
  900. <em>
  901. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  902. ExternalSecretDataRemoteRef
  903. </a>
  904. </em>
  905. </td>
  906. <td>
  907. </td>
  908. </tr>
  909. </tbody>
  910. </table>
  911. <h3 id="external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  912. </h3>
  913. <p>
  914. (<em>Appears on:</em>
  915. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData</a>,
  916. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  917. </p>
  918. <p>
  919. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  920. </p>
  921. <table>
  922. <thead>
  923. <tr>
  924. <th>Field</th>
  925. <th>Description</th>
  926. </tr>
  927. </thead>
  928. <tbody>
  929. <tr>
  930. <td>
  931. <code>key</code></br>
  932. <em>
  933. string
  934. </em>
  935. </td>
  936. <td>
  937. <p>Key is the key used in the Provider, mandatory</p>
  938. </td>
  939. </tr>
  940. <tr>
  941. <td>
  942. <code>version</code></br>
  943. <em>
  944. string
  945. </em>
  946. </td>
  947. <td>
  948. <em>(Optional)</em>
  949. <p>Used to select a specific version of the Provider value, if supported</p>
  950. </td>
  951. </tr>
  952. <tr>
  953. <td>
  954. <code>property</code></br>
  955. <em>
  956. string
  957. </em>
  958. </td>
  959. <td>
  960. <em>(Optional)</em>
  961. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  962. </td>
  963. </tr>
  964. </tbody>
  965. </table>
  966. <h3 id="external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec
  967. </h3>
  968. <p>
  969. (<em>Appears on:</em>
  970. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  971. </p>
  972. <p>
  973. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  974. </p>
  975. <table>
  976. <thead>
  977. <tr>
  978. <th>Field</th>
  979. <th>Description</th>
  980. </tr>
  981. </thead>
  982. <tbody>
  983. <tr>
  984. <td>
  985. <code>secretStoreRef</code></br>
  986. <em>
  987. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  988. SecretStoreRef
  989. </a>
  990. </em>
  991. </td>
  992. <td>
  993. </td>
  994. </tr>
  995. <tr>
  996. <td>
  997. <code>target</code></br>
  998. <em>
  999. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  1000. ExternalSecretTarget
  1001. </a>
  1002. </em>
  1003. </td>
  1004. <td>
  1005. </td>
  1006. </tr>
  1007. <tr>
  1008. <td>
  1009. <code>refreshInterval</code></br>
  1010. <em>
  1011. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1012. Kubernetes meta/v1.Duration
  1013. </a>
  1014. </em>
  1015. </td>
  1016. <td>
  1017. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  1018. 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;
  1019. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  1020. </td>
  1021. </tr>
  1022. <tr>
  1023. <td>
  1024. <code>data</code></br>
  1025. <em>
  1026. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  1027. []ExternalSecretData
  1028. </a>
  1029. </em>
  1030. </td>
  1031. <td>
  1032. <em>(Optional)</em>
  1033. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  1034. </td>
  1035. </tr>
  1036. <tr>
  1037. <td>
  1038. <code>dataFrom</code></br>
  1039. <em>
  1040. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1041. []ExternalSecretDataRemoteRef
  1042. </a>
  1043. </em>
  1044. </td>
  1045. <td>
  1046. <em>(Optional)</em>
  1047. <p>DataFrom is used to fetch all properties from a specific Provider data
  1048. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  1049. </td>
  1050. </tr>
  1051. </tbody>
  1052. </table>
  1053. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus
  1054. </h3>
  1055. <p>
  1056. (<em>Appears on:</em>
  1057. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  1058. </p>
  1059. <p>
  1060. </p>
  1061. <table>
  1062. <thead>
  1063. <tr>
  1064. <th>Field</th>
  1065. <th>Description</th>
  1066. </tr>
  1067. </thead>
  1068. <tbody>
  1069. <tr>
  1070. <td>
  1071. <code>refreshTime</code></br>
  1072. <em>
  1073. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1074. Kubernetes meta/v1.Time
  1075. </a>
  1076. </em>
  1077. </td>
  1078. <td>
  1079. <p>refreshTime is the time and date the external secret was fetched and
  1080. the target secret updated</p>
  1081. </td>
  1082. </tr>
  1083. <tr>
  1084. <td>
  1085. <code>syncedResourceVersion</code></br>
  1086. <em>
  1087. string
  1088. </em>
  1089. </td>
  1090. <td>
  1091. <p>SyncedResourceVersion keeps track of the last synced version</p>
  1092. </td>
  1093. </tr>
  1094. <tr>
  1095. <td>
  1096. <code>conditions</code></br>
  1097. <em>
  1098. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">
  1099. []ExternalSecretStatusCondition
  1100. </a>
  1101. </em>
  1102. </td>
  1103. <td>
  1104. <em>(Optional)</em>
  1105. </td>
  1106. </tr>
  1107. </tbody>
  1108. </table>
  1109. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  1110. </h3>
  1111. <p>
  1112. (<em>Appears on:</em>
  1113. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus</a>)
  1114. </p>
  1115. <p>
  1116. </p>
  1117. <table>
  1118. <thead>
  1119. <tr>
  1120. <th>Field</th>
  1121. <th>Description</th>
  1122. </tr>
  1123. </thead>
  1124. <tbody>
  1125. <tr>
  1126. <td>
  1127. <code>type</code></br>
  1128. <em>
  1129. <a href="#external-secrets.io/v1alpha1.ExternalSecretConditionType">
  1130. ExternalSecretConditionType
  1131. </a>
  1132. </em>
  1133. </td>
  1134. <td>
  1135. </td>
  1136. </tr>
  1137. <tr>
  1138. <td>
  1139. <code>status</code></br>
  1140. <em>
  1141. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  1142. Kubernetes core/v1.ConditionStatus
  1143. </a>
  1144. </em>
  1145. </td>
  1146. <td>
  1147. </td>
  1148. </tr>
  1149. <tr>
  1150. <td>
  1151. <code>reason</code></br>
  1152. <em>
  1153. string
  1154. </em>
  1155. </td>
  1156. <td>
  1157. <em>(Optional)</em>
  1158. </td>
  1159. </tr>
  1160. <tr>
  1161. <td>
  1162. <code>message</code></br>
  1163. <em>
  1164. string
  1165. </em>
  1166. </td>
  1167. <td>
  1168. <em>(Optional)</em>
  1169. </td>
  1170. </tr>
  1171. <tr>
  1172. <td>
  1173. <code>lastTransitionTime</code></br>
  1174. <em>
  1175. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1176. Kubernetes meta/v1.Time
  1177. </a>
  1178. </em>
  1179. </td>
  1180. <td>
  1181. <em>(Optional)</em>
  1182. </td>
  1183. </tr>
  1184. </tbody>
  1185. </table>
  1186. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget
  1187. </h3>
  1188. <p>
  1189. (<em>Appears on:</em>
  1190. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1191. </p>
  1192. <p>
  1193. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  1194. There can be only one target per ExternalSecret.</p>
  1195. </p>
  1196. <table>
  1197. <thead>
  1198. <tr>
  1199. <th>Field</th>
  1200. <th>Description</th>
  1201. </tr>
  1202. </thead>
  1203. <tbody>
  1204. <tr>
  1205. <td>
  1206. <code>name</code></br>
  1207. <em>
  1208. string
  1209. </em>
  1210. </td>
  1211. <td>
  1212. <em>(Optional)</em>
  1213. <p>Name defines the name of the Secret resource to be managed
  1214. This field is immutable
  1215. Defaults to the .metadata.name of the ExternalSecret resource</p>
  1216. </td>
  1217. </tr>
  1218. <tr>
  1219. <td>
  1220. <code>creationPolicy</code></br>
  1221. <em>
  1222. <a href="#external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">
  1223. ExternalSecretCreationPolicy
  1224. </a>
  1225. </em>
  1226. </td>
  1227. <td>
  1228. <em>(Optional)</em>
  1229. <p>CreationPolicy defines rules on how to create the resulting Secret
  1230. Defaults to &lsquo;Owner&rsquo;</p>
  1231. </td>
  1232. </tr>
  1233. <tr>
  1234. <td>
  1235. <code>template</code></br>
  1236. <em>
  1237. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">
  1238. ExternalSecretTemplate
  1239. </a>
  1240. </em>
  1241. </td>
  1242. <td>
  1243. <em>(Optional)</em>
  1244. <p>Template defines a blueprint for the created Secret resource.</p>
  1245. </td>
  1246. </tr>
  1247. </tbody>
  1248. </table>
  1249. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate
  1250. </h3>
  1251. <p>
  1252. (<em>Appears on:</em>
  1253. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  1254. </p>
  1255. <p>
  1256. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  1257. 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>
  1258. </p>
  1259. <table>
  1260. <thead>
  1261. <tr>
  1262. <th>Field</th>
  1263. <th>Description</th>
  1264. </tr>
  1265. </thead>
  1266. <tbody>
  1267. <tr>
  1268. <td>
  1269. <code>type</code></br>
  1270. <em>
  1271. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secrettype-v1-core">
  1272. Kubernetes core/v1.SecretType
  1273. </a>
  1274. </em>
  1275. </td>
  1276. <td>
  1277. <em>(Optional)</em>
  1278. </td>
  1279. </tr>
  1280. <tr>
  1281. <td>
  1282. <code>metadata</code></br>
  1283. <em>
  1284. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">
  1285. ExternalSecretTemplateMetadata
  1286. </a>
  1287. </em>
  1288. </td>
  1289. <td>
  1290. <em>(Optional)</em>
  1291. </td>
  1292. </tr>
  1293. <tr>
  1294. <td>
  1295. <code>data</code></br>
  1296. <em>
  1297. map[string]string
  1298. </em>
  1299. </td>
  1300. <td>
  1301. <em>(Optional)</em>
  1302. </td>
  1303. </tr>
  1304. </tbody>
  1305. </table>
  1306. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  1307. </h3>
  1308. <p>
  1309. (<em>Appears on:</em>
  1310. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  1311. </p>
  1312. <p>
  1313. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  1314. </p>
  1315. <table>
  1316. <thead>
  1317. <tr>
  1318. <th>Field</th>
  1319. <th>Description</th>
  1320. </tr>
  1321. </thead>
  1322. <tbody>
  1323. <tr>
  1324. <td>
  1325. <code>annotations</code></br>
  1326. <em>
  1327. map[string]string
  1328. </em>
  1329. </td>
  1330. <td>
  1331. <em>(Optional)</em>
  1332. </td>
  1333. </tr>
  1334. <tr>
  1335. <td>
  1336. <code>labels</code></br>
  1337. <em>
  1338. map[string]string
  1339. </em>
  1340. </td>
  1341. <td>
  1342. <em>(Optional)</em>
  1343. </td>
  1344. </tr>
  1345. </tbody>
  1346. </table>
  1347. <h3 id="external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth
  1348. </h3>
  1349. <p>
  1350. (<em>Appears on:</em>
  1351. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider</a>)
  1352. </p>
  1353. <p>
  1354. </p>
  1355. <table>
  1356. <thead>
  1357. <tr>
  1358. <th>Field</th>
  1359. <th>Description</th>
  1360. </tr>
  1361. </thead>
  1362. <tbody>
  1363. <tr>
  1364. <td>
  1365. <code>secretRef</code></br>
  1366. <em>
  1367. <a href="#external-secrets.io/v1alpha1.GCPSMAuthSecretRef">
  1368. GCPSMAuthSecretRef
  1369. </a>
  1370. </em>
  1371. </td>
  1372. <td>
  1373. </td>
  1374. </tr>
  1375. </tbody>
  1376. </table>
  1377. <h3 id="external-secrets.io/v1alpha1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  1378. </h3>
  1379. <p>
  1380. (<em>Appears on:</em>
  1381. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth</a>)
  1382. </p>
  1383. <p>
  1384. </p>
  1385. <table>
  1386. <thead>
  1387. <tr>
  1388. <th>Field</th>
  1389. <th>Description</th>
  1390. </tr>
  1391. </thead>
  1392. <tbody>
  1393. <tr>
  1394. <td>
  1395. <code>secretAccessKeySecretRef</code></br>
  1396. <em>
  1397. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1398. </em>
  1399. </td>
  1400. <td>
  1401. <em>(Optional)</em>
  1402. <p>The SecretAccessKey is used for authentication</p>
  1403. </td>
  1404. </tr>
  1405. </tbody>
  1406. </table>
  1407. <h3 id="external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider
  1408. </h3>
  1409. <p>
  1410. (<em>Appears on:</em>
  1411. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  1412. </p>
  1413. <p>
  1414. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  1415. </p>
  1416. <table>
  1417. <thead>
  1418. <tr>
  1419. <th>Field</th>
  1420. <th>Description</th>
  1421. </tr>
  1422. </thead>
  1423. <tbody>
  1424. <tr>
  1425. <td>
  1426. <code>auth</code></br>
  1427. <em>
  1428. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">
  1429. GCPSMAuth
  1430. </a>
  1431. </em>
  1432. </td>
  1433. <td>
  1434. <p>Auth defines the information necessary to authenticate against GCP</p>
  1435. </td>
  1436. </tr>
  1437. <tr>
  1438. <td>
  1439. <code>projectID</code></br>
  1440. <em>
  1441. string
  1442. </em>
  1443. </td>
  1444. <td>
  1445. <p>ProjectID project where secret is located</p>
  1446. </td>
  1447. </tr>
  1448. </tbody>
  1449. </table>
  1450. <h3 id="external-secrets.io/v1alpha1.GenericStore">GenericStore
  1451. </h3>
  1452. <p>
  1453. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  1454. or a namespaced SecretStore.</p>
  1455. </p>
  1456. <h3 id="external-secrets.io/v1alpha1.SecretStore">SecretStore
  1457. </h3>
  1458. <p>
  1459. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  1460. </p>
  1461. <table>
  1462. <thead>
  1463. <tr>
  1464. <th>Field</th>
  1465. <th>Description</th>
  1466. </tr>
  1467. </thead>
  1468. <tbody>
  1469. <tr>
  1470. <td>
  1471. <code>metadata</code></br>
  1472. <em>
  1473. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1474. Kubernetes meta/v1.ObjectMeta
  1475. </a>
  1476. </em>
  1477. </td>
  1478. <td>
  1479. Refer to the Kubernetes API documentation for the fields of the
  1480. <code>metadata</code> field.
  1481. </td>
  1482. </tr>
  1483. <tr>
  1484. <td>
  1485. <code>spec</code></br>
  1486. <em>
  1487. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  1488. SecretStoreSpec
  1489. </a>
  1490. </em>
  1491. </td>
  1492. <td>
  1493. <br/>
  1494. <br/>
  1495. <table>
  1496. <tr>
  1497. <td>
  1498. <code>controller</code></br>
  1499. <em>
  1500. string
  1501. </em>
  1502. </td>
  1503. <td>
  1504. <em>(Optional)</em>
  1505. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  1506. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  1507. </td>
  1508. </tr>
  1509. <tr>
  1510. <td>
  1511. <code>provider</code></br>
  1512. <em>
  1513. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  1514. SecretStoreProvider
  1515. </a>
  1516. </em>
  1517. </td>
  1518. <td>
  1519. <p>Used to configure the provider. Only one provider may be set</p>
  1520. </td>
  1521. </tr>
  1522. </table>
  1523. </td>
  1524. </tr>
  1525. <tr>
  1526. <td>
  1527. <code>status</code></br>
  1528. <em>
  1529. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  1530. SecretStoreStatus
  1531. </a>
  1532. </em>
  1533. </td>
  1534. <td>
  1535. </td>
  1536. </tr>
  1537. </tbody>
  1538. </table>
  1539. <h3 id="external-secrets.io/v1alpha1.SecretStoreConditionType">SecretStoreConditionType
  1540. (<code>string</code> alias)</p></h3>
  1541. <p>
  1542. (<em>Appears on:</em>
  1543. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  1544. </p>
  1545. <p>
  1546. </p>
  1547. <table>
  1548. <thead>
  1549. <tr>
  1550. <th>Value</th>
  1551. <th>Description</th>
  1552. </tr>
  1553. </thead>
  1554. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  1555. <td></td>
  1556. </tr></tbody>
  1557. </table>
  1558. <h3 id="external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider
  1559. </h3>
  1560. <p>
  1561. (<em>Appears on:</em>
  1562. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec</a>)
  1563. </p>
  1564. <p>
  1565. <p>SecretStoreProvider contains the provider-specific configration.</p>
  1566. </p>
  1567. <table>
  1568. <thead>
  1569. <tr>
  1570. <th>Field</th>
  1571. <th>Description</th>
  1572. </tr>
  1573. </thead>
  1574. <tbody>
  1575. <tr>
  1576. <td>
  1577. <code>aws</code></br>
  1578. <em>
  1579. <a href="#external-secrets.io/v1alpha1.AWSProvider">
  1580. AWSProvider
  1581. </a>
  1582. </em>
  1583. </td>
  1584. <td>
  1585. <em>(Optional)</em>
  1586. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  1587. </td>
  1588. </tr>
  1589. <tr>
  1590. <td>
  1591. <code>azurekv</code></br>
  1592. <em>
  1593. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">
  1594. AzureKVProvider
  1595. </a>
  1596. </em>
  1597. </td>
  1598. <td>
  1599. <em>(Optional)</em>
  1600. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  1601. </td>
  1602. </tr>
  1603. <tr>
  1604. <td>
  1605. <code>vault</code></br>
  1606. <em>
  1607. <a href="#external-secrets.io/v1alpha1.VaultProvider">
  1608. VaultProvider
  1609. </a>
  1610. </em>
  1611. </td>
  1612. <td>
  1613. <em>(Optional)</em>
  1614. <p>Vault configures this store to sync secrets using Hashi provider</p>
  1615. </td>
  1616. </tr>
  1617. <tr>
  1618. <td>
  1619. <code>gcpsm</code></br>
  1620. <em>
  1621. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">
  1622. GCPSMProvider
  1623. </a>
  1624. </em>
  1625. </td>
  1626. <td>
  1627. <em>(Optional)</em>
  1628. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  1629. </td>
  1630. </tr>
  1631. </tbody>
  1632. </table>
  1633. <h3 id="external-secrets.io/v1alpha1.SecretStoreRef">SecretStoreRef
  1634. </h3>
  1635. <p>
  1636. (<em>Appears on:</em>
  1637. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1638. </p>
  1639. <p>
  1640. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  1641. </p>
  1642. <table>
  1643. <thead>
  1644. <tr>
  1645. <th>Field</th>
  1646. <th>Description</th>
  1647. </tr>
  1648. </thead>
  1649. <tbody>
  1650. <tr>
  1651. <td>
  1652. <code>name</code></br>
  1653. <em>
  1654. string
  1655. </em>
  1656. </td>
  1657. <td>
  1658. <p>Name of the SecretStore resource</p>
  1659. </td>
  1660. </tr>
  1661. <tr>
  1662. <td>
  1663. <code>kind</code></br>
  1664. <em>
  1665. string
  1666. </em>
  1667. </td>
  1668. <td>
  1669. <em>(Optional)</em>
  1670. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  1671. Defaults to <code>SecretStore</code></p>
  1672. </td>
  1673. </tr>
  1674. </tbody>
  1675. </table>
  1676. <h3 id="external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec
  1677. </h3>
  1678. <p>
  1679. (<em>Appears on:</em>
  1680. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  1681. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  1682. </p>
  1683. <p>
  1684. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  1685. </p>
  1686. <table>
  1687. <thead>
  1688. <tr>
  1689. <th>Field</th>
  1690. <th>Description</th>
  1691. </tr>
  1692. </thead>
  1693. <tbody>
  1694. <tr>
  1695. <td>
  1696. <code>controller</code></br>
  1697. <em>
  1698. string
  1699. </em>
  1700. </td>
  1701. <td>
  1702. <em>(Optional)</em>
  1703. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  1704. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  1705. </td>
  1706. </tr>
  1707. <tr>
  1708. <td>
  1709. <code>provider</code></br>
  1710. <em>
  1711. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  1712. SecretStoreProvider
  1713. </a>
  1714. </em>
  1715. </td>
  1716. <td>
  1717. <p>Used to configure the provider. Only one provider may be set</p>
  1718. </td>
  1719. </tr>
  1720. </tbody>
  1721. </table>
  1722. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus
  1723. </h3>
  1724. <p>
  1725. (<em>Appears on:</em>
  1726. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  1727. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  1728. </p>
  1729. <p>
  1730. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  1731. </p>
  1732. <table>
  1733. <thead>
  1734. <tr>
  1735. <th>Field</th>
  1736. <th>Description</th>
  1737. </tr>
  1738. </thead>
  1739. <tbody>
  1740. <tr>
  1741. <td>
  1742. <code>conditions</code></br>
  1743. <em>
  1744. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">
  1745. []SecretStoreStatusCondition
  1746. </a>
  1747. </em>
  1748. </td>
  1749. <td>
  1750. <em>(Optional)</em>
  1751. </td>
  1752. </tr>
  1753. </tbody>
  1754. </table>
  1755. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition
  1756. </h3>
  1757. <p>
  1758. (<em>Appears on:</em>
  1759. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus</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>type</code></br>
  1774. <em>
  1775. <a href="#external-secrets.io/v1alpha1.SecretStoreConditionType">
  1776. SecretStoreConditionType
  1777. </a>
  1778. </em>
  1779. </td>
  1780. <td>
  1781. </td>
  1782. </tr>
  1783. <tr>
  1784. <td>
  1785. <code>status</code></br>
  1786. <em>
  1787. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  1788. Kubernetes core/v1.ConditionStatus
  1789. </a>
  1790. </em>
  1791. </td>
  1792. <td>
  1793. </td>
  1794. </tr>
  1795. <tr>
  1796. <td>
  1797. <code>reason</code></br>
  1798. <em>
  1799. string
  1800. </em>
  1801. </td>
  1802. <td>
  1803. <em>(Optional)</em>
  1804. </td>
  1805. </tr>
  1806. <tr>
  1807. <td>
  1808. <code>message</code></br>
  1809. <em>
  1810. string
  1811. </em>
  1812. </td>
  1813. <td>
  1814. <em>(Optional)</em>
  1815. </td>
  1816. </tr>
  1817. <tr>
  1818. <td>
  1819. <code>lastTransitionTime</code></br>
  1820. <em>
  1821. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1822. Kubernetes meta/v1.Time
  1823. </a>
  1824. </em>
  1825. </td>
  1826. <td>
  1827. <em>(Optional)</em>
  1828. </td>
  1829. </tr>
  1830. </tbody>
  1831. </table>
  1832. <h3 id="external-secrets.io/v1alpha1.VaultAppRole">VaultAppRole
  1833. </h3>
  1834. <p>
  1835. (<em>Appears on:</em>
  1836. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  1837. </p>
  1838. <p>
  1839. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  1840. with the role and secret stored in a Kubernetes Secret resource.</p>
  1841. </p>
  1842. <table>
  1843. <thead>
  1844. <tr>
  1845. <th>Field</th>
  1846. <th>Description</th>
  1847. </tr>
  1848. </thead>
  1849. <tbody>
  1850. <tr>
  1851. <td>
  1852. <code>path</code></br>
  1853. <em>
  1854. string
  1855. </em>
  1856. </td>
  1857. <td>
  1858. <p>Path where the App Role authentication backend is mounted
  1859. in Vault, e.g: &ldquo;approle&rdquo;</p>
  1860. </td>
  1861. </tr>
  1862. <tr>
  1863. <td>
  1864. <code>roleId</code></br>
  1865. <em>
  1866. string
  1867. </em>
  1868. </td>
  1869. <td>
  1870. <p>RoleID configured in the App Role authentication backend when setting
  1871. up the authentication backend in Vault.</p>
  1872. </td>
  1873. </tr>
  1874. <tr>
  1875. <td>
  1876. <code>secretRef</code></br>
  1877. <em>
  1878. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1879. </em>
  1880. </td>
  1881. <td>
  1882. <p>Reference to a key in a Secret that contains the App Role secret used
  1883. to authenticate with Vault.
  1884. The <code>key</code> field must be specified and denotes which entry within the Secret
  1885. resource is used as the app role secret.</p>
  1886. </td>
  1887. </tr>
  1888. </tbody>
  1889. </table>
  1890. <h3 id="external-secrets.io/v1alpha1.VaultAuth">VaultAuth
  1891. </h3>
  1892. <p>
  1893. (<em>Appears on:</em>
  1894. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  1895. </p>
  1896. <p>
  1897. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  1898. Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code> or <code>jwt</code>
  1899. can be specified.</p>
  1900. </p>
  1901. <table>
  1902. <thead>
  1903. <tr>
  1904. <th>Field</th>
  1905. <th>Description</th>
  1906. </tr>
  1907. </thead>
  1908. <tbody>
  1909. <tr>
  1910. <td>
  1911. <code>tokenSecretRef</code></br>
  1912. <em>
  1913. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1914. </em>
  1915. </td>
  1916. <td>
  1917. <em>(Optional)</em>
  1918. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  1919. </td>
  1920. </tr>
  1921. <tr>
  1922. <td>
  1923. <code>appRole</code></br>
  1924. <em>
  1925. <a href="#external-secrets.io/v1alpha1.VaultAppRole">
  1926. VaultAppRole
  1927. </a>
  1928. </em>
  1929. </td>
  1930. <td>
  1931. <em>(Optional)</em>
  1932. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  1933. with the role and secret stored in a Kubernetes Secret resource.</p>
  1934. </td>
  1935. </tr>
  1936. <tr>
  1937. <td>
  1938. <code>kubernetes</code></br>
  1939. <em>
  1940. <a href="#external-secrets.io/v1alpha1.VaultKubernetesAuth">
  1941. VaultKubernetesAuth
  1942. </a>
  1943. </em>
  1944. </td>
  1945. <td>
  1946. <em>(Optional)</em>
  1947. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  1948. token stored in the named Secret resource to the Vault server.</p>
  1949. </td>
  1950. </tr>
  1951. <tr>
  1952. <td>
  1953. <code>ldap</code></br>
  1954. <em>
  1955. <a href="#external-secrets.io/v1alpha1.VaultLdapAuth">
  1956. VaultLdapAuth
  1957. </a>
  1958. </em>
  1959. </td>
  1960. <td>
  1961. <em>(Optional)</em>
  1962. <p>Ldap authenticates with Vault by passing username/password pair using
  1963. the LDAP authentication method</p>
  1964. </td>
  1965. </tr>
  1966. <tr>
  1967. <td>
  1968. <code>jwt</code></br>
  1969. <em>
  1970. <a href="#external-secrets.io/v1alpha1.VaultJwtAuth">
  1971. VaultJwtAuth
  1972. </a>
  1973. </em>
  1974. </td>
  1975. <td>
  1976. <em>(Optional)</em>
  1977. <p>Jwt authenticates with Vault by passing role and JWT token using the
  1978. JWT/OIDC authentication method</p>
  1979. </td>
  1980. </tr>
  1981. </tbody>
  1982. </table>
  1983. <h3 id="external-secrets.io/v1alpha1.VaultJwtAuth">VaultJwtAuth
  1984. </h3>
  1985. <p>
  1986. (<em>Appears on:</em>
  1987. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  1988. </p>
  1989. <p>
  1990. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  1991. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  1992. </p>
  1993. <table>
  1994. <thead>
  1995. <tr>
  1996. <th>Field</th>
  1997. <th>Description</th>
  1998. </tr>
  1999. </thead>
  2000. <tbody>
  2001. <tr>
  2002. <td>
  2003. <code>role</code></br>
  2004. <em>
  2005. string
  2006. </em>
  2007. </td>
  2008. <td>
  2009. <em>(Optional)</em>
  2010. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  2011. authentication method</p>
  2012. </td>
  2013. </tr>
  2014. <tr>
  2015. <td>
  2016. <code>secretRef</code></br>
  2017. <em>
  2018. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2019. </em>
  2020. </td>
  2021. <td>
  2022. <p>SecretRef to a key in a Secret resource containing JWT token to
  2023. authenticate with Vault using the JWT/OIDC authentication method</p>
  2024. </td>
  2025. </tr>
  2026. </tbody>
  2027. </table>
  2028. <h3 id="external-secrets.io/v1alpha1.VaultKVStoreVersion">VaultKVStoreVersion
  2029. (<code>string</code> alias)</p></h3>
  2030. <p>
  2031. (<em>Appears on:</em>
  2032. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  2033. </p>
  2034. <p>
  2035. </p>
  2036. <table>
  2037. <thead>
  2038. <tr>
  2039. <th>Value</th>
  2040. <th>Description</th>
  2041. </tr>
  2042. </thead>
  2043. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  2044. <td></td>
  2045. </tr><tr><td><p>&#34;v2&#34;</p></td>
  2046. <td></td>
  2047. </tr></tbody>
  2048. </table>
  2049. <h3 id="external-secrets.io/v1alpha1.VaultKubernetesAuth">VaultKubernetesAuth
  2050. </h3>
  2051. <p>
  2052. (<em>Appears on:</em>
  2053. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  2054. </p>
  2055. <p>
  2056. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  2057. a Secret.</p>
  2058. </p>
  2059. <table>
  2060. <thead>
  2061. <tr>
  2062. <th>Field</th>
  2063. <th>Description</th>
  2064. </tr>
  2065. </thead>
  2066. <tbody>
  2067. <tr>
  2068. <td>
  2069. <code>mountPath</code></br>
  2070. <em>
  2071. string
  2072. </em>
  2073. </td>
  2074. <td>
  2075. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  2076. &ldquo;kubernetes&rdquo;</p>
  2077. </td>
  2078. </tr>
  2079. <tr>
  2080. <td>
  2081. <code>serviceAccountRef</code></br>
  2082. <em>
  2083. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  2084. </em>
  2085. </td>
  2086. <td>
  2087. <em>(Optional)</em>
  2088. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  2089. If the service account is specified, the service account secret token JWT will be used
  2090. for authenticating with Vault. If the service account selector is not supplied,
  2091. the secretRef will be used instead.</p>
  2092. </td>
  2093. </tr>
  2094. <tr>
  2095. <td>
  2096. <code>secretRef</code></br>
  2097. <em>
  2098. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2099. </em>
  2100. </td>
  2101. <td>
  2102. <em>(Optional)</em>
  2103. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  2104. for authenticating with Vault. If a name is specified without a key,
  2105. <code>token</code> is the default. If one is not specified, the one bound to
  2106. the controller will be used.</p>
  2107. </td>
  2108. </tr>
  2109. <tr>
  2110. <td>
  2111. <code>role</code></br>
  2112. <em>
  2113. string
  2114. </em>
  2115. </td>
  2116. <td>
  2117. <p>A required field containing the Vault Role to assume. A Role binds a
  2118. Kubernetes ServiceAccount with a set of Vault policies.</p>
  2119. </td>
  2120. </tr>
  2121. </tbody>
  2122. </table>
  2123. <h3 id="external-secrets.io/v1alpha1.VaultLdapAuth">VaultLdapAuth
  2124. </h3>
  2125. <p>
  2126. (<em>Appears on:</em>
  2127. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  2128. </p>
  2129. <p>
  2130. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  2131. with the username and password stored in a Kubernetes Secret resource.</p>
  2132. </p>
  2133. <table>
  2134. <thead>
  2135. <tr>
  2136. <th>Field</th>
  2137. <th>Description</th>
  2138. </tr>
  2139. </thead>
  2140. <tbody>
  2141. <tr>
  2142. <td>
  2143. <code>username</code></br>
  2144. <em>
  2145. string
  2146. </em>
  2147. </td>
  2148. <td>
  2149. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  2150. authentication method</p>
  2151. </td>
  2152. </tr>
  2153. <tr>
  2154. <td>
  2155. <code>secretRef</code></br>
  2156. <em>
  2157. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2158. </em>
  2159. </td>
  2160. <td>
  2161. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  2162. user used to authenticate with Vault using the LDAP authentication
  2163. method</p>
  2164. </td>
  2165. </tr>
  2166. </tbody>
  2167. </table>
  2168. <h3 id="external-secrets.io/v1alpha1.VaultProvider">VaultProvider
  2169. </h3>
  2170. <p>
  2171. (<em>Appears on:</em>
  2172. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2173. </p>
  2174. <p>
  2175. <p>Configures an store to sync secrets using a HashiCorp Vault
  2176. KV backend.</p>
  2177. </p>
  2178. <table>
  2179. <thead>
  2180. <tr>
  2181. <th>Field</th>
  2182. <th>Description</th>
  2183. </tr>
  2184. </thead>
  2185. <tbody>
  2186. <tr>
  2187. <td>
  2188. <code>auth</code></br>
  2189. <em>
  2190. <a href="#external-secrets.io/v1alpha1.VaultAuth">
  2191. VaultAuth
  2192. </a>
  2193. </em>
  2194. </td>
  2195. <td>
  2196. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  2197. </td>
  2198. </tr>
  2199. <tr>
  2200. <td>
  2201. <code>server</code></br>
  2202. <em>
  2203. string
  2204. </em>
  2205. </td>
  2206. <td>
  2207. <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>
  2208. </td>
  2209. </tr>
  2210. <tr>
  2211. <td>
  2212. <code>path</code></br>
  2213. <em>
  2214. string
  2215. </em>
  2216. </td>
  2217. <td>
  2218. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  2219. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  2220. for fetching secrets from Vault is optional and will be appended
  2221. if not present in specified path.</p>
  2222. </td>
  2223. </tr>
  2224. <tr>
  2225. <td>
  2226. <code>version</code></br>
  2227. <em>
  2228. <a href="#external-secrets.io/v1alpha1.VaultKVStoreVersion">
  2229. VaultKVStoreVersion
  2230. </a>
  2231. </em>
  2232. </td>
  2233. <td>
  2234. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  2235. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  2236. </td>
  2237. </tr>
  2238. <tr>
  2239. <td>
  2240. <code>namespace</code></br>
  2241. <em>
  2242. string
  2243. </em>
  2244. </td>
  2245. <td>
  2246. <em>(Optional)</em>
  2247. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  2248. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  2249. 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>
  2250. </td>
  2251. </tr>
  2252. <tr>
  2253. <td>
  2254. <code>caBundle</code></br>
  2255. <em>
  2256. []byte
  2257. </em>
  2258. </td>
  2259. <td>
  2260. <em>(Optional)</em>
  2261. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  2262. if the Server URL is using HTTPS protocol. This parameter is ignored for
  2263. plain HTTP protocol connection. If not set the system root certificates
  2264. are used to validate the TLS connection.</p>
  2265. </td>
  2266. </tr>
  2267. </tbody>
  2268. </table>
  2269. <hr/>
  2270. <p><em>
  2271. Generated with <code>gen-crd-api-reference-docs</code>.
  2272. </em></p></p>
  2273. </article>
  2274. </div>
  2275. </div>
  2276. </main>
  2277. <footer class="md-footer">
  2278. <nav class="md-footer__inner md-grid" aria-label="Footer">
  2279. <a href="../provider-hashicorp-vault/" class="md-footer__link md-footer__link--prev" aria-label="Previous: HashiCorp Vault" rel="prev">
  2280. <div class="md-footer__button md-icon">
  2281. <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>
  2282. </div>
  2283. <div class="md-footer__title">
  2284. <div class="md-ellipsis">
  2285. <span class="md-footer__direction">
  2286. Previous
  2287. </span>
  2288. HashiCorp Vault
  2289. </div>
  2290. </div>
  2291. </a>
  2292. <a href="../contributing-devguide/" class="md-footer__link md-footer__link--next" aria-label="Next: Developer guide" rel="next">
  2293. <div class="md-footer__title">
  2294. <div class="md-ellipsis">
  2295. <span class="md-footer__direction">
  2296. Next
  2297. </span>
  2298. Developer guide
  2299. </div>
  2300. </div>
  2301. <div class="md-footer__button md-icon">
  2302. <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>
  2303. </div>
  2304. </a>
  2305. </nav>
  2306. <div class="md-footer-meta md-typeset">
  2307. <div class="md-footer-meta__inner md-grid">
  2308. <div class="md-footer-copyright">
  2309. Made with
  2310. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  2311. Material for MkDocs
  2312. </a>
  2313. </div>
  2314. </div>
  2315. </div>
  2316. </footer>
  2317. </div>
  2318. <div class="md-dialog" data-md-component="dialog">
  2319. <div class="md-dialog__inner md-typeset"></div>
  2320. </div>
  2321. <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>
  2322. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  2323. </body>
  2324. </html>