index.html 40 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924
  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. <meta http-equiv="x-ua-compatible" content="ie=edge">
  7. <meta name="lang:clipboard.copy" content="Copy to clipboard">
  8. <meta name="lang:clipboard.copied" content="Copied to clipboard">
  9. <meta name="lang:search.language" content="en">
  10. <meta name="lang:search.pipeline.stopwords" content="True">
  11. <meta name="lang:search.pipeline.trimmer" content="True">
  12. <meta name="lang:search.result.none" content="No matching documents">
  13. <meta name="lang:search.result.one" content="1 matching document">
  14. <meta name="lang:search.result.other" content="# matching documents">
  15. <meta name="lang:search.tokenizer" content="[\s\-]+">
  16. <link rel="shortcut icon" href="../assets/images/favicon.png">
  17. <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.6.0">
  18. <title>API specification - External Secrets Operator</title>
  19. <link rel="stylesheet" href="../assets/stylesheets/application.1b62728e.css">
  20. <script src="../assets/javascripts/modernizr.268332fc.js"></script>
  21. <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
  22. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  23. <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
  24. <link rel="stylesheet" href="../assets/fonts/material-icons.css">
  25. </head>
  26. <body dir="ltr">
  27. <svg class="md-svg">
  28. <defs>
  29. <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
  30. </defs>
  31. </svg>
  32. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  33. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  34. <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
  35. <header class="md-header" data-md-component="header">
  36. <nav class="md-header-nav md-grid">
  37. <div class="md-flex">
  38. <div class="md-flex__cell md-flex__cell--shrink">
  39. <a href=".." title="External Secrets Operator" class="md-header-nav__button md-logo">
  40. <i class="md-icon"></i>
  41. </a>
  42. </div>
  43. <div class="md-flex__cell md-flex__cell--shrink">
  44. <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
  45. </div>
  46. <div class="md-flex__cell md-flex__cell--stretch">
  47. <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
  48. <span class="md-header-nav__topic">
  49. External Secrets Operator
  50. </span>
  51. <span class="md-header-nav__topic">
  52. API specification
  53. </span>
  54. </div>
  55. </div>
  56. <div class="md-flex__cell md-flex__cell--shrink">
  57. <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
  58. <div class="md-search" data-md-component="search" role="dialog">
  59. <label class="md-search__overlay" for="__search"></label>
  60. <div class="md-search__inner" role="search">
  61. <form class="md-search__form" name="search">
  62. <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
  63. <label class="md-icon md-search__icon" for="__search"></label>
  64. <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
  65. &#xE5CD;
  66. </button>
  67. </form>
  68. <div class="md-search__output">
  69. <div class="md-search__scrollwrap" data-md-scrollfix>
  70. <div class="md-search-result" data-md-component="result">
  71. <div class="md-search-result__meta">
  72. Type to start searching
  73. </div>
  74. <ol class="md-search-result__list"></ol>
  75. </div>
  76. </div>
  77. </div>
  78. </div>
  79. </div>
  80. </div>
  81. <div class="md-flex__cell md-flex__cell--shrink">
  82. <div class="md-header-nav__source">
  83. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-source="github">
  84. <div class="md-source__icon">
  85. <svg viewBox="0 0 24 24" width="24" height="24">
  86. <use xlink:href="#__github" width="24" height="24"></use>
  87. </svg>
  88. </div>
  89. <div class="md-source__repository">
  90. External Secrets Operator
  91. </div>
  92. </a>
  93. </div>
  94. </div>
  95. </div>
  96. </nav>
  97. </header>
  98. <div class="md-container">
  99. <main class="md-main" role="main">
  100. <div class="md-main__inner md-grid" data-md-component="container">
  101. <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
  102. <div class="md-sidebar__scrollwrap">
  103. <div class="md-sidebar__inner">
  104. <nav class="md-nav md-nav--primary" data-md-level="0">
  105. <label class="md-nav__title md-nav__title--site" for="__drawer">
  106. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo">
  107. <i class="md-icon"></i>
  108. </a>
  109. External Secrets Operator
  110. </label>
  111. <div class="md-nav__source">
  112. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-source="github">
  113. <div class="md-source__icon">
  114. <svg viewBox="0 0 24 24" width="24" height="24">
  115. <use xlink:href="#__github" width="24" height="24"></use>
  116. </svg>
  117. </div>
  118. <div class="md-source__repository">
  119. External Secrets Operator
  120. </div>
  121. </a>
  122. </div>
  123. <ul class="md-nav__list" data-md-scrollfix>
  124. <li class="md-nav__item">
  125. <a href=".." title="Introduction" class="md-nav__link">
  126. Introduction
  127. </a>
  128. </li>
  129. <li class="md-nav__item">
  130. <a href="../api-overview/" title="Overview" class="md-nav__link">
  131. Overview
  132. </a>
  133. </li>
  134. <li class="md-nav__item md-nav__item--nested">
  135. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
  136. <label class="md-nav__link" for="nav-3">
  137. API Types
  138. </label>
  139. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  140. <label class="md-nav__title" for="nav-3">
  141. API Types
  142. </label>
  143. <ul class="md-nav__list" data-md-scrollfix>
  144. <li class="md-nav__item">
  145. <a href="../api-externalsecret/" title="ExternalSecret" class="md-nav__link">
  146. ExternalSecret
  147. </a>
  148. </li>
  149. <li class="md-nav__item">
  150. <a href="../api-secretstore/" title="SecretStore" class="md-nav__link">
  151. SecretStore
  152. </a>
  153. </li>
  154. <li class="md-nav__item">
  155. <a href="../api-clustersecretstore/" title="ClusterSecretStore" class="md-nav__link">
  156. ClusterSecretStore
  157. </a>
  158. </li>
  159. </ul>
  160. </nav>
  161. </li>
  162. <li class="md-nav__item md-nav__item--nested">
  163. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
  164. <label class="md-nav__link" for="nav-4">
  165. Guides
  166. </label>
  167. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  168. <label class="md-nav__title" for="nav-4">
  169. Guides
  170. </label>
  171. <ul class="md-nav__list" data-md-scrollfix>
  172. <li class="md-nav__item">
  173. <a href="../guides-introduction/" title="Introduction" class="md-nav__link">
  174. Introduction
  175. </a>
  176. </li>
  177. <li class="md-nav__item">
  178. <a href="../guides-getting-started/" title="Getting started" class="md-nav__link">
  179. Getting started
  180. </a>
  181. </li>
  182. <li class="md-nav__item">
  183. <a href="../guides-templating/" title="Advanced Templating" class="md-nav__link">
  184. Advanced Templating
  185. </a>
  186. </li>
  187. <li class="md-nav__item">
  188. <a href="../guides-multi-tenancy/" title="Multi Tenancy" class="md-nav__link">
  189. Multi Tenancy
  190. </a>
  191. </li>
  192. </ul>
  193. </nav>
  194. </li>
  195. <li class="md-nav__item md-nav__item--nested">
  196. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
  197. <label class="md-nav__link" for="nav-5">
  198. Provider
  199. </label>
  200. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  201. <label class="md-nav__title" for="nav-5">
  202. Provider
  203. </label>
  204. <ul class="md-nav__list" data-md-scrollfix>
  205. <li class="md-nav__item md-nav__item--nested">
  206. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1">
  207. <label class="md-nav__link" for="nav-5-1">
  208. AWS
  209. </label>
  210. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  211. <label class="md-nav__title" for="nav-5-1">
  212. AWS
  213. </label>
  214. <ul class="md-nav__list" data-md-scrollfix>
  215. <li class="md-nav__item">
  216. <a href="../provider-aws-secrets-manager/" title="Secrets Manager" class="md-nav__link">
  217. Secrets Manager
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../provider-aws-parameter-store/" title="Parameter Store" class="md-nav__link">
  222. Parameter Store
  223. </a>
  224. </li>
  225. </ul>
  226. </nav>
  227. </li>
  228. <li class="md-nav__item md-nav__item--nested">
  229. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-2" type="checkbox" id="nav-5-2">
  230. <label class="md-nav__link" for="nav-5-2">
  231. Azure
  232. </label>
  233. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  234. <label class="md-nav__title" for="nav-5-2">
  235. Azure
  236. </label>
  237. <ul class="md-nav__list" data-md-scrollfix>
  238. <li class="md-nav__item">
  239. <a href="../provider-azure-key-vault/" title="Key Vault" class="md-nav__link">
  240. Key Vault
  241. </a>
  242. </li>
  243. </ul>
  244. </nav>
  245. </li>
  246. <li class="md-nav__item md-nav__item--nested">
  247. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-3" type="checkbox" id="nav-5-3">
  248. <label class="md-nav__link" for="nav-5-3">
  249. Google
  250. </label>
  251. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  252. <label class="md-nav__title" for="nav-5-3">
  253. Google
  254. </label>
  255. <ul class="md-nav__list" data-md-scrollfix>
  256. <li class="md-nav__item">
  257. <a href="../provider-google-secrets-manager/" title="Secrets Manager" class="md-nav__link">
  258. Secrets Manager
  259. </a>
  260. </li>
  261. </ul>
  262. </nav>
  263. </li>
  264. <li class="md-nav__item">
  265. <a href="../provider-hashicorp-vault/" title="HashiCorp Vault" class="md-nav__link">
  266. HashiCorp Vault
  267. </a>
  268. </li>
  269. </ul>
  270. </nav>
  271. </li>
  272. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  273. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6" checked>
  274. <label class="md-nav__link" for="nav-6">
  275. References
  276. </label>
  277. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  278. <label class="md-nav__title" for="nav-6">
  279. References
  280. </label>
  281. <ul class="md-nav__list" data-md-scrollfix>
  282. <li class="md-nav__item md-nav__item--active">
  283. <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  284. <a href="./" title="API specification" class="md-nav__link md-nav__link--active">
  285. API specification
  286. </a>
  287. </li>
  288. </ul>
  289. </nav>
  290. </li>
  291. <li class="md-nav__item md-nav__item--nested">
  292. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
  293. <label class="md-nav__link" for="nav-7">
  294. Contributing
  295. </label>
  296. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  297. <label class="md-nav__title" for="nav-7">
  298. Contributing
  299. </label>
  300. <ul class="md-nav__list" data-md-scrollfix>
  301. <li class="md-nav__item">
  302. <a href="../contributing-devguide/" title="Developer guide" class="md-nav__link">
  303. Developer guide
  304. </a>
  305. </li>
  306. <li class="md-nav__item">
  307. <a href="../contributing-process/" title="Contributing Process" class="md-nav__link">
  308. Contributing Process
  309. </a>
  310. </li>
  311. <li class="md-nav__item">
  312. <a href="../contributing-coc/" title="Code of Conduct" class="md-nav__link">
  313. Code of Conduct
  314. </a>
  315. </li>
  316. </ul>
  317. </nav>
  318. </li>
  319. </ul>
  320. </nav>
  321. </div>
  322. </div>
  323. </div>
  324. <div class="md-content">
  325. <article class="md-content__inner md-typeset">
  326. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/spec.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
  327. <h1>API specification</h1>
  328. <p>Packages:</p>
  329. <ul>
  330. <li>
  331. <a href="#external-secrets.io%2fv1alpha1">external-secrets.io/v1alpha1</a>
  332. </li>
  333. </ul>
  334. <h2 id="external-secrets.io/v1alpha1">external-secrets.io/v1alpha1</h2>
  335. <p>
  336. <p>Package v1alpha1 contains resources for external-secrets</p>
  337. </p>
  338. <p>Resource Types:
  339. <ul></ul>
  340. <h3 id="external-secrets.io/v1alpha1.AWSAuth">AWSAuth
  341. </h3>
  342. <p>
  343. (<em>Appears on:</em>
  344. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
  345. </p>
  346. <p>
  347. <p>AWSAuth contains a secretRef for credentials.</p>
  348. </p>
  349. <table>
  350. <thead>
  351. <tr>
  352. <th>Field</th>
  353. <th>Description</th>
  354. </tr>
  355. </thead>
  356. <tbody>
  357. <tr>
  358. <td>
  359. <code>secretRef</code></br>
  360. <em>
  361. <a href="#external-secrets.io/v1alpha1.AWSAuthSecretRef">
  362. AWSAuthSecretRef
  363. </a>
  364. </em>
  365. </td>
  366. <td>
  367. </td>
  368. </tr>
  369. </tbody>
  370. </table>
  371. <h3 id="external-secrets.io/v1alpha1.AWSAuthSecretRef">AWSAuthSecretRef
  372. </h3>
  373. <p>
  374. (<em>Appears on:</em>
  375. <a href="#external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
  376. </p>
  377. <p>
  378. <p>AWSAuthSecretRef holds secret references for aws credentials
  379. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  380. </p>
  381. <table>
  382. <thead>
  383. <tr>
  384. <th>Field</th>
  385. <th>Description</th>
  386. </tr>
  387. </thead>
  388. <tbody>
  389. <tr>
  390. <td>
  391. <code>accessKeyIDSecretRef</code></br>
  392. <em>
  393. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  394. </em>
  395. </td>
  396. <td>
  397. <p>The AccessKeyID is used for authentication</p>
  398. </td>
  399. </tr>
  400. <tr>
  401. <td>
  402. <code>secretAccessKeySecretRef</code></br>
  403. <em>
  404. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  405. </em>
  406. </td>
  407. <td>
  408. <p>The SecretAccessKey is used for authentication</p>
  409. </td>
  410. </tr>
  411. </tbody>
  412. </table>
  413. <h3 id="external-secrets.io/v1alpha1.AWSProvider">AWSProvider
  414. </h3>
  415. <p>
  416. (<em>Appears on:</em>
  417. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  418. </p>
  419. <p>
  420. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  421. </p>
  422. <table>
  423. <thead>
  424. <tr>
  425. <th>Field</th>
  426. <th>Description</th>
  427. </tr>
  428. </thead>
  429. <tbody>
  430. <tr>
  431. <td>
  432. <code>service</code></br>
  433. <em>
  434. <a href="#external-secrets.io/v1alpha1.AWSServiceType">
  435. AWSServiceType
  436. </a>
  437. </em>
  438. </td>
  439. <td>
  440. <p>Service defines which service should be used to fetch the secrets</p>
  441. </td>
  442. </tr>
  443. <tr>
  444. <td>
  445. <code>auth</code></br>
  446. <em>
  447. <a href="#external-secrets.io/v1alpha1.AWSAuth">
  448. AWSAuth
  449. </a>
  450. </em>
  451. </td>
  452. <td>
  453. <em>(Optional)</em>
  454. <p>Auth defines the information necessary to authenticate against AWS
  455. if not set aws sdk will infer credentials from your environment
  456. 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>
  457. </td>
  458. </tr>
  459. <tr>
  460. <td>
  461. <code>role</code></br>
  462. <em>
  463. string
  464. </em>
  465. </td>
  466. <td>
  467. <em>(Optional)</em>
  468. <p>Role is a Role ARN which the SecretManager provider will assume</p>
  469. </td>
  470. </tr>
  471. <tr>
  472. <td>
  473. <code>region</code></br>
  474. <em>
  475. string
  476. </em>
  477. </td>
  478. <td>
  479. <p>AWS Region to be used for the provider</p>
  480. </td>
  481. </tr>
  482. </tbody>
  483. </table>
  484. <h3 id="external-secrets.io/v1alpha1.AWSServiceType">AWSServiceType
  485. (<code>string</code> alias)</p></h3>
  486. <p>
  487. (<em>Appears on:</em>
  488. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
  489. </p>
  490. <p>
  491. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  492. </p>
  493. <table>
  494. <thead>
  495. <tr>
  496. <th>Value</th>
  497. <th>Description</th>
  498. </tr>
  499. </thead>
  500. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  501. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore.
  502. 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>
  503. </td>
  504. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  505. <td><p>AWSServiceSecretsManager is the AWS SecretsManager.
  506. 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>
  507. </td>
  508. </tr></tbody>
  509. </table>
  510. <h3 id="external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore
  511. </h3>
  512. <p>
  513. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  514. </p>
  515. <table>
  516. <thead>
  517. <tr>
  518. <th>Field</th>
  519. <th>Description</th>
  520. </tr>
  521. </thead>
  522. <tbody>
  523. <tr>
  524. <td>
  525. <code>metadata</code></br>
  526. <em>
  527. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  528. Kubernetes meta/v1.ObjectMeta
  529. </a>
  530. </em>
  531. </td>
  532. <td>
  533. Refer to the Kubernetes API documentation for the fields of the
  534. <code>metadata</code> field.
  535. </td>
  536. </tr>
  537. <tr>
  538. <td>
  539. <code>spec</code></br>
  540. <em>
  541. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  542. SecretStoreSpec
  543. </a>
  544. </em>
  545. </td>
  546. <td>
  547. <br/>
  548. <br/>
  549. <table>
  550. <tr>
  551. <td>
  552. <code>controller</code></br>
  553. <em>
  554. string
  555. </em>
  556. </td>
  557. <td>
  558. <em>(Optional)</em>
  559. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  560. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  561. </td>
  562. </tr>
  563. <tr>
  564. <td>
  565. <code>provider</code></br>
  566. <em>
  567. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  568. SecretStoreProvider
  569. </a>
  570. </em>
  571. </td>
  572. <td>
  573. <p>Used to configure the provider. Only one provider may be set</p>
  574. </td>
  575. </tr>
  576. </table>
  577. </td>
  578. </tr>
  579. </tbody>
  580. </table>
  581. <h3 id="external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret
  582. </h3>
  583. <p>
  584. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  585. </p>
  586. <table>
  587. <thead>
  588. <tr>
  589. <th>Field</th>
  590. <th>Description</th>
  591. </tr>
  592. </thead>
  593. <tbody>
  594. <tr>
  595. <td>
  596. <code>metadata</code></br>
  597. <em>
  598. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  599. Kubernetes meta/v1.ObjectMeta
  600. </a>
  601. </em>
  602. </td>
  603. <td>
  604. Refer to the Kubernetes API documentation for the fields of the
  605. <code>metadata</code> field.
  606. </td>
  607. </tr>
  608. <tr>
  609. <td>
  610. <code>spec</code></br>
  611. <em>
  612. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">
  613. ExternalSecretSpec
  614. </a>
  615. </em>
  616. </td>
  617. <td>
  618. <br/>
  619. <br/>
  620. <table>
  621. <tr>
  622. <td>
  623. <code>secretStoreRef</code></br>
  624. <em>
  625. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  626. SecretStoreRef
  627. </a>
  628. </em>
  629. </td>
  630. <td>
  631. </td>
  632. </tr>
  633. <tr>
  634. <td>
  635. <code>target</code></br>
  636. <em>
  637. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  638. ExternalSecretTarget
  639. </a>
  640. </em>
  641. </td>
  642. <td>
  643. </td>
  644. </tr>
  645. <tr>
  646. <td>
  647. <code>refreshInterval</code></br>
  648. <em>
  649. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  650. Kubernetes meta/v1.Duration
  651. </a>
  652. </em>
  653. </td>
  654. <td>
  655. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  656. 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;
  657. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  658. </td>
  659. </tr>
  660. <tr>
  661. <td>
  662. <code>data</code></br>
  663. <em>
  664. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  665. []ExternalSecretData
  666. </a>
  667. </em>
  668. </td>
  669. <td>
  670. <em>(Optional)</em>
  671. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  672. </td>
  673. </tr>
  674. <tr>
  675. <td>
  676. <code>dataFrom</code></br>
  677. <em>
  678. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  679. []ExternalSecretDataRemoteRef
  680. </a>
  681. </em>
  682. </td>
  683. <td>
  684. <em>(Optional)</em>
  685. <p>DataFrom is used to fetch all properties from a specific Provider data
  686. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  687. </td>
  688. </tr>
  689. </table>
  690. </td>
  691. </tr>
  692. <tr>
  693. <td>
  694. <code>status</code></br>
  695. <em>
  696. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">
  697. ExternalSecretStatus
  698. </a>
  699. </em>
  700. </td>
  701. <td>
  702. </td>
  703. </tr>
  704. </tbody>
  705. </table>
  706. <h3 id="external-secrets.io/v1alpha1.ExternalSecretConditionType">ExternalSecretConditionType
  707. (<code>string</code> alias)</p></h3>
  708. <p>
  709. (<em>Appears on:</em>
  710. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  711. </p>
  712. <p>
  713. </p>
  714. <table>
  715. <thead>
  716. <tr>
  717. <th>Value</th>
  718. <th>Description</th>
  719. </tr>
  720. </thead>
  721. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  722. <td></td>
  723. </tr></tbody>
  724. </table>
  725. <h3 id="external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  726. (<code>string</code> alias)</p></h3>
  727. <p>
  728. (<em>Appears on:</em>
  729. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  730. </p>
  731. <p>
  732. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  733. </p>
  734. <table>
  735. <thead>
  736. <tr>
  737. <th>Value</th>
  738. <th>Description</th>
  739. </tr>
  740. </thead>
  741. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  742. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  743. </td>
  744. </tr><tr><td><p>&#34;None&#34;</p></td>
  745. <td><p>None does not create a Secret (future use with injector).</p>
  746. </td>
  747. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  748. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  749. </td>
  750. </tr></tbody>
  751. </table>
  752. <h3 id="external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData
  753. </h3>
  754. <p>
  755. (<em>Appears on:</em>
  756. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  757. </p>
  758. <p>
  759. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  760. </p>
  761. <table>
  762. <thead>
  763. <tr>
  764. <th>Field</th>
  765. <th>Description</th>
  766. </tr>
  767. </thead>
  768. <tbody>
  769. <tr>
  770. <td>
  771. <code>secretKey</code></br>
  772. <em>
  773. string
  774. </em>
  775. </td>
  776. <td>
  777. </td>
  778. </tr>
  779. <tr>
  780. <td>
  781. <code>remoteRef</code></br>
  782. <em>
  783. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  784. ExternalSecretDataRemoteRef
  785. </a>
  786. </em>
  787. </td>
  788. <td>
  789. </td>
  790. </tr>
  791. </tbody>
  792. </table>
  793. <h3 id="external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  794. </h3>
  795. <p>
  796. (<em>Appears on:</em>
  797. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData</a>,
  798. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  799. </p>
  800. <p>
  801. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  802. </p>
  803. <table>
  804. <thead>
  805. <tr>
  806. <th>Field</th>
  807. <th>Description</th>
  808. </tr>
  809. </thead>
  810. <tbody>
  811. <tr>
  812. <td>
  813. <code>key</code></br>
  814. <em>
  815. string
  816. </em>
  817. </td>
  818. <td>
  819. <p>Key is the key used in the Provider, mandatory</p>
  820. </td>
  821. </tr>
  822. <tr>
  823. <td>
  824. <code>version</code></br>
  825. <em>
  826. string
  827. </em>
  828. </td>
  829. <td>
  830. <em>(Optional)</em>
  831. <p>Used to select a specific version of the Provider value, if supported</p>
  832. </td>
  833. </tr>
  834. <tr>
  835. <td>
  836. <code>property</code></br>
  837. <em>
  838. string
  839. </em>
  840. </td>
  841. <td>
  842. <em>(Optional)</em>
  843. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  844. </td>
  845. </tr>
  846. </tbody>
  847. </table>
  848. <h3 id="external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec
  849. </h3>
  850. <p>
  851. (<em>Appears on:</em>
  852. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  853. </p>
  854. <p>
  855. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  856. </p>
  857. <table>
  858. <thead>
  859. <tr>
  860. <th>Field</th>
  861. <th>Description</th>
  862. </tr>
  863. </thead>
  864. <tbody>
  865. <tr>
  866. <td>
  867. <code>secretStoreRef</code></br>
  868. <em>
  869. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  870. SecretStoreRef
  871. </a>
  872. </em>
  873. </td>
  874. <td>
  875. </td>
  876. </tr>
  877. <tr>
  878. <td>
  879. <code>target</code></br>
  880. <em>
  881. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  882. ExternalSecretTarget
  883. </a>
  884. </em>
  885. </td>
  886. <td>
  887. </td>
  888. </tr>
  889. <tr>
  890. <td>
  891. <code>refreshInterval</code></br>
  892. <em>
  893. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  894. Kubernetes meta/v1.Duration
  895. </a>
  896. </em>
  897. </td>
  898. <td>
  899. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  900. 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;
  901. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  902. </td>
  903. </tr>
  904. <tr>
  905. <td>
  906. <code>data</code></br>
  907. <em>
  908. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  909. []ExternalSecretData
  910. </a>
  911. </em>
  912. </td>
  913. <td>
  914. <em>(Optional)</em>
  915. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  916. </td>
  917. </tr>
  918. <tr>
  919. <td>
  920. <code>dataFrom</code></br>
  921. <em>
  922. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  923. []ExternalSecretDataRemoteRef
  924. </a>
  925. </em>
  926. </td>
  927. <td>
  928. <em>(Optional)</em>
  929. <p>DataFrom is used to fetch all properties from a specific Provider data
  930. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  931. </td>
  932. </tr>
  933. </tbody>
  934. </table>
  935. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus
  936. </h3>
  937. <p>
  938. (<em>Appears on:</em>
  939. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  940. </p>
  941. <p>
  942. </p>
  943. <table>
  944. <thead>
  945. <tr>
  946. <th>Field</th>
  947. <th>Description</th>
  948. </tr>
  949. </thead>
  950. <tbody>
  951. <tr>
  952. <td>
  953. <code>refreshTime</code></br>
  954. <em>
  955. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  956. Kubernetes meta/v1.Time
  957. </a>
  958. </em>
  959. </td>
  960. <td>
  961. <p>refreshTime is the time and date the external secret was fetched and
  962. the target secret updated</p>
  963. </td>
  964. </tr>
  965. <tr>
  966. <td>
  967. <code>conditions</code></br>
  968. <em>
  969. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">
  970. []ExternalSecretStatusCondition
  971. </a>
  972. </em>
  973. </td>
  974. <td>
  975. <em>(Optional)</em>
  976. </td>
  977. </tr>
  978. </tbody>
  979. </table>
  980. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  981. </h3>
  982. <p>
  983. (<em>Appears on:</em>
  984. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus</a>)
  985. </p>
  986. <p>
  987. </p>
  988. <table>
  989. <thead>
  990. <tr>
  991. <th>Field</th>
  992. <th>Description</th>
  993. </tr>
  994. </thead>
  995. <tbody>
  996. <tr>
  997. <td>
  998. <code>type</code></br>
  999. <em>
  1000. <a href="#external-secrets.io/v1alpha1.ExternalSecretConditionType">
  1001. ExternalSecretConditionType
  1002. </a>
  1003. </em>
  1004. </td>
  1005. <td>
  1006. </td>
  1007. </tr>
  1008. <tr>
  1009. <td>
  1010. <code>status</code></br>
  1011. <em>
  1012. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  1013. Kubernetes core/v1.ConditionStatus
  1014. </a>
  1015. </em>
  1016. </td>
  1017. <td>
  1018. </td>
  1019. </tr>
  1020. <tr>
  1021. <td>
  1022. <code>reason</code></br>
  1023. <em>
  1024. string
  1025. </em>
  1026. </td>
  1027. <td>
  1028. <em>(Optional)</em>
  1029. </td>
  1030. </tr>
  1031. <tr>
  1032. <td>
  1033. <code>message</code></br>
  1034. <em>
  1035. string
  1036. </em>
  1037. </td>
  1038. <td>
  1039. <em>(Optional)</em>
  1040. </td>
  1041. </tr>
  1042. <tr>
  1043. <td>
  1044. <code>lastTransitionTime</code></br>
  1045. <em>
  1046. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1047. Kubernetes meta/v1.Time
  1048. </a>
  1049. </em>
  1050. </td>
  1051. <td>
  1052. <em>(Optional)</em>
  1053. </td>
  1054. </tr>
  1055. </tbody>
  1056. </table>
  1057. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget
  1058. </h3>
  1059. <p>
  1060. (<em>Appears on:</em>
  1061. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1062. </p>
  1063. <p>
  1064. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  1065. There can be only one target per ExternalSecret.</p>
  1066. </p>
  1067. <table>
  1068. <thead>
  1069. <tr>
  1070. <th>Field</th>
  1071. <th>Description</th>
  1072. </tr>
  1073. </thead>
  1074. <tbody>
  1075. <tr>
  1076. <td>
  1077. <code>name</code></br>
  1078. <em>
  1079. string
  1080. </em>
  1081. </td>
  1082. <td>
  1083. <em>(Optional)</em>
  1084. <p>Name defines the name of the Secret resource to be managed
  1085. This field is immutable
  1086. Defaults to the .metadata.name of the ExternalSecret resource</p>
  1087. </td>
  1088. </tr>
  1089. <tr>
  1090. <td>
  1091. <code>creationPolicy</code></br>
  1092. <em>
  1093. <a href="#external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">
  1094. ExternalSecretCreationPolicy
  1095. </a>
  1096. </em>
  1097. </td>
  1098. <td>
  1099. <em>(Optional)</em>
  1100. <p>CreationPolicy defines rules on how to create the resulting Secret
  1101. Defaults to &lsquo;Owner&rsquo;</p>
  1102. </td>
  1103. </tr>
  1104. </tbody>
  1105. </table>
  1106. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate
  1107. </h3>
  1108. <p>
  1109. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.</p>
  1110. </p>
  1111. <table>
  1112. <thead>
  1113. <tr>
  1114. <th>Field</th>
  1115. <th>Description</th>
  1116. </tr>
  1117. </thead>
  1118. <tbody>
  1119. <tr>
  1120. <td>
  1121. <code>type</code></br>
  1122. <em>
  1123. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secrettype-v1-core">
  1124. Kubernetes core/v1.SecretType
  1125. </a>
  1126. </em>
  1127. </td>
  1128. <td>
  1129. <em>(Optional)</em>
  1130. </td>
  1131. </tr>
  1132. <tr>
  1133. <td>
  1134. <code>metadata</code></br>
  1135. <em>
  1136. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">
  1137. ExternalSecretTemplateMetadata
  1138. </a>
  1139. </em>
  1140. </td>
  1141. <td>
  1142. <em>(Optional)</em>
  1143. </td>
  1144. </tr>
  1145. </tbody>
  1146. </table>
  1147. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  1148. </h3>
  1149. <p>
  1150. (<em>Appears on:</em>
  1151. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  1152. </p>
  1153. <p>
  1154. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  1155. </p>
  1156. <table>
  1157. <thead>
  1158. <tr>
  1159. <th>Field</th>
  1160. <th>Description</th>
  1161. </tr>
  1162. </thead>
  1163. <tbody>
  1164. <tr>
  1165. <td>
  1166. <code>annotations</code></br>
  1167. <em>
  1168. map[string]string
  1169. </em>
  1170. </td>
  1171. <td>
  1172. <em>(Optional)</em>
  1173. </td>
  1174. </tr>
  1175. <tr>
  1176. <td>
  1177. <code>labels</code></br>
  1178. <em>
  1179. map[string]string
  1180. </em>
  1181. </td>
  1182. <td>
  1183. <em>(Optional)</em>
  1184. </td>
  1185. </tr>
  1186. </tbody>
  1187. </table>
  1188. <h3 id="external-secrets.io/v1alpha1.GenericStore">GenericStore
  1189. </h3>
  1190. <p>
  1191. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  1192. or a namespaced SecretStore.</p>
  1193. </p>
  1194. <h3 id="external-secrets.io/v1alpha1.SecretStore">SecretStore
  1195. </h3>
  1196. <p>
  1197. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  1198. </p>
  1199. <table>
  1200. <thead>
  1201. <tr>
  1202. <th>Field</th>
  1203. <th>Description</th>
  1204. </tr>
  1205. </thead>
  1206. <tbody>
  1207. <tr>
  1208. <td>
  1209. <code>metadata</code></br>
  1210. <em>
  1211. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1212. Kubernetes meta/v1.ObjectMeta
  1213. </a>
  1214. </em>
  1215. </td>
  1216. <td>
  1217. Refer to the Kubernetes API documentation for the fields of the
  1218. <code>metadata</code> field.
  1219. </td>
  1220. </tr>
  1221. <tr>
  1222. <td>
  1223. <code>spec</code></br>
  1224. <em>
  1225. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  1226. SecretStoreSpec
  1227. </a>
  1228. </em>
  1229. </td>
  1230. <td>
  1231. <br/>
  1232. <br/>
  1233. <table>
  1234. <tr>
  1235. <td>
  1236. <code>controller</code></br>
  1237. <em>
  1238. string
  1239. </em>
  1240. </td>
  1241. <td>
  1242. <em>(Optional)</em>
  1243. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  1244. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  1245. </td>
  1246. </tr>
  1247. <tr>
  1248. <td>
  1249. <code>provider</code></br>
  1250. <em>
  1251. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  1252. SecretStoreProvider
  1253. </a>
  1254. </em>
  1255. </td>
  1256. <td>
  1257. <p>Used to configure the provider. Only one provider may be set</p>
  1258. </td>
  1259. </tr>
  1260. </table>
  1261. </td>
  1262. </tr>
  1263. <tr>
  1264. <td>
  1265. <code>status</code></br>
  1266. <em>
  1267. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  1268. SecretStoreStatus
  1269. </a>
  1270. </em>
  1271. </td>
  1272. <td>
  1273. </td>
  1274. </tr>
  1275. </tbody>
  1276. </table>
  1277. <h3 id="external-secrets.io/v1alpha1.SecretStoreConditionType">SecretStoreConditionType
  1278. (<code>string</code> alias)</p></h3>
  1279. <p>
  1280. (<em>Appears on:</em>
  1281. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  1282. </p>
  1283. <p>
  1284. </p>
  1285. <table>
  1286. <thead>
  1287. <tr>
  1288. <th>Value</th>
  1289. <th>Description</th>
  1290. </tr>
  1291. </thead>
  1292. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  1293. <td></td>
  1294. </tr></tbody>
  1295. </table>
  1296. <h3 id="external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider
  1297. </h3>
  1298. <p>
  1299. (<em>Appears on:</em>
  1300. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec</a>)
  1301. </p>
  1302. <p>
  1303. <p>SecretStoreProvider contains the provider-specific configration.</p>
  1304. </p>
  1305. <table>
  1306. <thead>
  1307. <tr>
  1308. <th>Field</th>
  1309. <th>Description</th>
  1310. </tr>
  1311. </thead>
  1312. <tbody>
  1313. <tr>
  1314. <td>
  1315. <code>aws</code></br>
  1316. <em>
  1317. <a href="#external-secrets.io/v1alpha1.AWSProvider">
  1318. AWSProvider
  1319. </a>
  1320. </em>
  1321. </td>
  1322. <td>
  1323. <em>(Optional)</em>
  1324. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  1325. </td>
  1326. </tr>
  1327. </tbody>
  1328. </table>
  1329. <h3 id="external-secrets.io/v1alpha1.SecretStoreRef">SecretStoreRef
  1330. </h3>
  1331. <p>
  1332. (<em>Appears on:</em>
  1333. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1334. </p>
  1335. <p>
  1336. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  1337. </p>
  1338. <table>
  1339. <thead>
  1340. <tr>
  1341. <th>Field</th>
  1342. <th>Description</th>
  1343. </tr>
  1344. </thead>
  1345. <tbody>
  1346. <tr>
  1347. <td>
  1348. <code>name</code></br>
  1349. <em>
  1350. string
  1351. </em>
  1352. </td>
  1353. <td>
  1354. <p>Name of the SecretStore resource</p>
  1355. </td>
  1356. </tr>
  1357. <tr>
  1358. <td>
  1359. <code>kind</code></br>
  1360. <em>
  1361. string
  1362. </em>
  1363. </td>
  1364. <td>
  1365. <em>(Optional)</em>
  1366. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  1367. Defaults to <code>SecretStore</code></p>
  1368. </td>
  1369. </tr>
  1370. </tbody>
  1371. </table>
  1372. <h3 id="external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec
  1373. </h3>
  1374. <p>
  1375. (<em>Appears on:</em>
  1376. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  1377. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  1378. </p>
  1379. <p>
  1380. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  1381. </p>
  1382. <table>
  1383. <thead>
  1384. <tr>
  1385. <th>Field</th>
  1386. <th>Description</th>
  1387. </tr>
  1388. </thead>
  1389. <tbody>
  1390. <tr>
  1391. <td>
  1392. <code>controller</code></br>
  1393. <em>
  1394. string
  1395. </em>
  1396. </td>
  1397. <td>
  1398. <em>(Optional)</em>
  1399. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  1400. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  1401. </td>
  1402. </tr>
  1403. <tr>
  1404. <td>
  1405. <code>provider</code></br>
  1406. <em>
  1407. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  1408. SecretStoreProvider
  1409. </a>
  1410. </em>
  1411. </td>
  1412. <td>
  1413. <p>Used to configure the provider. Only one provider may be set</p>
  1414. </td>
  1415. </tr>
  1416. </tbody>
  1417. </table>
  1418. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus
  1419. </h3>
  1420. <p>
  1421. (<em>Appears on:</em>
  1422. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  1423. </p>
  1424. <p>
  1425. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  1426. </p>
  1427. <table>
  1428. <thead>
  1429. <tr>
  1430. <th>Field</th>
  1431. <th>Description</th>
  1432. </tr>
  1433. </thead>
  1434. <tbody>
  1435. <tr>
  1436. <td>
  1437. <code>conditions</code></br>
  1438. <em>
  1439. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">
  1440. []SecretStoreStatusCondition
  1441. </a>
  1442. </em>
  1443. </td>
  1444. <td>
  1445. <em>(Optional)</em>
  1446. </td>
  1447. </tr>
  1448. </tbody>
  1449. </table>
  1450. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition
  1451. </h3>
  1452. <p>
  1453. (<em>Appears on:</em>
  1454. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus</a>)
  1455. </p>
  1456. <p>
  1457. </p>
  1458. <table>
  1459. <thead>
  1460. <tr>
  1461. <th>Field</th>
  1462. <th>Description</th>
  1463. </tr>
  1464. </thead>
  1465. <tbody>
  1466. <tr>
  1467. <td>
  1468. <code>type</code></br>
  1469. <em>
  1470. <a href="#external-secrets.io/v1alpha1.SecretStoreConditionType">
  1471. SecretStoreConditionType
  1472. </a>
  1473. </em>
  1474. </td>
  1475. <td>
  1476. </td>
  1477. </tr>
  1478. <tr>
  1479. <td>
  1480. <code>status</code></br>
  1481. <em>
  1482. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  1483. Kubernetes core/v1.ConditionStatus
  1484. </a>
  1485. </em>
  1486. </td>
  1487. <td>
  1488. </td>
  1489. </tr>
  1490. <tr>
  1491. <td>
  1492. <code>reason</code></br>
  1493. <em>
  1494. string
  1495. </em>
  1496. </td>
  1497. <td>
  1498. <em>(Optional)</em>
  1499. </td>
  1500. </tr>
  1501. <tr>
  1502. <td>
  1503. <code>message</code></br>
  1504. <em>
  1505. string
  1506. </em>
  1507. </td>
  1508. <td>
  1509. <em>(Optional)</em>
  1510. </td>
  1511. </tr>
  1512. <tr>
  1513. <td>
  1514. <code>lastTransitionTime</code></br>
  1515. <em>
  1516. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1517. Kubernetes meta/v1.Time
  1518. </a>
  1519. </em>
  1520. </td>
  1521. <td>
  1522. <em>(Optional)</em>
  1523. </td>
  1524. </tr>
  1525. </tbody>
  1526. </table>
  1527. <hr/>
  1528. <p><em>
  1529. Generated with <code>gen-crd-api-reference-docs</code>.
  1530. </em></p></p>
  1531. </article>
  1532. </div>
  1533. </div>
  1534. </main>
  1535. <footer class="md-footer">
  1536. <div class="md-footer-nav">
  1537. <nav class="md-footer-nav__inner md-grid">
  1538. <a href="../provider-hashicorp-vault/" title="HashiCorp Vault" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
  1539. <div class="md-flex__cell md-flex__cell--shrink">
  1540. <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
  1541. </div>
  1542. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  1543. <span class="md-flex__ellipsis">
  1544. <span class="md-footer-nav__direction">
  1545. Previous
  1546. </span>
  1547. HashiCorp Vault
  1548. </span>
  1549. </div>
  1550. </a>
  1551. <a href="../contributing-devguide/" title="Developer guide" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
  1552. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  1553. <span class="md-flex__ellipsis">
  1554. <span class="md-footer-nav__direction">
  1555. Next
  1556. </span>
  1557. Developer guide
  1558. </span>
  1559. </div>
  1560. <div class="md-flex__cell md-flex__cell--shrink">
  1561. <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
  1562. </div>
  1563. </a>
  1564. </nav>
  1565. </div>
  1566. <div class="md-footer-meta md-typeset">
  1567. <div class="md-footer-meta__inner md-grid">
  1568. <div class="md-footer-copyright">
  1569. powered by
  1570. <a href="https://www.mkdocs.org">MkDocs</a>
  1571. and
  1572. <a href="https://squidfunk.github.io/mkdocs-material/">
  1573. Material for MkDocs</a>
  1574. </div>
  1575. </div>
  1576. </div>
  1577. </footer>
  1578. </div>
  1579. <script src="../assets/javascripts/application.808e90bb.js"></script>
  1580. <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
  1581. </body>
  1582. </html>