index.html 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904
  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.AWSSMAuth">AWSSMAuth
  341. </h3>
  342. <p>
  343. (<em>Appears on:</em>
  344. <a href="#external-secrets.io/v1alpha1.AWSSMProvider">AWSSMProvider</a>)
  345. </p>
  346. <p>
  347. <p>AWSSMAuth 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.AWSSMAuthSecretRef">
  362. AWSSMAuthSecretRef
  363. </a>
  364. </em>
  365. </td>
  366. <td>
  367. </td>
  368. </tr>
  369. </tbody>
  370. </table>
  371. <h3 id="external-secrets.io/v1alpha1.AWSSMAuthSecretRef">AWSSMAuthSecretRef
  372. </h3>
  373. <p>
  374. (<em>Appears on:</em>
  375. <a href="#external-secrets.io/v1alpha1.AWSSMAuth">AWSSMAuth</a>)
  376. </p>
  377. <p>
  378. <p>AWSSMAuthSecretRef 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.AWSSMProvider">AWSSMProvider
  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>AWSSMProvider configures a store to sync secrets using the AWS Secret Manager provider.</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>auth</code></br>
  433. <em>
  434. <a href="#external-secrets.io/v1alpha1.AWSSMAuth">
  435. AWSSMAuth
  436. </a>
  437. </em>
  438. </td>
  439. <td>
  440. <em>(Optional)</em>
  441. <p>Auth defines the information necessary to authenticate against AWS
  442. if not set aws sdk will infer credentials from your environment
  443. 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>
  444. </td>
  445. </tr>
  446. <tr>
  447. <td>
  448. <code>role</code></br>
  449. <em>
  450. string
  451. </em>
  452. </td>
  453. <td>
  454. <em>(Optional)</em>
  455. <p>Role is a Role ARN which the SecretManager provider will assume</p>
  456. </td>
  457. </tr>
  458. <tr>
  459. <td>
  460. <code>region</code></br>
  461. <em>
  462. string
  463. </em>
  464. </td>
  465. <td>
  466. <p>AWS Region to be used for the provider</p>
  467. </td>
  468. </tr>
  469. </tbody>
  470. </table>
  471. <h3 id="external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore
  472. </h3>
  473. <p>
  474. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  475. </p>
  476. <table>
  477. <thead>
  478. <tr>
  479. <th>Field</th>
  480. <th>Description</th>
  481. </tr>
  482. </thead>
  483. <tbody>
  484. <tr>
  485. <td>
  486. <code>metadata</code></br>
  487. <em>
  488. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  489. Kubernetes meta/v1.ObjectMeta
  490. </a>
  491. </em>
  492. </td>
  493. <td>
  494. Refer to the Kubernetes API documentation for the fields of the
  495. <code>metadata</code> field.
  496. </td>
  497. </tr>
  498. <tr>
  499. <td>
  500. <code>spec</code></br>
  501. <em>
  502. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  503. SecretStoreSpec
  504. </a>
  505. </em>
  506. </td>
  507. <td>
  508. <br/>
  509. <br/>
  510. <table>
  511. <tr>
  512. <td>
  513. <code>controller</code></br>
  514. <em>
  515. string
  516. </em>
  517. </td>
  518. <td>
  519. <em>(Optional)</em>
  520. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  521. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  522. </td>
  523. </tr>
  524. <tr>
  525. <td>
  526. <code>provider</code></br>
  527. <em>
  528. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  529. SecretStoreProvider
  530. </a>
  531. </em>
  532. </td>
  533. <td>
  534. <p>Used to configure the provider. Only one provider may be set</p>
  535. </td>
  536. </tr>
  537. </table>
  538. </td>
  539. </tr>
  540. </tbody>
  541. </table>
  542. <h3 id="external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret
  543. </h3>
  544. <p>
  545. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  546. </p>
  547. <table>
  548. <thead>
  549. <tr>
  550. <th>Field</th>
  551. <th>Description</th>
  552. </tr>
  553. </thead>
  554. <tbody>
  555. <tr>
  556. <td>
  557. <code>metadata</code></br>
  558. <em>
  559. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  560. Kubernetes meta/v1.ObjectMeta
  561. </a>
  562. </em>
  563. </td>
  564. <td>
  565. Refer to the Kubernetes API documentation for the fields of the
  566. <code>metadata</code> field.
  567. </td>
  568. </tr>
  569. <tr>
  570. <td>
  571. <code>spec</code></br>
  572. <em>
  573. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">
  574. ExternalSecretSpec
  575. </a>
  576. </em>
  577. </td>
  578. <td>
  579. <br/>
  580. <br/>
  581. <table>
  582. <tr>
  583. <td>
  584. <code>secretStoreRef</code></br>
  585. <em>
  586. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  587. SecretStoreRef
  588. </a>
  589. </em>
  590. </td>
  591. <td>
  592. </td>
  593. </tr>
  594. <tr>
  595. <td>
  596. <code>target</code></br>
  597. <em>
  598. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  599. ExternalSecretTarget
  600. </a>
  601. </em>
  602. </td>
  603. <td>
  604. </td>
  605. </tr>
  606. <tr>
  607. <td>
  608. <code>refreshInterval</code></br>
  609. <em>
  610. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  611. Kubernetes meta/v1.Duration
  612. </a>
  613. </em>
  614. </td>
  615. <td>
  616. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  617. 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;
  618. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  619. </td>
  620. </tr>
  621. <tr>
  622. <td>
  623. <code>data</code></br>
  624. <em>
  625. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  626. []ExternalSecretData
  627. </a>
  628. </em>
  629. </td>
  630. <td>
  631. <em>(Optional)</em>
  632. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  633. </td>
  634. </tr>
  635. <tr>
  636. <td>
  637. <code>dataFrom</code></br>
  638. <em>
  639. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  640. []ExternalSecretDataRemoteRef
  641. </a>
  642. </em>
  643. </td>
  644. <td>
  645. <em>(Optional)</em>
  646. <p>DataFrom is used to fetch all properties from a specific Provider data
  647. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  648. </td>
  649. </tr>
  650. </table>
  651. </td>
  652. </tr>
  653. <tr>
  654. <td>
  655. <code>status</code></br>
  656. <em>
  657. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">
  658. ExternalSecretStatus
  659. </a>
  660. </em>
  661. </td>
  662. <td>
  663. </td>
  664. </tr>
  665. </tbody>
  666. </table>
  667. <h3 id="external-secrets.io/v1alpha1.ExternalSecretConditionType">ExternalSecretConditionType
  668. (<code>string</code> alias)</p></h3>
  669. <p>
  670. (<em>Appears on:</em>
  671. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  672. </p>
  673. <p>
  674. </p>
  675. <table>
  676. <thead>
  677. <tr>
  678. <th>Value</th>
  679. <th>Description</th>
  680. </tr>
  681. </thead>
  682. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  683. <td></td>
  684. </tr></tbody>
  685. </table>
  686. <h3 id="external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  687. (<code>string</code> alias)</p></h3>
  688. <p>
  689. (<em>Appears on:</em>
  690. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  691. </p>
  692. <p>
  693. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  694. </p>
  695. <table>
  696. <thead>
  697. <tr>
  698. <th>Value</th>
  699. <th>Description</th>
  700. </tr>
  701. </thead>
  702. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  703. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  704. </td>
  705. </tr><tr><td><p>&#34;None&#34;</p></td>
  706. <td><p>None does not create a Secret (future use with injector).</p>
  707. </td>
  708. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  709. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  710. </td>
  711. </tr></tbody>
  712. </table>
  713. <h3 id="external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData
  714. </h3>
  715. <p>
  716. (<em>Appears on:</em>
  717. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  718. </p>
  719. <p>
  720. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  721. </p>
  722. <table>
  723. <thead>
  724. <tr>
  725. <th>Field</th>
  726. <th>Description</th>
  727. </tr>
  728. </thead>
  729. <tbody>
  730. <tr>
  731. <td>
  732. <code>secretKey</code></br>
  733. <em>
  734. string
  735. </em>
  736. </td>
  737. <td>
  738. </td>
  739. </tr>
  740. <tr>
  741. <td>
  742. <code>remoteRef</code></br>
  743. <em>
  744. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  745. ExternalSecretDataRemoteRef
  746. </a>
  747. </em>
  748. </td>
  749. <td>
  750. </td>
  751. </tr>
  752. </tbody>
  753. </table>
  754. <h3 id="external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  755. </h3>
  756. <p>
  757. (<em>Appears on:</em>
  758. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData</a>,
  759. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  760. </p>
  761. <p>
  762. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  763. </p>
  764. <table>
  765. <thead>
  766. <tr>
  767. <th>Field</th>
  768. <th>Description</th>
  769. </tr>
  770. </thead>
  771. <tbody>
  772. <tr>
  773. <td>
  774. <code>key</code></br>
  775. <em>
  776. string
  777. </em>
  778. </td>
  779. <td>
  780. <p>Key is the key used in the Provider, mandatory</p>
  781. </td>
  782. </tr>
  783. <tr>
  784. <td>
  785. <code>version</code></br>
  786. <em>
  787. string
  788. </em>
  789. </td>
  790. <td>
  791. <em>(Optional)</em>
  792. <p>Used to select a specific version of the Provider value, if supported</p>
  793. </td>
  794. </tr>
  795. <tr>
  796. <td>
  797. <code>property</code></br>
  798. <em>
  799. string
  800. </em>
  801. </td>
  802. <td>
  803. <em>(Optional)</em>
  804. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  805. </td>
  806. </tr>
  807. </tbody>
  808. </table>
  809. <h3 id="external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec
  810. </h3>
  811. <p>
  812. (<em>Appears on:</em>
  813. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  814. </p>
  815. <p>
  816. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  817. </p>
  818. <table>
  819. <thead>
  820. <tr>
  821. <th>Field</th>
  822. <th>Description</th>
  823. </tr>
  824. </thead>
  825. <tbody>
  826. <tr>
  827. <td>
  828. <code>secretStoreRef</code></br>
  829. <em>
  830. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  831. SecretStoreRef
  832. </a>
  833. </em>
  834. </td>
  835. <td>
  836. </td>
  837. </tr>
  838. <tr>
  839. <td>
  840. <code>target</code></br>
  841. <em>
  842. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  843. ExternalSecretTarget
  844. </a>
  845. </em>
  846. </td>
  847. <td>
  848. </td>
  849. </tr>
  850. <tr>
  851. <td>
  852. <code>refreshInterval</code></br>
  853. <em>
  854. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  855. Kubernetes meta/v1.Duration
  856. </a>
  857. </em>
  858. </td>
  859. <td>
  860. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  861. 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;
  862. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  863. </td>
  864. </tr>
  865. <tr>
  866. <td>
  867. <code>data</code></br>
  868. <em>
  869. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  870. []ExternalSecretData
  871. </a>
  872. </em>
  873. </td>
  874. <td>
  875. <em>(Optional)</em>
  876. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  877. </td>
  878. </tr>
  879. <tr>
  880. <td>
  881. <code>dataFrom</code></br>
  882. <em>
  883. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  884. []ExternalSecretDataRemoteRef
  885. </a>
  886. </em>
  887. </td>
  888. <td>
  889. <em>(Optional)</em>
  890. <p>DataFrom is used to fetch all properties from a specific Provider data
  891. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  892. </td>
  893. </tr>
  894. </tbody>
  895. </table>
  896. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus
  897. </h3>
  898. <p>
  899. (<em>Appears on:</em>
  900. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  901. </p>
  902. <p>
  903. </p>
  904. <table>
  905. <thead>
  906. <tr>
  907. <th>Field</th>
  908. <th>Description</th>
  909. </tr>
  910. </thead>
  911. <tbody>
  912. <tr>
  913. <td>
  914. <code>refreshTime</code></br>
  915. <em>
  916. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  917. Kubernetes meta/v1.Time
  918. </a>
  919. </em>
  920. </td>
  921. <td>
  922. <p>refreshTime is the time and date the external secret was fetched and
  923. the target secret updated</p>
  924. </td>
  925. </tr>
  926. <tr>
  927. <td>
  928. <code>conditions</code></br>
  929. <em>
  930. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">
  931. []ExternalSecretStatusCondition
  932. </a>
  933. </em>
  934. </td>
  935. <td>
  936. <em>(Optional)</em>
  937. </td>
  938. </tr>
  939. </tbody>
  940. </table>
  941. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  942. </h3>
  943. <p>
  944. (<em>Appears on:</em>
  945. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus</a>)
  946. </p>
  947. <p>
  948. </p>
  949. <table>
  950. <thead>
  951. <tr>
  952. <th>Field</th>
  953. <th>Description</th>
  954. </tr>
  955. </thead>
  956. <tbody>
  957. <tr>
  958. <td>
  959. <code>type</code></br>
  960. <em>
  961. <a href="#external-secrets.io/v1alpha1.ExternalSecretConditionType">
  962. ExternalSecretConditionType
  963. </a>
  964. </em>
  965. </td>
  966. <td>
  967. </td>
  968. </tr>
  969. <tr>
  970. <td>
  971. <code>status</code></br>
  972. <em>
  973. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  974. Kubernetes core/v1.ConditionStatus
  975. </a>
  976. </em>
  977. </td>
  978. <td>
  979. </td>
  980. </tr>
  981. <tr>
  982. <td>
  983. <code>reason</code></br>
  984. <em>
  985. string
  986. </em>
  987. </td>
  988. <td>
  989. <em>(Optional)</em>
  990. </td>
  991. </tr>
  992. <tr>
  993. <td>
  994. <code>message</code></br>
  995. <em>
  996. string
  997. </em>
  998. </td>
  999. <td>
  1000. <em>(Optional)</em>
  1001. </td>
  1002. </tr>
  1003. <tr>
  1004. <td>
  1005. <code>lastTransitionTime</code></br>
  1006. <em>
  1007. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1008. Kubernetes meta/v1.Time
  1009. </a>
  1010. </em>
  1011. </td>
  1012. <td>
  1013. <em>(Optional)</em>
  1014. </td>
  1015. </tr>
  1016. </tbody>
  1017. </table>
  1018. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget
  1019. </h3>
  1020. <p>
  1021. (<em>Appears on:</em>
  1022. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1023. </p>
  1024. <p>
  1025. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  1026. There can be only one target per ExternalSecret.</p>
  1027. </p>
  1028. <table>
  1029. <thead>
  1030. <tr>
  1031. <th>Field</th>
  1032. <th>Description</th>
  1033. </tr>
  1034. </thead>
  1035. <tbody>
  1036. <tr>
  1037. <td>
  1038. <code>name</code></br>
  1039. <em>
  1040. string
  1041. </em>
  1042. </td>
  1043. <td>
  1044. <em>(Optional)</em>
  1045. <p>Name defines the name of the Secret resource to be managed
  1046. This field is immutable
  1047. Defaults to the .metadata.name of the ExternalSecret resource</p>
  1048. </td>
  1049. </tr>
  1050. <tr>
  1051. <td>
  1052. <code>creationPolicy</code></br>
  1053. <em>
  1054. <a href="#external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">
  1055. ExternalSecretCreationPolicy
  1056. </a>
  1057. </em>
  1058. </td>
  1059. <td>
  1060. <em>(Optional)</em>
  1061. <p>CreationPolicy defines rules on how to create the resulting Secret
  1062. Defaults to &lsquo;Owner&rsquo;</p>
  1063. </td>
  1064. </tr>
  1065. </tbody>
  1066. </table>
  1067. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate
  1068. </h3>
  1069. <p>
  1070. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.</p>
  1071. </p>
  1072. <table>
  1073. <thead>
  1074. <tr>
  1075. <th>Field</th>
  1076. <th>Description</th>
  1077. </tr>
  1078. </thead>
  1079. <tbody>
  1080. <tr>
  1081. <td>
  1082. <code>type</code></br>
  1083. <em>
  1084. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secrettype-v1-core">
  1085. Kubernetes core/v1.SecretType
  1086. </a>
  1087. </em>
  1088. </td>
  1089. <td>
  1090. <em>(Optional)</em>
  1091. </td>
  1092. </tr>
  1093. <tr>
  1094. <td>
  1095. <code>metadata</code></br>
  1096. <em>
  1097. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">
  1098. ExternalSecretTemplateMetadata
  1099. </a>
  1100. </em>
  1101. </td>
  1102. <td>
  1103. <em>(Optional)</em>
  1104. </td>
  1105. </tr>
  1106. </tbody>
  1107. </table>
  1108. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  1109. </h3>
  1110. <p>
  1111. (<em>Appears on:</em>
  1112. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  1113. </p>
  1114. <p>
  1115. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  1116. </p>
  1117. <table>
  1118. <thead>
  1119. <tr>
  1120. <th>Field</th>
  1121. <th>Description</th>
  1122. </tr>
  1123. </thead>
  1124. <tbody>
  1125. <tr>
  1126. <td>
  1127. <code>annotations</code></br>
  1128. <em>
  1129. map[string]string
  1130. </em>
  1131. </td>
  1132. <td>
  1133. <em>(Optional)</em>
  1134. </td>
  1135. </tr>
  1136. <tr>
  1137. <td>
  1138. <code>labels</code></br>
  1139. <em>
  1140. map[string]string
  1141. </em>
  1142. </td>
  1143. <td>
  1144. <em>(Optional)</em>
  1145. </td>
  1146. </tr>
  1147. </tbody>
  1148. </table>
  1149. <h3 id="external-secrets.io/v1alpha1.GenericStore">GenericStore
  1150. </h3>
  1151. <p>
  1152. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  1153. or a namespaced SecretStore.</p>
  1154. </p>
  1155. <h3 id="external-secrets.io/v1alpha1.SecretStore">SecretStore
  1156. </h3>
  1157. <p>
  1158. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  1159. </p>
  1160. <table>
  1161. <thead>
  1162. <tr>
  1163. <th>Field</th>
  1164. <th>Description</th>
  1165. </tr>
  1166. </thead>
  1167. <tbody>
  1168. <tr>
  1169. <td>
  1170. <code>metadata</code></br>
  1171. <em>
  1172. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1173. Kubernetes meta/v1.ObjectMeta
  1174. </a>
  1175. </em>
  1176. </td>
  1177. <td>
  1178. Refer to the Kubernetes API documentation for the fields of the
  1179. <code>metadata</code> field.
  1180. </td>
  1181. </tr>
  1182. <tr>
  1183. <td>
  1184. <code>spec</code></br>
  1185. <em>
  1186. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  1187. SecretStoreSpec
  1188. </a>
  1189. </em>
  1190. </td>
  1191. <td>
  1192. <br/>
  1193. <br/>
  1194. <table>
  1195. <tr>
  1196. <td>
  1197. <code>controller</code></br>
  1198. <em>
  1199. string
  1200. </em>
  1201. </td>
  1202. <td>
  1203. <em>(Optional)</em>
  1204. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  1205. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  1206. </td>
  1207. </tr>
  1208. <tr>
  1209. <td>
  1210. <code>provider</code></br>
  1211. <em>
  1212. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  1213. SecretStoreProvider
  1214. </a>
  1215. </em>
  1216. </td>
  1217. <td>
  1218. <p>Used to configure the provider. Only one provider may be set</p>
  1219. </td>
  1220. </tr>
  1221. </table>
  1222. </td>
  1223. </tr>
  1224. <tr>
  1225. <td>
  1226. <code>status</code></br>
  1227. <em>
  1228. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  1229. SecretStoreStatus
  1230. </a>
  1231. </em>
  1232. </td>
  1233. <td>
  1234. </td>
  1235. </tr>
  1236. </tbody>
  1237. </table>
  1238. <h3 id="external-secrets.io/v1alpha1.SecretStoreConditionType">SecretStoreConditionType
  1239. (<code>string</code> alias)</p></h3>
  1240. <p>
  1241. (<em>Appears on:</em>
  1242. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  1243. </p>
  1244. <p>
  1245. </p>
  1246. <table>
  1247. <thead>
  1248. <tr>
  1249. <th>Value</th>
  1250. <th>Description</th>
  1251. </tr>
  1252. </thead>
  1253. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  1254. <td></td>
  1255. </tr></tbody>
  1256. </table>
  1257. <h3 id="external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider
  1258. </h3>
  1259. <p>
  1260. (<em>Appears on:</em>
  1261. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec</a>)
  1262. </p>
  1263. <p>
  1264. <p>SecretStoreProvider contains the provider-specific configration.</p>
  1265. </p>
  1266. <table>
  1267. <thead>
  1268. <tr>
  1269. <th>Field</th>
  1270. <th>Description</th>
  1271. </tr>
  1272. </thead>
  1273. <tbody>
  1274. <tr>
  1275. <td>
  1276. <code>awssm</code></br>
  1277. <em>
  1278. <a href="#external-secrets.io/v1alpha1.AWSSMProvider">
  1279. AWSSMProvider
  1280. </a>
  1281. </em>
  1282. </td>
  1283. <td>
  1284. <em>(Optional)</em>
  1285. <p>AWSSM configures this store to sync secrets using AWS Secret Manager provider</p>
  1286. </td>
  1287. </tr>
  1288. </tbody>
  1289. </table>
  1290. <h3 id="external-secrets.io/v1alpha1.SecretStoreRef">SecretStoreRef
  1291. </h3>
  1292. <p>
  1293. (<em>Appears on:</em>
  1294. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1295. </p>
  1296. <p>
  1297. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  1298. </p>
  1299. <table>
  1300. <thead>
  1301. <tr>
  1302. <th>Field</th>
  1303. <th>Description</th>
  1304. </tr>
  1305. </thead>
  1306. <tbody>
  1307. <tr>
  1308. <td>
  1309. <code>name</code></br>
  1310. <em>
  1311. string
  1312. </em>
  1313. </td>
  1314. <td>
  1315. <p>Name of the SecretStore resource</p>
  1316. </td>
  1317. </tr>
  1318. <tr>
  1319. <td>
  1320. <code>kind</code></br>
  1321. <em>
  1322. string
  1323. </em>
  1324. </td>
  1325. <td>
  1326. <em>(Optional)</em>
  1327. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  1328. Defaults to <code>SecretStore</code></p>
  1329. </td>
  1330. </tr>
  1331. </tbody>
  1332. </table>
  1333. <h3 id="external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec
  1334. </h3>
  1335. <p>
  1336. (<em>Appears on:</em>
  1337. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  1338. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  1339. </p>
  1340. <p>
  1341. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  1342. </p>
  1343. <table>
  1344. <thead>
  1345. <tr>
  1346. <th>Field</th>
  1347. <th>Description</th>
  1348. </tr>
  1349. </thead>
  1350. <tbody>
  1351. <tr>
  1352. <td>
  1353. <code>controller</code></br>
  1354. <em>
  1355. string
  1356. </em>
  1357. </td>
  1358. <td>
  1359. <em>(Optional)</em>
  1360. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  1361. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  1362. </td>
  1363. </tr>
  1364. <tr>
  1365. <td>
  1366. <code>provider</code></br>
  1367. <em>
  1368. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  1369. SecretStoreProvider
  1370. </a>
  1371. </em>
  1372. </td>
  1373. <td>
  1374. <p>Used to configure the provider. Only one provider may be set</p>
  1375. </td>
  1376. </tr>
  1377. </tbody>
  1378. </table>
  1379. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus
  1380. </h3>
  1381. <p>
  1382. (<em>Appears on:</em>
  1383. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  1384. </p>
  1385. <p>
  1386. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  1387. </p>
  1388. <table>
  1389. <thead>
  1390. <tr>
  1391. <th>Field</th>
  1392. <th>Description</th>
  1393. </tr>
  1394. </thead>
  1395. <tbody>
  1396. <tr>
  1397. <td>
  1398. <code>conditions</code></br>
  1399. <em>
  1400. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">
  1401. []SecretStoreStatusCondition
  1402. </a>
  1403. </em>
  1404. </td>
  1405. <td>
  1406. <em>(Optional)</em>
  1407. </td>
  1408. </tr>
  1409. </tbody>
  1410. </table>
  1411. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition
  1412. </h3>
  1413. <p>
  1414. (<em>Appears on:</em>
  1415. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus</a>)
  1416. </p>
  1417. <p>
  1418. </p>
  1419. <table>
  1420. <thead>
  1421. <tr>
  1422. <th>Field</th>
  1423. <th>Description</th>
  1424. </tr>
  1425. </thead>
  1426. <tbody>
  1427. <tr>
  1428. <td>
  1429. <code>type</code></br>
  1430. <em>
  1431. <a href="#external-secrets.io/v1alpha1.SecretStoreConditionType">
  1432. SecretStoreConditionType
  1433. </a>
  1434. </em>
  1435. </td>
  1436. <td>
  1437. </td>
  1438. </tr>
  1439. <tr>
  1440. <td>
  1441. <code>status</code></br>
  1442. <em>
  1443. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  1444. Kubernetes core/v1.ConditionStatus
  1445. </a>
  1446. </em>
  1447. </td>
  1448. <td>
  1449. </td>
  1450. </tr>
  1451. <tr>
  1452. <td>
  1453. <code>reason</code></br>
  1454. <em>
  1455. string
  1456. </em>
  1457. </td>
  1458. <td>
  1459. <em>(Optional)</em>
  1460. </td>
  1461. </tr>
  1462. <tr>
  1463. <td>
  1464. <code>message</code></br>
  1465. <em>
  1466. string
  1467. </em>
  1468. </td>
  1469. <td>
  1470. <em>(Optional)</em>
  1471. </td>
  1472. </tr>
  1473. <tr>
  1474. <td>
  1475. <code>lastTransitionTime</code></br>
  1476. <em>
  1477. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1478. Kubernetes meta/v1.Time
  1479. </a>
  1480. </em>
  1481. </td>
  1482. <td>
  1483. <em>(Optional)</em>
  1484. </td>
  1485. </tr>
  1486. </tbody>
  1487. </table>
  1488. <h3 id="external-secrets.io/v1alpha1.StoreProvider">StoreProvider
  1489. (<code>string</code> alias)</p></h3>
  1490. <p>
  1491. </p>
  1492. <table>
  1493. <thead>
  1494. <tr>
  1495. <th>Value</th>
  1496. <th>Description</th>
  1497. </tr>
  1498. </thead>
  1499. <tbody><tr><td><p>&#34;AWSSM&#34;</p></td>
  1500. <td></td>
  1501. </tr><tr><td><p>&#34;GCPSM&#34;</p></td>
  1502. <td></td>
  1503. </tr><tr><td><p>&#34;VAULT&#34;</p></td>
  1504. <td></td>
  1505. </tr></tbody>
  1506. </table>
  1507. <hr/>
  1508. <p><em>
  1509. Generated with <code>gen-crd-api-reference-docs</code>.
  1510. </em></p></p>
  1511. </article>
  1512. </div>
  1513. </div>
  1514. </main>
  1515. <footer class="md-footer">
  1516. <div class="md-footer-nav">
  1517. <nav class="md-footer-nav__inner md-grid">
  1518. <a href="../provider-hashicorp-vault/" title="HashiCorp Vault" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
  1519. <div class="md-flex__cell md-flex__cell--shrink">
  1520. <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
  1521. </div>
  1522. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  1523. <span class="md-flex__ellipsis">
  1524. <span class="md-footer-nav__direction">
  1525. Previous
  1526. </span>
  1527. HashiCorp Vault
  1528. </span>
  1529. </div>
  1530. </a>
  1531. <a href="../contributing-devguide/" title="Developer guide" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
  1532. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  1533. <span class="md-flex__ellipsis">
  1534. <span class="md-footer-nav__direction">
  1535. Next
  1536. </span>
  1537. Developer guide
  1538. </span>
  1539. </div>
  1540. <div class="md-flex__cell md-flex__cell--shrink">
  1541. <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
  1542. </div>
  1543. </a>
  1544. </nav>
  1545. </div>
  1546. <div class="md-footer-meta md-typeset">
  1547. <div class="md-footer-meta__inner md-grid">
  1548. <div class="md-footer-copyright">
  1549. powered by
  1550. <a href="https://www.mkdocs.org">MkDocs</a>
  1551. and
  1552. <a href="https://squidfunk.github.io/mkdocs-material/">
  1553. Material for MkDocs</a>
  1554. </div>
  1555. </div>
  1556. </div>
  1557. </footer>
  1558. </div>
  1559. <script src="../assets/javascripts/application.808e90bb.js"></script>
  1560. <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
  1561. </body>
  1562. </html>