index.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896
  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>ExternalSecret - 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. <a href="#example" tabindex="1" class="md-skip">
  36. Skip to content
  37. </a>
  38. <header class="md-header" data-md-component="header">
  39. <nav class="md-header-nav md-grid">
  40. <div class="md-flex">
  41. <div class="md-flex__cell md-flex__cell--shrink">
  42. <a href=".." title="External Secrets Operator" class="md-header-nav__button md-logo">
  43. <i class="md-icon"></i>
  44. </a>
  45. </div>
  46. <div class="md-flex__cell md-flex__cell--shrink">
  47. <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
  48. </div>
  49. <div class="md-flex__cell md-flex__cell--stretch">
  50. <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
  51. <span class="md-header-nav__topic">
  52. External Secrets Operator
  53. </span>
  54. <span class="md-header-nav__topic">
  55. ExternalSecret
  56. </span>
  57. </div>
  58. </div>
  59. <div class="md-flex__cell md-flex__cell--shrink">
  60. <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
  61. <div class="md-search" data-md-component="search" role="dialog">
  62. <label class="md-search__overlay" for="__search"></label>
  63. <div class="md-search__inner" role="search">
  64. <form class="md-search__form" name="search">
  65. <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">
  66. <label class="md-icon md-search__icon" for="__search"></label>
  67. <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
  68. &#xE5CD;
  69. </button>
  70. </form>
  71. <div class="md-search__output">
  72. <div class="md-search__scrollwrap" data-md-scrollfix>
  73. <div class="md-search-result" data-md-component="result">
  74. <div class="md-search-result__meta">
  75. Type to start searching
  76. </div>
  77. <ol class="md-search-result__list"></ol>
  78. </div>
  79. </div>
  80. </div>
  81. </div>
  82. </div>
  83. </div>
  84. <div class="md-flex__cell md-flex__cell--shrink">
  85. <div class="md-header-nav__source">
  86. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-source="github">
  87. <div class="md-source__icon">
  88. <svg viewBox="0 0 24 24" width="24" height="24">
  89. <use xlink:href="#__github" width="24" height="24"></use>
  90. </svg>
  91. </div>
  92. <div class="md-source__repository">
  93. External Secrets Operator
  94. </div>
  95. </a>
  96. </div>
  97. </div>
  98. </div>
  99. </nav>
  100. </header>
  101. <div class="md-container">
  102. <main class="md-main" role="main">
  103. <div class="md-main__inner md-grid" data-md-component="container">
  104. <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
  105. <div class="md-sidebar__scrollwrap">
  106. <div class="md-sidebar__inner">
  107. <nav class="md-nav md-nav--primary" data-md-level="0">
  108. <label class="md-nav__title md-nav__title--site" for="__drawer">
  109. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo">
  110. <i class="md-icon"></i>
  111. </a>
  112. External Secrets Operator
  113. </label>
  114. <div class="md-nav__source">
  115. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-source="github">
  116. <div class="md-source__icon">
  117. <svg viewBox="0 0 24 24" width="24" height="24">
  118. <use xlink:href="#__github" width="24" height="24"></use>
  119. </svg>
  120. </div>
  121. <div class="md-source__repository">
  122. External Secrets Operator
  123. </div>
  124. </a>
  125. </div>
  126. <ul class="md-nav__list" data-md-scrollfix>
  127. <li class="md-nav__item">
  128. <a href=".." title="Introduction" class="md-nav__link">
  129. Introduction
  130. </a>
  131. </li>
  132. <li class="md-nav__item">
  133. <a href="../api-overview/" title="Overview" class="md-nav__link">
  134. Overview
  135. </a>
  136. </li>
  137. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  138. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked>
  139. <label class="md-nav__link" for="nav-3">
  140. API Types
  141. </label>
  142. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  143. <label class="md-nav__title" for="nav-3">
  144. API Types
  145. </label>
  146. <ul class="md-nav__list" data-md-scrollfix>
  147. <li class="md-nav__item md-nav__item--active">
  148. <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  149. <label class="md-nav__link md-nav__link--active" for="__toc">
  150. ExternalSecret
  151. </label>
  152. <a href="./" title="ExternalSecret" class="md-nav__link md-nav__link--active">
  153. ExternalSecret
  154. </a>
  155. <nav class="md-nav md-nav--secondary">
  156. <label class="md-nav__title" for="__toc">Table of contents</label>
  157. <ul class="md-nav__list" data-md-scrollfix>
  158. <li class="md-nav__item">
  159. <a href="#example" class="md-nav__link">
  160. Example
  161. </a>
  162. </li>
  163. </ul>
  164. </nav>
  165. </li>
  166. <li class="md-nav__item">
  167. <a href="../api-secretstore/" title="SecretStore" class="md-nav__link">
  168. SecretStore
  169. </a>
  170. </li>
  171. <li class="md-nav__item">
  172. <a href="../api-clustersecretstore/" title="ClusterSecretStore" class="md-nav__link">
  173. ClusterSecretStore
  174. </a>
  175. </li>
  176. </ul>
  177. </nav>
  178. </li>
  179. <li class="md-nav__item md-nav__item--nested">
  180. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
  181. <label class="md-nav__link" for="nav-4">
  182. Guides
  183. </label>
  184. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  185. <label class="md-nav__title" for="nav-4">
  186. Guides
  187. </label>
  188. <ul class="md-nav__list" data-md-scrollfix>
  189. <li class="md-nav__item">
  190. <a href="../guides-introduction/" title="Introduction" class="md-nav__link">
  191. Introduction
  192. </a>
  193. </li>
  194. <li class="md-nav__item">
  195. <a href="../guides-getting-started/" title="Getting started" class="md-nav__link">
  196. Getting started
  197. </a>
  198. </li>
  199. <li class="md-nav__item">
  200. <a href="../guides-templating/" title="Advanced Templating" class="md-nav__link">
  201. Advanced Templating
  202. </a>
  203. </li>
  204. <li class="md-nav__item">
  205. <a href="../guides-multi-tenancy/" title="Multi Tenancy" class="md-nav__link">
  206. Multi Tenancy
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../guides-metrics/" title="Metrics" class="md-nav__link">
  211. Metrics
  212. </a>
  213. </li>
  214. </ul>
  215. </nav>
  216. </li>
  217. <li class="md-nav__item md-nav__item--nested">
  218. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
  219. <label class="md-nav__link" for="nav-5">
  220. Provider
  221. </label>
  222. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  223. <label class="md-nav__title" for="nav-5">
  224. Provider
  225. </label>
  226. <ul class="md-nav__list" data-md-scrollfix>
  227. <li class="md-nav__item md-nav__item--nested">
  228. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1">
  229. <label class="md-nav__link" for="nav-5-1">
  230. AWS
  231. </label>
  232. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  233. <label class="md-nav__title" for="nav-5-1">
  234. AWS
  235. </label>
  236. <ul class="md-nav__list" data-md-scrollfix>
  237. <li class="md-nav__item">
  238. <a href="../provider-aws-secrets-manager/" title="Secrets Manager" class="md-nav__link">
  239. Secrets Manager
  240. </a>
  241. </li>
  242. <li class="md-nav__item">
  243. <a href="../provider-aws-parameter-store/" title="Parameter Store" class="md-nav__link">
  244. Parameter Store
  245. </a>
  246. </li>
  247. </ul>
  248. </nav>
  249. </li>
  250. <li class="md-nav__item md-nav__item--nested">
  251. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-2" type="checkbox" id="nav-5-2">
  252. <label class="md-nav__link" for="nav-5-2">
  253. Azure
  254. </label>
  255. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  256. <label class="md-nav__title" for="nav-5-2">
  257. Azure
  258. </label>
  259. <ul class="md-nav__list" data-md-scrollfix>
  260. <li class="md-nav__item">
  261. <a href="../provider-azure-key-vault/" title="Key Vault" class="md-nav__link">
  262. Key Vault
  263. </a>
  264. </li>
  265. </ul>
  266. </nav>
  267. </li>
  268. <li class="md-nav__item md-nav__item--nested">
  269. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-3" type="checkbox" id="nav-5-3">
  270. <label class="md-nav__link" for="nav-5-3">
  271. Google
  272. </label>
  273. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  274. <label class="md-nav__title" for="nav-5-3">
  275. Google
  276. </label>
  277. <ul class="md-nav__list" data-md-scrollfix>
  278. <li class="md-nav__item">
  279. <a href="../provider-google-secrets-manager/" title="Secrets Manager" class="md-nav__link">
  280. Secrets Manager
  281. </a>
  282. </li>
  283. </ul>
  284. </nav>
  285. </li>
  286. <li class="md-nav__item">
  287. <a href="../provider-hashicorp-vault/" title="HashiCorp Vault" class="md-nav__link">
  288. HashiCorp Vault
  289. </a>
  290. </li>
  291. </ul>
  292. </nav>
  293. </li>
  294. <li class="md-nav__item md-nav__item--nested">
  295. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
  296. <label class="md-nav__link" for="nav-6">
  297. References
  298. </label>
  299. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  300. <label class="md-nav__title" for="nav-6">
  301. References
  302. </label>
  303. <ul class="md-nav__list" data-md-scrollfix>
  304. <li class="md-nav__item">
  305. <a href="../spec/" title="API specification" class="md-nav__link">
  306. API specification
  307. </a>
  308. </li>
  309. </ul>
  310. </nav>
  311. </li>
  312. <li class="md-nav__item md-nav__item--nested">
  313. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
  314. <label class="md-nav__link" for="nav-7">
  315. Contributing
  316. </label>
  317. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  318. <label class="md-nav__title" for="nav-7">
  319. Contributing
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../contributing-devguide/" title="Developer guide" class="md-nav__link">
  324. Developer guide
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../contributing-process/" title="Contributing Process" class="md-nav__link">
  329. Contributing Process
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../contributing-coc/" title="Code of Conduct" class="md-nav__link">
  334. Code of Conduct
  335. </a>
  336. </li>
  337. </ul>
  338. </nav>
  339. </li>
  340. </ul>
  341. </nav>
  342. </div>
  343. </div>
  344. </div>
  345. <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
  346. <div class="md-sidebar__scrollwrap">
  347. <div class="md-sidebar__inner">
  348. <nav class="md-nav md-nav--secondary">
  349. <label class="md-nav__title" for="__toc">Table of contents</label>
  350. <ul class="md-nav__list" data-md-scrollfix>
  351. <li class="md-nav__item">
  352. <a href="#example" class="md-nav__link">
  353. Example
  354. </a>
  355. </li>
  356. </ul>
  357. </nav>
  358. </div>
  359. </div>
  360. </div>
  361. <div class="md-content">
  362. <article class="md-content__inner md-typeset">
  363. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/api-externalsecret.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
  364. <h1>ExternalSecret</h1>
  365. <p>The <code>ExternalSecret</code> describes what data should be fetched, how the data should
  366. be transformed and saved as a <code>Kind=Secret</code>:</p>
  367. <ul>
  368. <li>tells the operator what secrets should be synced by using <code>spec.data</code> to
  369. explicitly sync individual keys or use <code>spec.dataFrom</code> to get <strong>all values</strong>
  370. from the external API.</li>
  371. <li>you can specify how the secret should look like by specifying a
  372. <code>spec.target.template</code></li>
  373. </ul>
  374. <h2 id="example">Example</h2>
  375. <p>Take a look at an annotated example to understand the design behind the
  376. <code>ExternalSecret</code>.</p>
  377. <div class="highlight"><pre><span></span><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  378. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  379. <span class="nt">metadata</span><span class="p">:</span>
  380. <span class="nt">name</span><span class="p">:</span> <span class="s">&quot;hello-world&quot;</span>
  381. <span class="c1"># labels and annotations are copied over to the</span>
  382. <span class="c1"># secret that will be created</span>
  383. <span class="nt">labels</span><span class="p">:</span>
  384. <span class="nt">acme.org/owned-by</span><span class="p">:</span> <span class="s">&quot;q-team&quot;</span>
  385. <span class="nt">annotations</span><span class="p">:</span>
  386. <span class="nt">acme.org/sha</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1234</span>
  387. <span class="nt">spec</span><span class="p">:</span>
  388. <span class="c1"># SecretStoreRef defines which SecretStore to use when fetching the secret data</span>
  389. <span class="nt">secretStoreRef</span><span class="p">:</span>
  390. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-store-name</span>
  391. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span> <span class="c1"># or ClusterSecretStore</span>
  392. <span class="c1"># RefreshInterval is the amount of time before the values reading again from the SecretStore provider</span>
  393. <span class="c1"># Valid time units are &quot;ns&quot;, &quot;us&quot; (or &quot;µs&quot;), &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot; (from time.ParseDuration)</span>
  394. <span class="c1"># May be set to zero to fetch and create it once</span>
  395. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="s">&quot;1h&quot;</span>
  396. <span class="c1"># the target describes the secret that shall be created</span>
  397. <span class="c1"># there can only be one target per ExternalSecret</span>
  398. <span class="nt">target</span><span class="p">:</span>
  399. <span class="c1"># The secret name of the resource</span>
  400. <span class="c1"># Defaults to .metadata.name of the ExternalSecret</span>
  401. <span class="c1"># It is immutable</span>
  402. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">my-secret</span>
  403. <span class="c1"># Enum with values: &#39;Owner&#39;, &#39;Merge&#39;, or &#39;None&#39;</span>
  404. <span class="c1"># Default value of &#39;Owner&#39;</span>
  405. <span class="c1"># Owner creates the secret and sets .metadata.ownerReferences of the resource</span>
  406. <span class="c1"># Merge does not create the secret, but merges in the data fields to the secret</span>
  407. <span class="c1"># None does not create a secret (future use with injector)</span>
  408. <span class="nt">creationPolicy</span><span class="p">:</span> <span class="s">&#39;Merge&#39;</span>
  409. <span class="c1"># Specify a blueprint for the resulting Kind=Secret</span>
  410. <span class="nt">template</span><span class="p">:</span>
  411. <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">kubernetes.io/dockerconfigjson</span> <span class="c1"># or TLS...</span>
  412. <span class="nt">metadata</span><span class="p">:</span>
  413. <span class="nt">annotations</span><span class="p">:</span> <span class="p p-Indicator">{}</span>
  414. <span class="nt">labels</span><span class="p">:</span> <span class="p p-Indicator">{}</span>
  415. <span class="c1"># Use inline templates to construct your desired config file that contains your secret</span>
  416. <span class="nt">data</span><span class="p">:</span>
  417. <span class="nt">config.yml</span><span class="p">:</span> <span class="p p-Indicator">|</span>
  418. <span class="no">endpoints:</span>
  419. <span class="no">- https://{{ .data.user }}:{{ .data.password }}@api.exmaple.com</span>
  420. <span class="c1"># Uses an existing template from configmap</span>
  421. <span class="c1"># Secret is fetched, merged and templated within the referenced configMap data</span>
  422. <span class="c1"># It does not update the configmap, it creates a secret with: data[&quot;alertmanager.yml&quot;] = ...result...</span>
  423. <span class="nt">templateFrom</span><span class="p">:</span>
  424. <span class="p p-Indicator">-</span> <span class="nt">configMap</span><span class="p">:</span>
  425. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">alertmanager</span>
  426. <span class="nt">items</span><span class="p">:</span>
  427. <span class="p p-Indicator">-</span> <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">alertmanager.yaml</span>
  428. <span class="c1"># Data defines the connection between the Kubernetes Secret keys and the Provider data</span>
  429. <span class="nt">data</span><span class="p">:</span>
  430. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-key-to-be-managed</span>
  431. <span class="nt">remoteRef</span><span class="p">:</span>
  432. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">provider-key</span>
  433. <span class="nt">version</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">provider-key-version</span>
  434. <span class="nt">property</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">provider-key-property</span>
  435. <span class="c1"># Used to fetch all properties from the Provider key</span>
  436. <span class="c1"># If multiple dataFrom are specified, secrets are merged in the specified order</span>
  437. <span class="nt">dataFrom</span><span class="p">:</span>
  438. <span class="p p-Indicator">-</span> <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">provider-key</span>
  439. <span class="nt">version</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">provider-key-version</span>
  440. <span class="nt">property</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">provider-key-property</span>
  441. <span class="nt">status</span><span class="p">:</span>
  442. <span class="c1"># refreshTime is the time and date the external secret was fetched and</span>
  443. <span class="c1"># the target secret updated</span>
  444. <span class="nt">refreshTime</span><span class="p">:</span> <span class="s">&quot;2019-08-12T12:33:02Z&quot;</span>
  445. <span class="c1"># Standard condition schema</span>
  446. <span class="nt">conditions</span><span class="p">:</span>
  447. <span class="c1"># ExternalSecret ready condition indicates the secret is ready for use.</span>
  448. <span class="c1"># This is defined as:</span>
  449. <span class="c1"># - The target secret exists</span>
  450. <span class="c1"># - The target secret has been refreshed within the last refreshInterval</span>
  451. <span class="c1"># - The target secret content is up-to-date based on any target templates</span>
  452. <span class="p p-Indicator">-</span> <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Ready</span>
  453. <span class="nt">status</span><span class="p">:</span> <span class="s">&quot;True&quot;</span> <span class="c1"># False if last refresh was not successful</span>
  454. <span class="nt">reason</span><span class="p">:</span> <span class="s">&quot;SecretSynced&quot;</span>
  455. <span class="nt">message</span><span class="p">:</span> <span class="s">&quot;Secret</span><span class="nv"> </span><span class="s">was</span><span class="nv"> </span><span class="s">synced&quot;</span>
  456. <span class="nt">lastTransitionTime</span><span class="p">:</span> <span class="s">&quot;2019-08-12T12:33:02Z&quot;</span>
  457. </pre></div>
  458. </article>
  459. </div>
  460. </div>
  461. </main>
  462. <footer class="md-footer">
  463. <div class="md-footer-nav">
  464. <nav class="md-footer-nav__inner md-grid">
  465. <a href="../api-overview/" title="Overview" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
  466. <div class="md-flex__cell md-flex__cell--shrink">
  467. <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
  468. </div>
  469. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  470. <span class="md-flex__ellipsis">
  471. <span class="md-footer-nav__direction">
  472. Previous
  473. </span>
  474. Overview
  475. </span>
  476. </div>
  477. </a>
  478. <a href="../api-secretstore/" title="SecretStore" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
  479. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  480. <span class="md-flex__ellipsis">
  481. <span class="md-footer-nav__direction">
  482. Next
  483. </span>
  484. SecretStore
  485. </span>
  486. </div>
  487. <div class="md-flex__cell md-flex__cell--shrink">
  488. <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
  489. </div>
  490. </a>
  491. </nav>
  492. </div>
  493. <div class="md-footer-meta md-typeset">
  494. <div class="md-footer-meta__inner md-grid">
  495. <div class="md-footer-copyright">
  496. powered by
  497. <a href="https://www.mkdocs.org">MkDocs</a>
  498. and
  499. <a href="https://squidfunk.github.io/mkdocs-material/">
  500. Material for MkDocs</a>
  501. </div>
  502. </div>
  503. </div>
  504. </footer>
  505. </div>
  506. <script src="../assets/javascripts/application.808e90bb.js"></script>
  507. <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
  508. </body>
  509. </html>