index.html 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594
  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.2.3, mkdocs-material-8.1.9">
  8. <title>Secret Manager - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.2b4465f4.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.e6a45f82.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:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  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="#google-cloud-secret-manager" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <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>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. Secret Manager
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <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>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <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" required>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <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>
  72. <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>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <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>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <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>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <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>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <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>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href=".." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../api-overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../api-externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../api-secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../api-clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. </ul>
  166. </nav>
  167. </li>
  168. <li class="md-nav__item md-nav__item--nested">
  169. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  170. <label class="md-nav__link" for="__nav_4">
  171. Guides
  172. <span class="md-nav__icon md-icon"></span>
  173. </label>
  174. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  175. <label class="md-nav__title" for="__nav_4">
  176. <span class="md-nav__icon md-icon"></span>
  177. Guides
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../guides-introduction/" class="md-nav__link">
  182. Introduction
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../guides-getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-templating/" class="md-nav__link">
  192. Advanced Templating
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../guides-controller-class/" class="md-nav__link">
  197. Controller Classes
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  202. All keys, One secret
  203. </a>
  204. </li>
  205. <li class="md-nav__item">
  206. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  207. Common K8S Secret Types
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../guides-multi-tenancy/" class="md-nav__link">
  212. Multi Tenancy
  213. </a>
  214. </li>
  215. <li class="md-nav__item">
  216. <a href="../guides-metrics/" class="md-nav__link">
  217. Metrics
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-using-latest-image/" class="md-nav__link">
  222. Using Latest Image
  223. </a>
  224. </li>
  225. </ul>
  226. </nav>
  227. </li>
  228. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  229. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  230. <label class="md-nav__link" for="__nav_5">
  231. Provider
  232. <span class="md-nav__icon md-icon"></span>
  233. </label>
  234. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  235. <label class="md-nav__title" for="__nav_5">
  236. <span class="md-nav__icon md-icon"></span>
  237. Provider
  238. </label>
  239. <ul class="md-nav__list" data-md-scrollfix>
  240. <li class="md-nav__item md-nav__item--nested">
  241. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  242. <label class="md-nav__link" for="__nav_5_1">
  243. AWS
  244. <span class="md-nav__icon md-icon"></span>
  245. </label>
  246. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  247. <label class="md-nav__title" for="__nav_5_1">
  248. <span class="md-nav__icon md-icon"></span>
  249. AWS
  250. </label>
  251. <ul class="md-nav__list" data-md-scrollfix>
  252. <li class="md-nav__item">
  253. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  254. Secrets Manager
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  259. Parameter Store
  260. </a>
  261. </li>
  262. </ul>
  263. </nav>
  264. </li>
  265. <li class="md-nav__item md-nav__item--nested">
  266. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  267. <label class="md-nav__link" for="__nav_5_2">
  268. Azure
  269. <span class="md-nav__icon md-icon"></span>
  270. </label>
  271. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_5_2">
  273. <span class="md-nav__icon md-icon"></span>
  274. Azure
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../provider-azure-key-vault/" class="md-nav__link">
  279. Key Vault
  280. </a>
  281. </li>
  282. </ul>
  283. </nav>
  284. </li>
  285. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  286. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" checked>
  287. <label class="md-nav__link" for="__nav_5_3">
  288. Google
  289. <span class="md-nav__icon md-icon"></span>
  290. </label>
  291. <nav class="md-nav" aria-label="Google" data-md-level="2">
  292. <label class="md-nav__title" for="__nav_5_3">
  293. <span class="md-nav__icon md-icon"></span>
  294. Google
  295. </label>
  296. <ul class="md-nav__list" data-md-scrollfix>
  297. <li class="md-nav__item md-nav__item--active">
  298. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  299. <label class="md-nav__link md-nav__link--active" for="__toc">
  300. Secret Manager
  301. <span class="md-nav__icon md-icon"></span>
  302. </label>
  303. <a href="./" class="md-nav__link md-nav__link--active">
  304. Secret Manager
  305. </a>
  306. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  307. <label class="md-nav__title" for="__toc">
  308. <span class="md-nav__icon md-icon"></span>
  309. Table of contents
  310. </label>
  311. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  312. <li class="md-nav__item">
  313. <a href="#google-cloud-secret-manager" class="md-nav__link">
  314. Google Cloud Secret Manager
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="#authentication" class="md-nav__link">
  319. Authentication
  320. </a>
  321. <nav class="md-nav" aria-label="Authentication">
  322. <ul class="md-nav__list">
  323. <li class="md-nav__item">
  324. <a href="#workload-identity" class="md-nav__link">
  325. Workload Identity
  326. </a>
  327. <nav class="md-nav" aria-label="Workload Identity">
  328. <ul class="md-nav__list">
  329. <li class="md-nav__item">
  330. <a href="#creating-workload-identity-service-accounts" class="md-nav__link">
  331. Creating Workload Identity Service Accounts
  332. </a>
  333. </li>
  334. <li class="md-nav__item">
  335. <a href="#using-service-accounts-directly" class="md-nav__link">
  336. Using Service Accounts directly
  337. </a>
  338. </li>
  339. <li class="md-nav__item">
  340. <a href="#using-pod-based-workload-identity" class="md-nav__link">
  341. Using Pod-based Workload Identity
  342. </a>
  343. </li>
  344. </ul>
  345. </nav>
  346. </li>
  347. <li class="md-nav__item">
  348. <a href="#gcp-service-account-authentication" class="md-nav__link">
  349. GCP Service Account authentication
  350. </a>
  351. <nav class="md-nav" aria-label="GCP Service Account authentication">
  352. <ul class="md-nav__list">
  353. <li class="md-nav__item">
  354. <a href="#update-secret-store" class="md-nav__link">
  355. Update secret store
  356. </a>
  357. </li>
  358. <li class="md-nav__item">
  359. <a href="#creating-external-secret" class="md-nav__link">
  360. Creating external secret
  361. </a>
  362. </li>
  363. </ul>
  364. </nav>
  365. </li>
  366. </ul>
  367. </nav>
  368. </li>
  369. </ul>
  370. </nav>
  371. </li>
  372. </ul>
  373. </nav>
  374. </li>
  375. <li class="md-nav__item md-nav__item--nested">
  376. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  377. <label class="md-nav__link" for="__nav_5_4">
  378. IBM
  379. <span class="md-nav__icon md-icon"></span>
  380. </label>
  381. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  382. <label class="md-nav__title" for="__nav_5_4">
  383. <span class="md-nav__icon md-icon"></span>
  384. IBM
  385. </label>
  386. <ul class="md-nav__list" data-md-scrollfix>
  387. <li class="md-nav__item">
  388. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  389. Secrets Manager
  390. </a>
  391. </li>
  392. </ul>
  393. </nav>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../provider-akeyless/" class="md-nav__link">
  397. Akeyless
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  402. HashiCorp Vault
  403. </a>
  404. </li>
  405. <li class="md-nav__item md-nav__item--nested">
  406. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  407. <label class="md-nav__link" for="__nav_5_7">
  408. Yandex
  409. <span class="md-nav__icon md-icon"></span>
  410. </label>
  411. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  412. <label class="md-nav__title" for="__nav_5_7">
  413. <span class="md-nav__icon md-icon"></span>
  414. Yandex
  415. </label>
  416. <ul class="md-nav__list" data-md-scrollfix>
  417. <li class="md-nav__item">
  418. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  419. Lockbox
  420. </a>
  421. </li>
  422. </ul>
  423. </nav>
  424. </li>
  425. <li class="md-nav__item md-nav__item--nested">
  426. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  427. <label class="md-nav__link" for="__nav_5_8">
  428. Gitlab
  429. <span class="md-nav__icon md-icon"></span>
  430. </label>
  431. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  432. <label class="md-nav__title" for="__nav_5_8">
  433. <span class="md-nav__icon md-icon"></span>
  434. Gitlab
  435. </label>
  436. <ul class="md-nav__list" data-md-scrollfix>
  437. <li class="md-nav__item">
  438. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  439. Gitlab Project Variables
  440. </a>
  441. </li>
  442. </ul>
  443. </nav>
  444. </li>
  445. <li class="md-nav__item md-nav__item--nested">
  446. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  447. <label class="md-nav__link" for="__nav_5_9">
  448. Oracle
  449. <span class="md-nav__icon md-icon"></span>
  450. </label>
  451. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  452. <label class="md-nav__title" for="__nav_5_9">
  453. <span class="md-nav__icon md-icon"></span>
  454. Oracle
  455. </label>
  456. <ul class="md-nav__list" data-md-scrollfix>
  457. <li class="md-nav__item">
  458. <a href="../provider-oracle-vault/" class="md-nav__link">
  459. Oracle Vault
  460. </a>
  461. </li>
  462. </ul>
  463. </nav>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../provider-webhook/" class="md-nav__link">
  467. Webhook
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../provider-fake/" class="md-nav__link">
  472. Fake
  473. </a>
  474. </li>
  475. </ul>
  476. </nav>
  477. </li>
  478. <li class="md-nav__item md-nav__item--nested">
  479. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  480. <label class="md-nav__link" for="__nav_6">
  481. Examples
  482. <span class="md-nav__icon md-icon"></span>
  483. </label>
  484. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  485. <label class="md-nav__title" for="__nav_6">
  486. <span class="md-nav__icon md-icon"></span>
  487. Examples
  488. </label>
  489. <ul class="md-nav__list" data-md-scrollfix>
  490. <li class="md-nav__item">
  491. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  492. FluxCD
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  497. Anchore Engine
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  502. Jenkins
  503. </a>
  504. </li>
  505. </ul>
  506. </nav>
  507. </li>
  508. <li class="md-nav__item md-nav__item--nested">
  509. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  510. <label class="md-nav__link" for="__nav_7">
  511. References
  512. <span class="md-nav__icon md-icon"></span>
  513. </label>
  514. <nav class="md-nav" aria-label="References" data-md-level="1">
  515. <label class="md-nav__title" for="__nav_7">
  516. <span class="md-nav__icon md-icon"></span>
  517. References
  518. </label>
  519. <ul class="md-nav__list" data-md-scrollfix>
  520. <li class="md-nav__item">
  521. <a href="../spec/" class="md-nav__link">
  522. API specification
  523. </a>
  524. </li>
  525. </ul>
  526. </nav>
  527. </li>
  528. <li class="md-nav__item md-nav__item--nested">
  529. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  530. <label class="md-nav__link" for="__nav_8">
  531. Contributing
  532. <span class="md-nav__icon md-icon"></span>
  533. </label>
  534. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  535. <label class="md-nav__title" for="__nav_8">
  536. <span class="md-nav__icon md-icon"></span>
  537. Contributing
  538. </label>
  539. <ul class="md-nav__list" data-md-scrollfix>
  540. <li class="md-nav__item">
  541. <a href="../contributing-devguide/" class="md-nav__link">
  542. Developer guide
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="../contributing-process/" class="md-nav__link">
  547. Contributing Process
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../contributing-coc/" class="md-nav__link">
  552. Code of Conduct
  553. </a>
  554. </li>
  555. </ul>
  556. </nav>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../deprecation-policy/" class="md-nav__link">
  560. Deprecation Policy
  561. </a>
  562. </li>
  563. </ul>
  564. </nav>
  565. </div>
  566. </div>
  567. </div>
  568. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  569. <div class="md-sidebar__scrollwrap">
  570. <div class="md-sidebar__inner">
  571. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  572. <label class="md-nav__title" for="__toc">
  573. <span class="md-nav__icon md-icon"></span>
  574. Table of contents
  575. </label>
  576. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  577. <li class="md-nav__item">
  578. <a href="#google-cloud-secret-manager" class="md-nav__link">
  579. Google Cloud Secret Manager
  580. </a>
  581. </li>
  582. <li class="md-nav__item">
  583. <a href="#authentication" class="md-nav__link">
  584. Authentication
  585. </a>
  586. <nav class="md-nav" aria-label="Authentication">
  587. <ul class="md-nav__list">
  588. <li class="md-nav__item">
  589. <a href="#workload-identity" class="md-nav__link">
  590. Workload Identity
  591. </a>
  592. <nav class="md-nav" aria-label="Workload Identity">
  593. <ul class="md-nav__list">
  594. <li class="md-nav__item">
  595. <a href="#creating-workload-identity-service-accounts" class="md-nav__link">
  596. Creating Workload Identity Service Accounts
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="#using-service-accounts-directly" class="md-nav__link">
  601. Using Service Accounts directly
  602. </a>
  603. </li>
  604. <li class="md-nav__item">
  605. <a href="#using-pod-based-workload-identity" class="md-nav__link">
  606. Using Pod-based Workload Identity
  607. </a>
  608. </li>
  609. </ul>
  610. </nav>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="#gcp-service-account-authentication" class="md-nav__link">
  614. GCP Service Account authentication
  615. </a>
  616. <nav class="md-nav" aria-label="GCP Service Account authentication">
  617. <ul class="md-nav__list">
  618. <li class="md-nav__item">
  619. <a href="#update-secret-store" class="md-nav__link">
  620. Update secret store
  621. </a>
  622. </li>
  623. <li class="md-nav__item">
  624. <a href="#creating-external-secret" class="md-nav__link">
  625. Creating external secret
  626. </a>
  627. </li>
  628. </ul>
  629. </nav>
  630. </li>
  631. </ul>
  632. </nav>
  633. </li>
  634. </ul>
  635. </nav>
  636. </div>
  637. </div>
  638. </div>
  639. <div class="md-content" data-md-component="content">
  640. <article class="md-content__inner md-typeset">
  641. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/provider-google-secrets-manager.md" title="Edit this page" class="md-content__button md-icon">
  642. <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>
  643. </a>
  644. <h1>Secret Manager</h1>
  645. <h2 id="google-cloud-secret-manager">Google Cloud Secret Manager</h2>
  646. <p>External Secrets Operator integrates with <a href="https://cloud.google.com/secret-manager">GCP Secret Manager</a> for secret management.</p>
  647. <h2 id="authentication">Authentication</h2>
  648. <h3 id="workload-identity">Workload Identity</h3>
  649. <p>Your Google Kubernetes Engine (GKE) applications can consume GCP services like Secrets Manager without using static, long-lived authentication tokens. This is our recommended approach of handling credentials in GCP. ESO offers two options for integrating with GKE workload identity: <strong>pod-based workload identity</strong> and <strong>using service accounts directly</strong>. Before using either way you need to create a service account - this is covered below.</p>
  650. <h4 id="creating-workload-identity-service-accounts">Creating Workload Identity Service Accounts</h4>
  651. <p>You can find the documentation for Workload Identity <a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">here</a>. We will walk you through how to navigate it here.</p>
  652. <p>Search <a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">the documment</a> for this editable values and change them to your values:</p>
  653. <ul>
  654. <li><code>CLUSTER_NAME</code>: The name of your cluster</li>
  655. <li><code>PROJECT_ID</code>: Your project ID (not your Project number nor your Project name)</li>
  656. <li><code>K8S_NAMESPACE</code>: For us folowing these steps here it will be <code>es</code>, but this will be the namespace where you deployed the external-secrets operator</li>
  657. <li><code>KSA_NAME</code>: external-secrets (if you are not creating a new one to attach to the deployemnt)</li>
  658. <li><code>GSA_NAME</code>: external-secrets for simplicity, or something else if you have to follow different naming convetions for cloud resources</li>
  659. <li><code>ROLE_NAME</code>: should be <code>roles/secretmanager.secretAccessor</code> - so you make the pod only be able to access secrets on Secret Manager</li>
  660. </ul>
  661. <h4 id="using-service-accounts-directly">Using Service Accounts directly</h4>
  662. <p>Let's assume you have created a service account correctly and attached a appropriate workload identity. It should roughly look like this:</p>
  663. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">v1</span>
  664. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span>
  665. <span class="nt">metadata</span><span class="p">:</span>
  666. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">team-a</span>
  667. <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">team-a</span>
  668. <span class="nt">annotations</span><span class="p">:</span>
  669. <span class="nt">iam.gke.io/gcp-service-account</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-team-a@my-project.iam.gserviceaccount.com</span>
  670. </code></pre></div>
  671. <p>You can reference this particular ServiceAccount in a <code>SecretStore</code> or <code>ClusterSecretStore</code>. It's important that you also set the <code>projectID</code>, <code>clusterLocation</code> and <code>clusterName</code>. The Namespace on the <code>serviceAccountRef</code> is ignored when using a <code>SecretStore</code> resource. This is needed to isolate the namespaces properly.</p>
  672. <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>
  673. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  674. <span class="nt">metadata</span><span class="p">:</span>
  675. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  676. <span class="nt">spec</span><span class="p">:</span>
  677. <span class="nt">provider</span><span class="p">:</span>
  678. <span class="nt">gcpsm</span><span class="p">:</span>
  679. <span class="nt">projectID</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">my-project</span>
  680. <span class="nt">auth</span><span class="p">:</span>
  681. <span class="nt">workloadIdentity</span><span class="p">:</span>
  682. <span class="c1"># name of the cluster region</span>
  683. <span class="nt">clusterLocation</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">europe-central2</span>
  684. <span class="c1"># name of the GKE cluster</span>
  685. <span class="nt">clusterName</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-workload-identity</span>
  686. <span class="c1"># reference the sa from above</span>
  687. <span class="nt">serviceAccountRef</span><span class="p">:</span>
  688. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">team-a</span>
  689. <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">team-a</span>
  690. </code></pre></div>
  691. <p><em>You need to give the Google service account the <code>roles/iam.serviceAccountTokenCreator</code> role so it can generate a service account token for you (not necessary in the Pod-based Workload Identity bellow)</em></p>
  692. <h4 id="using-pod-based-workload-identity">Using Pod-based Workload Identity</h4>
  693. <p>You can attach a Workload Identity directly to the ESO pod. ESO then has access to all the APIs defined in the attached service account policy. You attach the workload identity by (1) creating a service account with a attached workload identity (described above) and (2) using this particular service account in the pod's <code>serviceAccountName</code> field.</p>
  694. <p>For this example we will assume that you installed ESO using helm and that you named the chart installation <code>external-secrets</code> and the namespace where it lives <code>es</code> like:</p>
  695. <div class="highlight"><pre><span></span><code>helm install external-secrets external-secrets/external-secrets --namespace es
  696. </code></pre></div>
  697. <p>Then most of the resources would have this name, the important one here being the k8s service account attached to the external-secrets operator deployment:</p>
  698. <div class="highlight"><pre><span></span><code><span class="c1"># ...</span>
  699. <span class="nt">containers</span><span class="p">:</span>
  700. <span class="p p-Indicator">-</span> <span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ghcr.io/external-secrets/external-secrets:vVERSION</span>
  701. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  702. <span class="nt">ports</span><span class="p">:</span>
  703. <span class="p p-Indicator">-</span> <span class="nt">containerPort</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">8080</span>
  704. <span class="nt">protocol</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">TCP</span>
  705. <span class="nt">restartPolicy</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Always</span>
  706. <span class="nt">schedulerName</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">default-scheduler</span>
  707. <span class="nt">serviceAccount</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  708. <span class="nt">serviceAccountName</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets</span> <span class="c1"># &lt;--- here</span>
  709. </code></pre></div>
  710. <p>The pod now has the identity. Now you need to configure the <code>SecretStore</code>.
  711. You just need to set the <code>projectID</code>, all other fields can be omitted.</p>
  712. <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>
  713. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  714. <span class="nt">metadata</span><span class="p">:</span>
  715. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  716. <span class="nt">spec</span><span class="p">:</span>
  717. <span class="nt">provider</span><span class="p">:</span>
  718. <span class="nt">gcpsm</span><span class="p">:</span>
  719. <span class="nt">projectID</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">pid</span>
  720. </code></pre></div>
  721. <h3 id="gcp-service-account-authentication">GCP Service Account authentication</h3>
  722. <p>You can use <a href="https://cloud.google.com/iam/docs/service-accounts">GCP Service Account</a> to authenticate with GCP. These are static, long-lived credentials. A GCP Service Account is a JSON file that needs to be stored in a <code>Kind=Secret</code>. ESO will use that Secret to authenticate with GCP. See here how you <a href="https://cloud.google.com/iam/docs/creating-managing-service-accounts">manage GCP Service Accounts</a>.</p>
  723. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">v1</span>
  724. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Secret</span>
  725. <span class="nt">metadata</span><span class="p">:</span>
  726. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gcpsm-secret</span>
  727. <span class="nt">labels</span><span class="p">:</span>
  728. <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gcpsm</span>
  729. <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Opaque</span>
  730. <span class="nt">stringData</span><span class="p">:</span>
  731. <span class="nt">secret-access-credentials</span><span class="p">:</span> <span class="p p-Indicator">|-</span>
  732. <span class="no">{</span>
  733. <span class="no">&quot;type&quot;: &quot;service_account&quot;,</span>
  734. <span class="no">&quot;project_id&quot;: &quot;external-secrets-operator&quot;,</span>
  735. <span class="no">&quot;private_key_id&quot;: &quot;&quot;,</span>
  736. <span class="no">&quot;private_key&quot;: &quot;-----BEGIN PRIVATE KEY-----\nA key\n-----END PRIVATE KEY-----\n&quot;,</span>
  737. <span class="no">&quot;client_email&quot;: &quot;test-service-account@external-secrets-operator.iam.gserviceaccount.com&quot;,</span>
  738. <span class="no">&quot;client_id&quot;: &quot;client ID&quot;,</span>
  739. <span class="no">&quot;auth_uri&quot;: &quot;https://accounts.google.com/o/oauth2/auth&quot;,</span>
  740. <span class="no">&quot;token_uri&quot;: &quot;https://oauth2.googleapis.com/token&quot;,</span>
  741. <span class="no">&quot;auth_provider_x509_cert_url&quot;: &quot;https://www.googleapis.com/oauth2/v1/certs&quot;,</span>
  742. <span class="no">&quot;client_x509_cert_url&quot;: &quot;https://www.googleapis.com/robot/v1/metadata/x509/test-service-account%40external-secrets-operator.iam.gserviceaccount.com&quot;</span>
  743. <span class="no">}</span>
  744. </code></pre></div>
  745. <h4 id="update-secret-store">Update secret store</h4>
  746. <p>Be sure the <code>gcpsm</code> provider is listed in the <code>Kind=SecretStore</code></p>
  747. <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>
  748. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  749. <span class="nt">metadata</span><span class="p">:</span>
  750. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  751. <span class="nt">spec</span><span class="p">:</span>
  752. <span class="nt">provider</span><span class="p">:</span>
  753. <span class="nt">gcpsm</span><span class="p">:</span> <span class="c1"># gcpsm provider</span>
  754. <span class="nt">auth</span><span class="p">:</span>
  755. <span class="nt">secretRef</span><span class="p">:</span>
  756. <span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  757. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gcpsm-secret</span> <span class="c1"># secret name containing SA key</span>
  758. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-access-credentials</span> <span class="c1"># key name containing SA key</span>
  759. <span class="nt">projectID</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">myproject</span> <span class="c1"># name of Google Cloud project</span>
  760. </code></pre></div>
  761. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> for <code>SecretAccessKeyRef</code> with the namespace of the secret that we just created.</p>
  762. <h4 id="creating-external-secret">Creating external secret</h4>
  763. <p>To create a kubernetes secret from the GCP Secret Manager secret a <code>Kind=ExternalSecret</code> is needed.</p>
  764. <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>
  765. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  766. <span class="nt">metadata</span><span class="p">:</span>
  767. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  768. <span class="nt">spec</span><span class="p">:</span>
  769. <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>
  770. <span class="nt">secretStoreRef</span><span class="p">:</span>
  771. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  772. <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>
  773. <span class="nt">target</span><span class="p">:</span>
  774. <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>
  775. <span class="nt">creationPolicy</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Owner</span>
  776. <span class="nt">data</span><span class="p">:</span>
  777. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev-secret-test</span> <span class="c1"># name of the GCPSM secret key</span>
  778. <span class="nt">remoteRef</span><span class="p">:</span>
  779. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev-secret-test</span>
  780. </code></pre></div>
  781. <p>The operator will fetch the GCP Secret Manager secret and inject it as a <code>Kind=Secret</code>
  782. <div class="highlight"><pre><span></span><code>kubectl get secret secret-to-be-created -n &lt;namespace&gt; | -o jsonpath=&#39;{.data.dev-secret-test}&#39; | base64 -d
  783. </code></pre></div></p>
  784. </article>
  785. </div>
  786. </div>
  787. </main>
  788. <footer class="md-footer">
  789. <nav class="md-footer__inner md-grid" aria-label="Footer">
  790. <a href="../provider-azure-key-vault/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Key Vault" rel="prev">
  791. <div class="md-footer__button md-icon">
  792. <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>
  793. </div>
  794. <div class="md-footer__title">
  795. <div class="md-ellipsis">
  796. <span class="md-footer__direction">
  797. Previous
  798. </span>
  799. Key Vault
  800. </div>
  801. </div>
  802. </a>
  803. <a href="../provider-ibm-secrets-manager/" class="md-footer__link md-footer__link--next" aria-label="Next: Secrets Manager" rel="next">
  804. <div class="md-footer__title">
  805. <div class="md-ellipsis">
  806. <span class="md-footer__direction">
  807. Next
  808. </span>
  809. Secrets Manager
  810. </div>
  811. </div>
  812. <div class="md-footer__button md-icon">
  813. <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>
  814. </div>
  815. </a>
  816. </nav>
  817. <div class="md-footer-meta md-typeset">
  818. <div class="md-footer-meta__inner md-grid">
  819. <div class="md-copyright">
  820. Made with
  821. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  822. Material for MkDocs
  823. </a>
  824. </div>
  825. </div>
  826. </div>
  827. </footer>
  828. </div>
  829. <div class="md-dialog" data-md-component="dialog">
  830. <div class="md-dialog__inner md-typeset"></div>
  831. </div>
  832. <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.22074ed6.min.js", "version": {"provider": "mike"}}</script>
  833. <script src="../assets/javascripts/bundle.960e086b.min.js"></script>
  834. </body>
  835. </html>