index.html 54 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633
  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.10">
  8. <title>Secret Manager - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.d6be258b.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 md-nav__item--nested">
  191. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  192. <label class="md-nav__link" for="__nav_4_3">
  193. Advanced Templating
  194. <span class="md-nav__icon md-icon"></span>
  195. </label>
  196. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  197. <label class="md-nav__title" for="__nav_4_3">
  198. <span class="md-nav__icon md-icon"></span>
  199. Advanced Templating
  200. </label>
  201. <ul class="md-nav__list" data-md-scrollfix>
  202. <li class="md-nav__item">
  203. <a href="../guides-templating/" class="md-nav__link">
  204. v2
  205. </a>
  206. </li>
  207. <li class="md-nav__item">
  208. <a href="../guides-templating-v1/" class="md-nav__link">
  209. v1
  210. </a>
  211. </li>
  212. </ul>
  213. </nav>
  214. </li>
  215. <li class="md-nav__item">
  216. <a href="../guides-controller-class/" class="md-nav__link">
  217. Controller Classes
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  222. All keys, One secret
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  227. Common K8S Secret Types
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../guides-multi-tenancy/" class="md-nav__link">
  232. Multi Tenancy
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="../guides-metrics/" class="md-nav__link">
  237. Metrics
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../guides-using-latest-image/" class="md-nav__link">
  242. Using Latest Image
  243. </a>
  244. </li>
  245. </ul>
  246. </nav>
  247. </li>
  248. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  249. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  250. <label class="md-nav__link" for="__nav_5">
  251. Provider
  252. <span class="md-nav__icon md-icon"></span>
  253. </label>
  254. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  255. <label class="md-nav__title" for="__nav_5">
  256. <span class="md-nav__icon md-icon"></span>
  257. Provider
  258. </label>
  259. <ul class="md-nav__list" data-md-scrollfix>
  260. <li class="md-nav__item md-nav__item--nested">
  261. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  262. <label class="md-nav__link" for="__nav_5_1">
  263. AWS
  264. <span class="md-nav__icon md-icon"></span>
  265. </label>
  266. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  267. <label class="md-nav__title" for="__nav_5_1">
  268. <span class="md-nav__icon md-icon"></span>
  269. AWS
  270. </label>
  271. <ul class="md-nav__list" data-md-scrollfix>
  272. <li class="md-nav__item">
  273. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  274. Secrets Manager
  275. </a>
  276. </li>
  277. <li class="md-nav__item">
  278. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  279. Parameter Store
  280. </a>
  281. </li>
  282. </ul>
  283. </nav>
  284. </li>
  285. <li class="md-nav__item md-nav__item--nested">
  286. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  287. <label class="md-nav__link" for="__nav_5_2">
  288. Azure
  289. <span class="md-nav__icon md-icon"></span>
  290. </label>
  291. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  292. <label class="md-nav__title" for="__nav_5_2">
  293. <span class="md-nav__icon md-icon"></span>
  294. Azure
  295. </label>
  296. <ul class="md-nav__list" data-md-scrollfix>
  297. <li class="md-nav__item">
  298. <a href="../provider-azure-key-vault/" class="md-nav__link">
  299. Key Vault
  300. </a>
  301. </li>
  302. </ul>
  303. </nav>
  304. </li>
  305. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  306. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" checked>
  307. <label class="md-nav__link" for="__nav_5_3">
  308. Google
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" aria-label="Google" data-md-level="2">
  312. <label class="md-nav__title" for="__nav_5_3">
  313. <span class="md-nav__icon md-icon"></span>
  314. Google
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item md-nav__item--active">
  318. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  319. <label class="md-nav__link md-nav__link--active" for="__toc">
  320. Secret Manager
  321. <span class="md-nav__icon md-icon"></span>
  322. </label>
  323. <a href="./" class="md-nav__link md-nav__link--active">
  324. Secret Manager
  325. </a>
  326. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  327. <label class="md-nav__title" for="__toc">
  328. <span class="md-nav__icon md-icon"></span>
  329. Table of contents
  330. </label>
  331. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  332. <li class="md-nav__item">
  333. <a href="#google-cloud-secret-manager" class="md-nav__link">
  334. Google Cloud Secret Manager
  335. </a>
  336. </li>
  337. <li class="md-nav__item">
  338. <a href="#authentication" class="md-nav__link">
  339. Authentication
  340. </a>
  341. <nav class="md-nav" aria-label="Authentication">
  342. <ul class="md-nav__list">
  343. <li class="md-nav__item">
  344. <a href="#workload-identity" class="md-nav__link">
  345. Workload Identity
  346. </a>
  347. <nav class="md-nav" aria-label="Workload Identity">
  348. <ul class="md-nav__list">
  349. <li class="md-nav__item">
  350. <a href="#creating-workload-identity-service-accounts" class="md-nav__link">
  351. Creating Workload Identity Service Accounts
  352. </a>
  353. </li>
  354. <li class="md-nav__item">
  355. <a href="#using-service-accounts-directly" class="md-nav__link">
  356. Using Service Accounts directly
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="#using-pod-based-workload-identity" class="md-nav__link">
  361. Using Pod-based Workload Identity
  362. </a>
  363. </li>
  364. </ul>
  365. </nav>
  366. </li>
  367. <li class="md-nav__item">
  368. <a href="#gcp-service-account-authentication" class="md-nav__link">
  369. GCP Service Account authentication
  370. </a>
  371. <nav class="md-nav" aria-label="GCP Service Account authentication">
  372. <ul class="md-nav__list">
  373. <li class="md-nav__item">
  374. <a href="#update-secret-store" class="md-nav__link">
  375. Update secret store
  376. </a>
  377. </li>
  378. <li class="md-nav__item">
  379. <a href="#creating-external-secret" class="md-nav__link">
  380. Creating external secret
  381. </a>
  382. </li>
  383. </ul>
  384. </nav>
  385. </li>
  386. </ul>
  387. </nav>
  388. </li>
  389. </ul>
  390. </nav>
  391. </li>
  392. </ul>
  393. </nav>
  394. </li>
  395. <li class="md-nav__item md-nav__item--nested">
  396. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  397. <label class="md-nav__link" for="__nav_5_4">
  398. IBM
  399. <span class="md-nav__icon md-icon"></span>
  400. </label>
  401. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  402. <label class="md-nav__title" for="__nav_5_4">
  403. <span class="md-nav__icon md-icon"></span>
  404. IBM
  405. </label>
  406. <ul class="md-nav__list" data-md-scrollfix>
  407. <li class="md-nav__item">
  408. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  409. Secrets Manager
  410. </a>
  411. </li>
  412. </ul>
  413. </nav>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../provider-akeyless/" class="md-nav__link">
  417. Akeyless
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  422. HashiCorp Vault
  423. </a>
  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_7" type="checkbox" id="__nav_5_7" >
  427. <label class="md-nav__link" for="__nav_5_7">
  428. Yandex
  429. <span class="md-nav__icon md-icon"></span>
  430. </label>
  431. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  432. <label class="md-nav__title" for="__nav_5_7">
  433. <span class="md-nav__icon md-icon"></span>
  434. Yandex
  435. </label>
  436. <ul class="md-nav__list" data-md-scrollfix>
  437. <li class="md-nav__item">
  438. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  439. Lockbox
  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_8" type="checkbox" id="__nav_5_8" >
  447. <label class="md-nav__link" for="__nav_5_8">
  448. Gitlab
  449. <span class="md-nav__icon md-icon"></span>
  450. </label>
  451. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  452. <label class="md-nav__title" for="__nav_5_8">
  453. <span class="md-nav__icon md-icon"></span>
  454. Gitlab
  455. </label>
  456. <ul class="md-nav__list" data-md-scrollfix>
  457. <li class="md-nav__item">
  458. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  459. Gitlab Project Variables
  460. </a>
  461. </li>
  462. </ul>
  463. </nav>
  464. </li>
  465. <li class="md-nav__item md-nav__item--nested">
  466. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  467. <label class="md-nav__link" for="__nav_5_9">
  468. Oracle
  469. <span class="md-nav__icon md-icon"></span>
  470. </label>
  471. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  472. <label class="md-nav__title" for="__nav_5_9">
  473. <span class="md-nav__icon md-icon"></span>
  474. Oracle
  475. </label>
  476. <ul class="md-nav__list" data-md-scrollfix>
  477. <li class="md-nav__item">
  478. <a href="../provider-oracle-vault/" class="md-nav__link">
  479. Oracle Vault
  480. </a>
  481. </li>
  482. </ul>
  483. </nav>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="../provider-webhook/" class="md-nav__link">
  487. Webhook
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../provider-fake/" class="md-nav__link">
  492. Fake
  493. </a>
  494. </li>
  495. </ul>
  496. </nav>
  497. </li>
  498. <li class="md-nav__item md-nav__item--nested">
  499. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  500. <label class="md-nav__link" for="__nav_6">
  501. Examples
  502. <span class="md-nav__icon md-icon"></span>
  503. </label>
  504. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  505. <label class="md-nav__title" for="__nav_6">
  506. <span class="md-nav__icon md-icon"></span>
  507. Examples
  508. </label>
  509. <ul class="md-nav__list" data-md-scrollfix>
  510. <li class="md-nav__item">
  511. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  512. FluxCD
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  517. Anchore Engine
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  522. Jenkins
  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_7" type="checkbox" id="__nav_7" >
  530. <label class="md-nav__link" for="__nav_7">
  531. References
  532. <span class="md-nav__icon md-icon"></span>
  533. </label>
  534. <nav class="md-nav" aria-label="References" data-md-level="1">
  535. <label class="md-nav__title" for="__nav_7">
  536. <span class="md-nav__icon md-icon"></span>
  537. References
  538. </label>
  539. <ul class="md-nav__list" data-md-scrollfix>
  540. <li class="md-nav__item">
  541. <a href="../spec/" class="md-nav__link">
  542. API specification
  543. </a>
  544. </li>
  545. </ul>
  546. </nav>
  547. </li>
  548. <li class="md-nav__item md-nav__item--nested">
  549. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  550. <label class="md-nav__link" for="__nav_8">
  551. Contributing
  552. <span class="md-nav__icon md-icon"></span>
  553. </label>
  554. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  555. <label class="md-nav__title" for="__nav_8">
  556. <span class="md-nav__icon md-icon"></span>
  557. Contributing
  558. </label>
  559. <ul class="md-nav__list" data-md-scrollfix>
  560. <li class="md-nav__item">
  561. <a href="../contributing-devguide/" class="md-nav__link">
  562. Developer guide
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="../contributing-process/" class="md-nav__link">
  567. Contributing Process
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="../contributing-coc/" class="md-nav__link">
  572. Code of Conduct
  573. </a>
  574. </li>
  575. </ul>
  576. </nav>
  577. </li>
  578. <li class="md-nav__item">
  579. <a href="../deprecation-policy/" class="md-nav__link">
  580. Deprecation Policy
  581. </a>
  582. </li>
  583. </ul>
  584. </nav>
  585. </div>
  586. </div>
  587. </div>
  588. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  589. <div class="md-sidebar__scrollwrap">
  590. <div class="md-sidebar__inner">
  591. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  592. <label class="md-nav__title" for="__toc">
  593. <span class="md-nav__icon md-icon"></span>
  594. Table of contents
  595. </label>
  596. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  597. <li class="md-nav__item">
  598. <a href="#google-cloud-secret-manager" class="md-nav__link">
  599. Google Cloud Secret Manager
  600. </a>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="#authentication" class="md-nav__link">
  604. Authentication
  605. </a>
  606. <nav class="md-nav" aria-label="Authentication">
  607. <ul class="md-nav__list">
  608. <li class="md-nav__item">
  609. <a href="#workload-identity" class="md-nav__link">
  610. Workload Identity
  611. </a>
  612. <nav class="md-nav" aria-label="Workload Identity">
  613. <ul class="md-nav__list">
  614. <li class="md-nav__item">
  615. <a href="#creating-workload-identity-service-accounts" class="md-nav__link">
  616. Creating Workload Identity Service Accounts
  617. </a>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="#using-service-accounts-directly" class="md-nav__link">
  621. Using Service Accounts directly
  622. </a>
  623. </li>
  624. <li class="md-nav__item">
  625. <a href="#using-pod-based-workload-identity" class="md-nav__link">
  626. Using Pod-based Workload Identity
  627. </a>
  628. </li>
  629. </ul>
  630. </nav>
  631. </li>
  632. <li class="md-nav__item">
  633. <a href="#gcp-service-account-authentication" class="md-nav__link">
  634. GCP Service Account authentication
  635. </a>
  636. <nav class="md-nav" aria-label="GCP Service Account authentication">
  637. <ul class="md-nav__list">
  638. <li class="md-nav__item">
  639. <a href="#update-secret-store" class="md-nav__link">
  640. Update secret store
  641. </a>
  642. </li>
  643. <li class="md-nav__item">
  644. <a href="#creating-external-secret" class="md-nav__link">
  645. Creating external secret
  646. </a>
  647. </li>
  648. </ul>
  649. </nav>
  650. </li>
  651. </ul>
  652. </nav>
  653. </li>
  654. </ul>
  655. </nav>
  656. </div>
  657. </div>
  658. </div>
  659. <div class="md-content" data-md-component="content">
  660. <article class="md-content__inner md-typeset">
  661. <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">
  662. <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>
  663. </a>
  664. <h1>Secret Manager</h1>
  665. <h2 id="google-cloud-secret-manager">Google Cloud Secret Manager</h2>
  666. <p>External Secrets Operator integrates with <a href="https://cloud.google.com/secret-manager">GCP Secret Manager</a> for secret management.</p>
  667. <h2 id="authentication">Authentication</h2>
  668. <h3 id="workload-identity">Workload Identity</h3>
  669. <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>
  670. <h4 id="creating-workload-identity-service-accounts">Creating Workload Identity Service Accounts</h4>
  671. <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>
  672. <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>
  673. <ul>
  674. <li><code>CLUSTER_NAME</code>: The name of your cluster</li>
  675. <li><code>PROJECT_ID</code>: Your project ID (not your Project number nor your Project name)</li>
  676. <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>
  677. <li><code>KSA_NAME</code>: external-secrets (if you are not creating a new one to attach to the deployemnt)</li>
  678. <li><code>GSA_NAME</code>: external-secrets for simplicity, or something else if you have to follow different naming convetions for cloud resources</li>
  679. <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>
  680. </ul>
  681. <h4 id="using-service-accounts-directly">Using Service Accounts directly</h4>
  682. <p>Let's assume you have created a service account correctly and attached a appropriate workload identity. It should roughly look like this:</p>
  683. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span><span class="w"></span>
  684. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span><span class="w"></span>
  685. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  686. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">team-a</span><span class="w"></span>
  687. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">team-a</span><span class="w"></span>
  688. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"></span>
  689. <span class="w"> </span><span class="nt">iam.gke.io/gcp-service-account</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example-team-a@my-project.iam.gserviceaccount.com</span><span class="w"></span>
  690. </code></pre></div>
  691. <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>
  692. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span><span class="w"></span>
  693. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span><span class="w"></span>
  694. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  695. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span><span class="w"></span>
  696. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  697. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  698. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span><span class="w"></span>
  699. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-project</span><span class="w"></span>
  700. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  701. <span class="w"> </span><span class="nt">workloadIdentity</span><span class="p">:</span><span class="w"></span>
  702. <span class="w"> </span><span class="c1"># name of the cluster region</span><span class="w"></span>
  703. <span class="w"> </span><span class="nt">clusterLocation</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">europe-central2</span><span class="w"></span>
  704. <span class="w"> </span><span class="c1"># name of the GKE cluster</span><span class="w"></span>
  705. <span class="w"> </span><span class="nt">clusterName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example-workload-identity</span><span class="w"></span>
  706. <span class="w"> </span><span class="c1"># reference the sa from above</span><span class="w"></span>
  707. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span><span class="w"></span>
  708. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">team-a</span><span class="w"></span>
  709. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">team-a</span><span class="w"></span>
  710. </code></pre></div>
  711. <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>
  712. <h4 id="using-pod-based-workload-identity">Using Pod-based Workload Identity</h4>
  713. <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>
  714. <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>
  715. <div class="highlight"><pre><span></span><code>helm install external-secrets external-secrets/external-secrets --namespace es
  716. </code></pre></div>
  717. <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>
  718. <div class="highlight"><pre><span></span><code><span class="c1"># ...</span><span class="w"></span>
  719. <span class="w"> </span><span class="nt">containers</span><span class="p">:</span><span class="w"></span>
  720. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ghcr.io/external-secrets/external-secrets:vVERSION</span><span class="w"></span>
  721. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"></span>
  722. <span class="w"> </span><span class="nt">ports</span><span class="p">:</span><span class="w"></span>
  723. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containerPort</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8080</span><span class="w"></span>
  724. <span class="w"> </span><span class="nt">protocol</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TCP</span><span class="w"></span>
  725. <span class="w"> </span><span class="nt">restartPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Always</span><span class="w"></span>
  726. <span class="w"> </span><span class="nt">schedulerName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default-scheduler</span><span class="w"></span>
  727. <span class="w"> </span><span class="nt">serviceAccount</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"></span>
  728. <span class="w"> </span><span class="nt">serviceAccountName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"> </span><span class="c1"># &lt;--- here</span><span class="w"></span>
  729. </code></pre></div>
  730. <p>The pod now has the identity. Now you need to configure the <code>SecretStore</code>.
  731. You just need to set the <code>projectID</code>, all other fields can be omitted.</p>
  732. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span><span class="w"></span>
  733. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  734. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  735. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span><span class="w"></span>
  736. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  737. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  738. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span><span class="w"></span>
  739. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pid</span><span class="w"></span>
  740. </code></pre></div>
  741. <h3 id="gcp-service-account-authentication">GCP Service Account authentication</h3>
  742. <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>
  743. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span><span class="w"></span>
  744. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span><span class="w"></span>
  745. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  746. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gcpsm-secret</span><span class="w"></span>
  747. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"></span>
  748. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gcpsm</span><span class="w"></span>
  749. <span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Opaque</span><span class="w"></span>
  750. <span class="nt">stringData</span><span class="p">:</span><span class="w"></span>
  751. <span class="w"> </span><span class="nt">secret-access-credentials</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|-</span><span class="w"></span>
  752. <span class="w"> </span><span class="no">{</span><span class="w"></span>
  753. <span class="w"> </span><span class="no">&quot;type&quot;: &quot;service_account&quot;,</span><span class="w"></span>
  754. <span class="w"> </span><span class="no">&quot;project_id&quot;: &quot;external-secrets-operator&quot;,</span><span class="w"></span>
  755. <span class="w"> </span><span class="no">&quot;private_key_id&quot;: &quot;&quot;,</span><span class="w"></span>
  756. <span class="w"> </span><span class="no">&quot;private_key&quot;: &quot;-----BEGIN PRIVATE KEY-----\nA key\n-----END PRIVATE KEY-----\n&quot;,</span><span class="w"></span>
  757. <span class="w"> </span><span class="no">&quot;client_email&quot;: &quot;test-service-account@external-secrets-operator.iam.gserviceaccount.com&quot;,</span><span class="w"></span>
  758. <span class="w"> </span><span class="no">&quot;client_id&quot;: &quot;client ID&quot;,</span><span class="w"></span>
  759. <span class="w"> </span><span class="no">&quot;auth_uri&quot;: &quot;https://accounts.google.com/o/oauth2/auth&quot;,</span><span class="w"></span>
  760. <span class="w"> </span><span class="no">&quot;token_uri&quot;: &quot;https://oauth2.googleapis.com/token&quot;,</span><span class="w"></span>
  761. <span class="w"> </span><span class="no">&quot;auth_provider_x509_cert_url&quot;: &quot;https://www.googleapis.com/oauth2/v1/certs&quot;,</span><span class="w"></span>
  762. <span class="w"> </span><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><span class="w"></span>
  763. <span class="w"> </span><span class="no">}</span><span class="w"></span>
  764. </code></pre></div>
  765. <h4 id="update-secret-store">Update secret store</h4>
  766. <p>Be sure the <code>gcpsm</code> provider is listed in the <code>Kind=SecretStore</code></p>
  767. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span><span class="w"></span>
  768. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  769. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  770. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span><span class="w"></span>
  771. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  772. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  773. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span><span class="w"> </span><span class="c1"># gcpsm provider</span><span class="w"></span>
  774. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  775. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  776. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  777. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gcpsm-secret</span><span class="w"> </span><span class="c1"># secret name containing SA key</span><span class="w"></span>
  778. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-access-credentials</span><span class="w"> </span><span class="c1"># key name containing SA key</span><span class="w"></span>
  779. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myproject</span><span class="w"> </span><span class="c1"># name of Google Cloud project</span><span class="w"></span>
  780. </code></pre></div>
  781. <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>
  782. <h4 id="creating-external-secret">Creating external secret</h4>
  783. <p>To create a kubernetes secret from the GCP Secret Manager secret a <code>Kind=ExternalSecret</code> is needed.</p>
  784. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span><span class="w"></span>
  785. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  786. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  787. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span><span class="w"></span>
  788. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  789. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"> </span><span class="c1"># rate SecretManager pulls GCPSM</span><span class="w"></span>
  790. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  791. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  792. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span><span class="w"> </span><span class="c1"># name of the SecretStore (or kind specified)</span><span class="w"></span>
  793. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  794. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-to-be-created</span><span class="w"> </span><span class="c1"># name of the k8s Secret to be created</span><span class="w"></span>
  795. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Owner</span><span class="w"></span>
  796. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  797. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dev-secret-test</span><span class="w"> </span><span class="c1"># name of the GCPSM secret key</span><span class="w"></span>
  798. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  799. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dev-secret-test</span><span class="w"></span>
  800. </code></pre></div>
  801. <p>The operator will fetch the GCP Secret Manager secret and inject it as a <code>Kind=Secret</code>
  802. <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
  803. </code></pre></div></p>
  804. </article>
  805. </div>
  806. </div>
  807. </main>
  808. <footer class="md-footer">
  809. <nav class="md-footer__inner md-grid" aria-label="Footer">
  810. <a href="../provider-azure-key-vault/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Key Vault" rel="prev">
  811. <div class="md-footer__button md-icon">
  812. <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>
  813. </div>
  814. <div class="md-footer__title">
  815. <div class="md-ellipsis">
  816. <span class="md-footer__direction">
  817. Previous
  818. </span>
  819. Key Vault
  820. </div>
  821. </div>
  822. </a>
  823. <a href="../provider-ibm-secrets-manager/" class="md-footer__link md-footer__link--next" aria-label="Next: Secrets Manager" rel="next">
  824. <div class="md-footer__title">
  825. <div class="md-ellipsis">
  826. <span class="md-footer__direction">
  827. Next
  828. </span>
  829. Secrets Manager
  830. </div>
  831. </div>
  832. <div class="md-footer__button md-icon">
  833. <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>
  834. </div>
  835. </a>
  836. </nav>
  837. <div class="md-footer-meta md-typeset">
  838. <div class="md-footer-meta__inner md-grid">
  839. <div class="md-copyright">
  840. Made with
  841. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  842. Material for MkDocs
  843. </a>
  844. </div>
  845. </div>
  846. </div>
  847. </footer>
  848. </div>
  849. <div class="md-dialog" data-md-component="dialog">
  850. <div class="md-dialog__inner md-typeset"></div>
  851. </div>
  852. <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.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  853. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  854. </body>
  855. </html>