index.html 57 KB

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