index.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="icon" href="../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.1, mkdocs-material-7.1.8">
  8. <title>All keys, One secret - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.ca7ac06f.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.f1a3b89f.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
  14. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){"undefined"!=typeof location$&&location$.subscribe(function(t){gtag("config","G-QP38TD8K7V",{page_path:t.pathname})})})</script>
  15. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  16. </head>
  17. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  18. <script>function __prefix(e){return new URL("..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#all-keys-one-secret" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <header class="md-header" data-md-component="header">
  30. <nav class="md-header__inner md-grid" aria-label="Header">
  31. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  32. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  33. </a>
  34. <label class="md-header__button md-icon" for="__drawer">
  35. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  36. </label>
  37. <div class="md-header__title" data-md-component="header-title">
  38. <div class="md-header__ellipsis">
  39. <div class="md-header__topic">
  40. <span class="md-ellipsis">
  41. External Secrets Operator
  42. </span>
  43. </div>
  44. <div class="md-header__topic" data-md-component="header-topic">
  45. <span class="md-ellipsis">
  46. All keys, One secret
  47. </span>
  48. </div>
  49. </div>
  50. </div>
  51. <label class="md-header__button md-icon" for="__search">
  52. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  53. </label>
  54. <div class="md-search" data-md-component="search" role="dialog">
  55. <label class="md-search__overlay" for="__search"></label>
  56. <div class="md-search__inner" role="search">
  57. <form class="md-search__form" name="search">
  58. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
  59. <label class="md-search__icon md-icon" for="__search">
  60. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  61. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  62. </label>
  63. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  64. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  65. </button>
  66. </form>
  67. <div class="md-search__output">
  68. <div class="md-search__scrollwrap" data-md-scrollfix>
  69. <div class="md-search-result" data-md-component="search-result">
  70. <div class="md-search-result__meta">
  71. Initializing search
  72. </div>
  73. <ol class="md-search-result__list"></ol>
  74. </div>
  75. </div>
  76. </div>
  77. </div>
  78. </div>
  79. <div class="md-header__source">
  80. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  81. <div class="md-source__icon md-icon">
  82. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  83. </div>
  84. <div class="md-source__repository">
  85. External Secrets Operator
  86. </div>
  87. </a>
  88. </div>
  89. </nav>
  90. </header>
  91. <div class="md-container" data-md-component="container">
  92. <main class="md-main" data-md-component="main">
  93. <div class="md-main__inner md-grid">
  94. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  95. <div class="md-sidebar__scrollwrap">
  96. <div class="md-sidebar__inner">
  97. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  98. <label class="md-nav__title" for="__drawer">
  99. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  100. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  101. </a>
  102. External Secrets Operator
  103. </label>
  104. <div class="md-nav__source">
  105. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  106. <div class="md-source__icon md-icon">
  107. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  108. </div>
  109. <div class="md-source__repository">
  110. External Secrets Operator
  111. </div>
  112. </a>
  113. </div>
  114. <ul class="md-nav__list" data-md-scrollfix>
  115. <li class="md-nav__item">
  116. <a href=".." class="md-nav__link">
  117. Introduction
  118. </a>
  119. </li>
  120. <li class="md-nav__item">
  121. <a href="../api-overview/" class="md-nav__link">
  122. Overview
  123. </a>
  124. </li>
  125. <li class="md-nav__item md-nav__item--nested">
  126. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  127. <label class="md-nav__link" for="__nav_3">
  128. API Types
  129. <span class="md-nav__icon md-icon"></span>
  130. </label>
  131. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  132. <label class="md-nav__title" for="__nav_3">
  133. <span class="md-nav__icon md-icon"></span>
  134. API Types
  135. </label>
  136. <ul class="md-nav__list" data-md-scrollfix>
  137. <li class="md-nav__item">
  138. <a href="../api-externalsecret/" class="md-nav__link">
  139. ExternalSecret
  140. </a>
  141. </li>
  142. <li class="md-nav__item">
  143. <a href="../api-secretstore/" class="md-nav__link">
  144. SecretStore
  145. </a>
  146. </li>
  147. <li class="md-nav__item">
  148. <a href="../api-clustersecretstore/" class="md-nav__link">
  149. ClusterSecretStore
  150. </a>
  151. </li>
  152. </ul>
  153. </nav>
  154. </li>
  155. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  156. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
  157. <label class="md-nav__link" for="__nav_4">
  158. Guides
  159. <span class="md-nav__icon md-icon"></span>
  160. </label>
  161. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  162. <label class="md-nav__title" for="__nav_4">
  163. <span class="md-nav__icon md-icon"></span>
  164. Guides
  165. </label>
  166. <ul class="md-nav__list" data-md-scrollfix>
  167. <li class="md-nav__item">
  168. <a href="../guides-introduction/" class="md-nav__link">
  169. Introduction
  170. </a>
  171. </li>
  172. <li class="md-nav__item">
  173. <a href="../guides-getting-started/" class="md-nav__link">
  174. Getting started
  175. </a>
  176. </li>
  177. <li class="md-nav__item">
  178. <a href="../guides-templating/" class="md-nav__link">
  179. Advanced Templating
  180. </a>
  181. </li>
  182. <li class="md-nav__item">
  183. <a href="../guides-controller-class/" class="md-nav__link">
  184. Controller Classes
  185. </a>
  186. </li>
  187. <li class="md-nav__item md-nav__item--active">
  188. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  189. <label class="md-nav__link md-nav__link--active" for="__toc">
  190. All keys, One secret
  191. <span class="md-nav__icon md-icon"></span>
  192. </label>
  193. <a href="./" class="md-nav__link md-nav__link--active">
  194. All keys, One secret
  195. </a>
  196. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  197. <label class="md-nav__title" for="__toc">
  198. <span class="md-nav__icon md-icon"></span>
  199. Table of contents
  200. </label>
  201. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  202. <li class="md-nav__item">
  203. <a href="#creating-datafrom-external-secret" class="md-nav__link">
  204. Creating dataFrom external secret
  205. </a>
  206. </li>
  207. </ul>
  208. </nav>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  212. Common K8S Secret Types
  213. </a>
  214. </li>
  215. <li class="md-nav__item">
  216. <a href="../guides-multi-tenancy/" class="md-nav__link">
  217. Multi Tenancy
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-metrics/" class="md-nav__link">
  222. Metrics
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../guides-using-latest-image/" class="md-nav__link">
  227. Using Latest Image
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../guides-gitops-using-fluxcd/" class="md-nav__link">
  232. GitOps using FluxCD
  233. </a>
  234. </li>
  235. </ul>
  236. </nav>
  237. </li>
  238. <li class="md-nav__item md-nav__item--nested">
  239. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  240. <label class="md-nav__link" for="__nav_5">
  241. Provider
  242. <span class="md-nav__icon md-icon"></span>
  243. </label>
  244. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  245. <label class="md-nav__title" for="__nav_5">
  246. <span class="md-nav__icon md-icon"></span>
  247. Provider
  248. </label>
  249. <ul class="md-nav__list" data-md-scrollfix>
  250. <li class="md-nav__item md-nav__item--nested">
  251. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  252. <label class="md-nav__link" for="__nav_5_1">
  253. AWS
  254. <span class="md-nav__icon md-icon"></span>
  255. </label>
  256. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  257. <label class="md-nav__title" for="__nav_5_1">
  258. <span class="md-nav__icon md-icon"></span>
  259. AWS
  260. </label>
  261. <ul class="md-nav__list" data-md-scrollfix>
  262. <li class="md-nav__item">
  263. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  264. Secrets Manager
  265. </a>
  266. </li>
  267. <li class="md-nav__item">
  268. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  269. Parameter Store
  270. </a>
  271. </li>
  272. </ul>
  273. </nav>
  274. </li>
  275. <li class="md-nav__item md-nav__item--nested">
  276. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  277. <label class="md-nav__link" for="__nav_5_2">
  278. Azure
  279. <span class="md-nav__icon md-icon"></span>
  280. </label>
  281. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  282. <label class="md-nav__title" for="__nav_5_2">
  283. <span class="md-nav__icon md-icon"></span>
  284. Azure
  285. </label>
  286. <ul class="md-nav__list" data-md-scrollfix>
  287. <li class="md-nav__item">
  288. <a href="../provider-azure-key-vault/" class="md-nav__link">
  289. Key Vault
  290. </a>
  291. </li>
  292. </ul>
  293. </nav>
  294. </li>
  295. <li class="md-nav__item md-nav__item--nested">
  296. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  297. <label class="md-nav__link" for="__nav_5_3">
  298. Google
  299. <span class="md-nav__icon md-icon"></span>
  300. </label>
  301. <nav class="md-nav" aria-label="Google" data-md-level="2">
  302. <label class="md-nav__title" for="__nav_5_3">
  303. <span class="md-nav__icon md-icon"></span>
  304. Google
  305. </label>
  306. <ul class="md-nav__list" data-md-scrollfix>
  307. <li class="md-nav__item">
  308. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  309. Secrets Manager
  310. </a>
  311. </li>
  312. </ul>
  313. </nav>
  314. </li>
  315. <li class="md-nav__item md-nav__item--nested">
  316. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  317. <label class="md-nav__link" for="__nav_5_4">
  318. IBM
  319. <span class="md-nav__icon md-icon"></span>
  320. </label>
  321. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  322. <label class="md-nav__title" for="__nav_5_4">
  323. <span class="md-nav__icon md-icon"></span>
  324. IBM
  325. </label>
  326. <ul class="md-nav__list" data-md-scrollfix>
  327. <li class="md-nav__item">
  328. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  329. Secrets Manager
  330. </a>
  331. </li>
  332. </ul>
  333. </nav>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="../provider-akeyless/" class="md-nav__link">
  337. Akeyless
  338. </a>
  339. </li>
  340. <li class="md-nav__item">
  341. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  342. HashiCorp Vault
  343. </a>
  344. </li>
  345. <li class="md-nav__item md-nav__item--nested">
  346. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  347. <label class="md-nav__link" for="__nav_5_7">
  348. Yandex
  349. <span class="md-nav__icon md-icon"></span>
  350. </label>
  351. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  352. <label class="md-nav__title" for="__nav_5_7">
  353. <span class="md-nav__icon md-icon"></span>
  354. Yandex
  355. </label>
  356. <ul class="md-nav__list" data-md-scrollfix>
  357. <li class="md-nav__item">
  358. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  359. Lockbox
  360. </a>
  361. </li>
  362. </ul>
  363. </nav>
  364. </li>
  365. <li class="md-nav__item md-nav__item--nested">
  366. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  367. <label class="md-nav__link" for="__nav_5_8">
  368. Gitlab
  369. <span class="md-nav__icon md-icon"></span>
  370. </label>
  371. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  372. <label class="md-nav__title" for="__nav_5_8">
  373. <span class="md-nav__icon md-icon"></span>
  374. Gitlab
  375. </label>
  376. <ul class="md-nav__list" data-md-scrollfix>
  377. <li class="md-nav__item">
  378. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  379. Gitlab Project Variables
  380. </a>
  381. </li>
  382. </ul>
  383. </nav>
  384. </li>
  385. <li class="md-nav__item md-nav__item--nested">
  386. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  387. <label class="md-nav__link" for="__nav_5_9">
  388. Oracle
  389. <span class="md-nav__icon md-icon"></span>
  390. </label>
  391. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  392. <label class="md-nav__title" for="__nav_5_9">
  393. <span class="md-nav__icon md-icon"></span>
  394. Oracle
  395. </label>
  396. <ul class="md-nav__list" data-md-scrollfix>
  397. <li class="md-nav__item">
  398. <a href="../provider-oracle-vault/" class="md-nav__link">
  399. Oracle Vault
  400. </a>
  401. </li>
  402. </ul>
  403. </nav>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../provider-webhook/" class="md-nav__link">
  407. Webhook
  408. </a>
  409. </li>
  410. </ul>
  411. </nav>
  412. </li>
  413. <li class="md-nav__item md-nav__item--nested">
  414. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  415. <label class="md-nav__link" for="__nav_6">
  416. References
  417. <span class="md-nav__icon md-icon"></span>
  418. </label>
  419. <nav class="md-nav" aria-label="References" data-md-level="1">
  420. <label class="md-nav__title" for="__nav_6">
  421. <span class="md-nav__icon md-icon"></span>
  422. References
  423. </label>
  424. <ul class="md-nav__list" data-md-scrollfix>
  425. <li class="md-nav__item">
  426. <a href="../spec/" class="md-nav__link">
  427. API specification
  428. </a>
  429. </li>
  430. </ul>
  431. </nav>
  432. </li>
  433. <li class="md-nav__item md-nav__item--nested">
  434. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  435. <label class="md-nav__link" for="__nav_7">
  436. Contributing
  437. <span class="md-nav__icon md-icon"></span>
  438. </label>
  439. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  440. <label class="md-nav__title" for="__nav_7">
  441. <span class="md-nav__icon md-icon"></span>
  442. Contributing
  443. </label>
  444. <ul class="md-nav__list" data-md-scrollfix>
  445. <li class="md-nav__item">
  446. <a href="../contributing-devguide/" class="md-nav__link">
  447. Developer guide
  448. </a>
  449. </li>
  450. <li class="md-nav__item">
  451. <a href="../contributing-process/" class="md-nav__link">
  452. Contributing Process
  453. </a>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="../contributing-coc/" class="md-nav__link">
  457. Code of Conduct
  458. </a>
  459. </li>
  460. </ul>
  461. </nav>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../deprecation-policy/" class="md-nav__link">
  465. Deprecation Policy
  466. </a>
  467. </li>
  468. </ul>
  469. </nav>
  470. </div>
  471. </div>
  472. </div>
  473. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  474. <div class="md-sidebar__scrollwrap">
  475. <div class="md-sidebar__inner">
  476. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  477. <label class="md-nav__title" for="__toc">
  478. <span class="md-nav__icon md-icon"></span>
  479. Table of contents
  480. </label>
  481. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  482. <li class="md-nav__item">
  483. <a href="#creating-datafrom-external-secret" class="md-nav__link">
  484. Creating dataFrom external secret
  485. </a>
  486. </li>
  487. </ul>
  488. </nav>
  489. </div>
  490. </div>
  491. </div>
  492. <div class="md-content" data-md-component="content">
  493. <article class="md-content__inner md-typeset">
  494. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/guides-all-keys-one-secret.md" title="Edit this page" class="md-content__button md-icon">
  495. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  496. </a>
  497. <h1 id="all-keys-one-secret">All Keys, One Secret</h1>
  498. <p>To get multiple key-values from an external secret, not having to worry about how many, or what these keys are, we have to use the dataFrom field of the ExternalSecret resource, instead of the data field. We will give an example here with the gcp provider (should work with other providers in the same way).</p>
  499. <p>Please follow the authentication and SecretStore steps of the <a href="../provider-google-secrets-manager/">Google Cloud Secrets Manager guide</a> to setup access to your google cloud account first.</p>
  500. <p>Then create a secret in Google Cloud Secret Manager that contains a JSON string with multiple key values like this:</p>
  501. <p><img alt="secret-value" src="../pictures/screenshot_json_string_gcp_secret_value.png" /></p>
  502. <p>Let's call this secret all-keys-example-secret on Google Cloud.</p>
  503. <h3 id="creating-datafrom-external-secret">Creating dataFrom external secret</h3>
  504. <p>Now, when creating our ExternalSecret resource, instead of using the data field, we use the dataFrom field:</p>
  505. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  506. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  507. <span class="nt">metadata</span><span class="p">:</span>
  508. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  509. <span class="nt">spec</span><span class="p">:</span>
  510. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1h</span> <span class="c1"># rate SecretManager pulls GCPSM</span>
  511. <span class="nt">secretStoreRef</span><span class="p">:</span>
  512. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  513. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span> <span class="c1"># name of the SecretStore (or kind specified)</span>
  514. <span class="nt">target</span><span class="p">:</span>
  515. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-to-be-created</span> <span class="c1"># name of the k8s Secret to be created</span>
  516. <span class="nt">creationPolicy</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Owner</span>
  517. <span class="nt">dataFrom</span><span class="p">:</span>
  518. <span class="p p-Indicator">-</span> <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">all-keys-example-secret</span> <span class="c1"># name of the GCPSM secret</span>
  519. </code></pre></div>
  520. <p>To check both values we can run:</p>
  521. <div class="highlight"><pre><span></span><code>kubectl get secret secret-to-be-created -n &lt;namespace&gt; -o jsonpath=&#39;{.data.username}&#39; | base64 -d
  522. kubectl get secret secret-to-be-created -n &lt;namespace&gt; -o jsonpath=&#39;{.data.surname}&#39; | base64 -d
  523. </code></pre></div>
  524. </article>
  525. </div>
  526. </div>
  527. </main>
  528. <footer class="md-footer">
  529. <nav class="md-footer__inner md-grid" aria-label="Footer">
  530. <a href="../guides-controller-class/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Controller Classes" rel="prev">
  531. <div class="md-footer__button md-icon">
  532. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  533. </div>
  534. <div class="md-footer__title">
  535. <div class="md-ellipsis">
  536. <span class="md-footer__direction">
  537. Previous
  538. </span>
  539. Controller Classes
  540. </div>
  541. </div>
  542. </a>
  543. <a href="../guides-common-k8s-secret-types/" class="md-footer__link md-footer__link--next" aria-label="Next: Common K8S Secret Types" rel="next">
  544. <div class="md-footer__title">
  545. <div class="md-ellipsis">
  546. <span class="md-footer__direction">
  547. Next
  548. </span>
  549. Common K8S Secret Types
  550. </div>
  551. </div>
  552. <div class="md-footer__button md-icon">
  553. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  554. </div>
  555. </a>
  556. </nav>
  557. <div class="md-footer-meta md-typeset">
  558. <div class="md-footer-meta__inner md-grid">
  559. <div class="md-footer-copyright">
  560. Made with
  561. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  562. Material for MkDocs
  563. </a>
  564. </div>
  565. </div>
  566. </div>
  567. </footer>
  568. </div>
  569. <div class="md-dialog" data-md-component="dialog">
  570. <div class="md-dialog__inner md-typeset"></div>
  571. </div>
  572. <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.b0710199.min.js", "version": {"provider": "mike"}}</script>
  573. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  574. </body>
  575. </html>