index.html 57 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811
  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. <li class="md-nav__item">
  166. <a href="../api-clusterexternalsecret/" class="md-nav__link">
  167. ClusterExternalSecret
  168. </a>
  169. </li>
  170. </ul>
  171. </nav>
  172. </li>
  173. <li class="md-nav__item md-nav__item--nested">
  174. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  175. <label class="md-nav__link" for="__nav_4">
  176. Guides
  177. <span class="md-nav__icon md-icon"></span>
  178. </label>
  179. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  180. <label class="md-nav__title" for="__nav_4">
  181. <span class="md-nav__icon md-icon"></span>
  182. Guides
  183. </label>
  184. <ul class="md-nav__list" data-md-scrollfix>
  185. <li class="md-nav__item">
  186. <a href="../guides-introduction/" class="md-nav__link">
  187. Introduction
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-getting-started/" class="md-nav__link">
  192. Getting started
  193. </a>
  194. </li>
  195. <li class="md-nav__item md-nav__item--nested">
  196. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  197. <label class="md-nav__link" for="__nav_4_3">
  198. Advanced Templating
  199. <span class="md-nav__icon md-icon"></span>
  200. </label>
  201. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  202. <label class="md-nav__title" for="__nav_4_3">
  203. <span class="md-nav__icon md-icon"></span>
  204. Advanced Templating
  205. </label>
  206. <ul class="md-nav__list" data-md-scrollfix>
  207. <li class="md-nav__item">
  208. <a href="../guides-templating/" class="md-nav__link">
  209. v2
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../guides-templating-v1/" class="md-nav__link">
  214. v1
  215. </a>
  216. </li>
  217. </ul>
  218. </nav>
  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-controller-class/" class="md-nav__link">
  232. Controller Classes
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="../guides-ownership-deletion-policy/" class="md-nav__link">
  237. Lifecycle: ownership & deletion
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../guides-getallsecrets/" class="md-nav__link">
  242. Getting Multiple Secrets
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../guides-multi-tenancy/" class="md-nav__link">
  247. Multi Tenancy
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../guides-metrics/" class="md-nav__link">
  252. Metrics
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../guides-v1beta1/" class="md-nav__link">
  257. Upgrading to v1beta1
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="../guides-using-latest-image/" class="md-nav__link">
  262. Using Latest Image
  263. </a>
  264. </li>
  265. </ul>
  266. </nav>
  267. </li>
  268. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  269. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  270. <label class="md-nav__link" for="__nav_5">
  271. Provider
  272. <span class="md-nav__icon md-icon"></span>
  273. </label>
  274. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  275. <label class="md-nav__title" for="__nav_5">
  276. <span class="md-nav__icon md-icon"></span>
  277. Provider
  278. </label>
  279. <ul class="md-nav__list" data-md-scrollfix>
  280. <li class="md-nav__item md-nav__item--nested">
  281. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  282. <label class="md-nav__link" for="__nav_5_1">
  283. AWS
  284. <span class="md-nav__icon md-icon"></span>
  285. </label>
  286. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  287. <label class="md-nav__title" for="__nav_5_1">
  288. <span class="md-nav__icon md-icon"></span>
  289. AWS
  290. </label>
  291. <ul class="md-nav__list" data-md-scrollfix>
  292. <li class="md-nav__item">
  293. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  294. Secrets Manager
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  299. Parameter Store
  300. </a>
  301. </li>
  302. </ul>
  303. </nav>
  304. </li>
  305. <li class="md-nav__item md-nav__item--nested">
  306. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  307. <label class="md-nav__link" for="__nav_5_2">
  308. Azure
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  312. <label class="md-nav__title" for="__nav_5_2">
  313. <span class="md-nav__icon md-icon"></span>
  314. Azure
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item">
  318. <a href="../provider-azure-key-vault/" class="md-nav__link">
  319. Key Vault
  320. </a>
  321. </li>
  322. </ul>
  323. </nav>
  324. </li>
  325. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  326. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" checked>
  327. <label class="md-nav__link" for="__nav_5_3">
  328. Google
  329. <span class="md-nav__icon md-icon"></span>
  330. </label>
  331. <nav class="md-nav" aria-label="Google" data-md-level="2">
  332. <label class="md-nav__title" for="__nav_5_3">
  333. <span class="md-nav__icon md-icon"></span>
  334. Google
  335. </label>
  336. <ul class="md-nav__list" data-md-scrollfix>
  337. <li class="md-nav__item md-nav__item--active">
  338. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  339. <label class="md-nav__link md-nav__link--active" for="__toc">
  340. Secret Manager
  341. <span class="md-nav__icon md-icon"></span>
  342. </label>
  343. <a href="./" class="md-nav__link md-nav__link--active">
  344. Secret Manager
  345. </a>
  346. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  347. <label class="md-nav__title" for="__toc">
  348. <span class="md-nav__icon md-icon"></span>
  349. Table of contents
  350. </label>
  351. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  352. <li class="md-nav__item">
  353. <a href="#google-cloud-secret-manager" class="md-nav__link">
  354. Google Cloud Secret Manager
  355. </a>
  356. </li>
  357. <li class="md-nav__item">
  358. <a href="#authentication" class="md-nav__link">
  359. Authentication
  360. </a>
  361. <nav class="md-nav" aria-label="Authentication">
  362. <ul class="md-nav__list">
  363. <li class="md-nav__item">
  364. <a href="#workload-identity" class="md-nav__link">
  365. Workload Identity
  366. </a>
  367. <nav class="md-nav" aria-label="Workload Identity">
  368. <ul class="md-nav__list">
  369. <li class="md-nav__item">
  370. <a href="#creating-workload-identity-service-accounts" class="md-nav__link">
  371. Creating Workload Identity Service Accounts
  372. </a>
  373. </li>
  374. <li class="md-nav__item">
  375. <a href="#using-service-accounts-directly" class="md-nav__link">
  376. Using Service Accounts directly
  377. </a>
  378. </li>
  379. <li class="md-nav__item">
  380. <a href="#using-pod-based-workload-identity" class="md-nav__link">
  381. Using Pod-based Workload Identity
  382. </a>
  383. </li>
  384. </ul>
  385. </nav>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="#gcp-service-account-authentication" class="md-nav__link">
  389. GCP Service Account authentication
  390. </a>
  391. <nav class="md-nav" aria-label="GCP Service Account authentication">
  392. <ul class="md-nav__list">
  393. <li class="md-nav__item">
  394. <a href="#update-secret-store" class="md-nav__link">
  395. Update secret store
  396. </a>
  397. </li>
  398. <li class="md-nav__item">
  399. <a href="#creating-external-secret" class="md-nav__link">
  400. Creating external secret
  401. </a>
  402. </li>
  403. </ul>
  404. </nav>
  405. </li>
  406. </ul>
  407. </nav>
  408. </li>
  409. </ul>
  410. </nav>
  411. </li>
  412. </ul>
  413. </nav>
  414. </li>
  415. <li class="md-nav__item md-nav__item--nested">
  416. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  417. <label class="md-nav__link" for="__nav_5_4">
  418. IBM
  419. <span class="md-nav__icon md-icon"></span>
  420. </label>
  421. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  422. <label class="md-nav__title" for="__nav_5_4">
  423. <span class="md-nav__icon md-icon"></span>
  424. IBM
  425. </label>
  426. <ul class="md-nav__list" data-md-scrollfix>
  427. <li class="md-nav__item">
  428. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  429. Secrets Manager
  430. </a>
  431. </li>
  432. </ul>
  433. </nav>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="../provider-akeyless/" class="md-nav__link">
  437. Akeyless
  438. </a>
  439. </li>
  440. <li class="md-nav__item">
  441. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  442. HashiCorp Vault
  443. </a>
  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_7" type="checkbox" id="__nav_5_7" >
  447. <label class="md-nav__link" for="__nav_5_7">
  448. Yandex
  449. <span class="md-nav__icon md-icon"></span>
  450. </label>
  451. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  452. <label class="md-nav__title" for="__nav_5_7">
  453. <span class="md-nav__icon md-icon"></span>
  454. Yandex
  455. </label>
  456. <ul class="md-nav__list" data-md-scrollfix>
  457. <li class="md-nav__item">
  458. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  459. Lockbox
  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_8" type="checkbox" id="__nav_5_8" >
  467. <label class="md-nav__link" for="__nav_5_8">
  468. Gitlab
  469. <span class="md-nav__icon md-icon"></span>
  470. </label>
  471. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  472. <label class="md-nav__title" for="__nav_5_8">
  473. <span class="md-nav__icon md-icon"></span>
  474. Gitlab
  475. </label>
  476. <ul class="md-nav__list" data-md-scrollfix>
  477. <li class="md-nav__item">
  478. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  479. Gitlab Project Variables
  480. </a>
  481. </li>
  482. </ul>
  483. </nav>
  484. </li>
  485. <li class="md-nav__item md-nav__item--nested">
  486. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  487. <label class="md-nav__link" for="__nav_5_9">
  488. Oracle
  489. <span class="md-nav__icon md-icon"></span>
  490. </label>
  491. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  492. <label class="md-nav__title" for="__nav_5_9">
  493. <span class="md-nav__icon md-icon"></span>
  494. Oracle
  495. </label>
  496. <ul class="md-nav__list" data-md-scrollfix>
  497. <li class="md-nav__item">
  498. <a href="../provider-oracle-vault/" class="md-nav__link">
  499. Oracle Vault
  500. </a>
  501. </li>
  502. </ul>
  503. </nav>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../provider-webhook/" class="md-nav__link">
  507. Webhook
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="../provider-fake/" class="md-nav__link">
  512. Fake
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../provider-kubernetes/" class="md-nav__link">
  517. Kubernetes
  518. </a>
  519. </li>
  520. </ul>
  521. </nav>
  522. </li>
  523. <li class="md-nav__item md-nav__item--nested">
  524. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  525. <label class="md-nav__link" for="__nav_6">
  526. Examples
  527. <span class="md-nav__icon md-icon"></span>
  528. </label>
  529. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  530. <label class="md-nav__title" for="__nav_6">
  531. <span class="md-nav__icon md-icon"></span>
  532. Examples
  533. </label>
  534. <ul class="md-nav__list" data-md-scrollfix>
  535. <li class="md-nav__item">
  536. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  537. FluxCD
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  542. Anchore Engine
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  547. Jenkins
  548. </a>
  549. </li>
  550. </ul>
  551. </nav>
  552. </li>
  553. <li class="md-nav__item md-nav__item--nested">
  554. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  555. <label class="md-nav__link" for="__nav_7">
  556. External Resources
  557. <span class="md-nav__icon md-icon"></span>
  558. </label>
  559. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  560. <label class="md-nav__title" for="__nav_7">
  561. <span class="md-nav__icon md-icon"></span>
  562. External Resources
  563. </label>
  564. <ul class="md-nav__list" data-md-scrollfix>
  565. <li class="md-nav__item">
  566. <a href="../eso-talks/" class="md-nav__link">
  567. Talks
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="../eso-demos/" class="md-nav__link">
  572. Demos
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="../eso-blogs/" class="md-nav__link">
  577. Blogs
  578. </a>
  579. </li>
  580. </ul>
  581. </nav>
  582. </li>
  583. <li class="md-nav__item md-nav__item--nested">
  584. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  585. <label class="md-nav__link" for="__nav_8">
  586. References
  587. <span class="md-nav__icon md-icon"></span>
  588. </label>
  589. <nav class="md-nav" aria-label="References" data-md-level="1">
  590. <label class="md-nav__title" for="__nav_8">
  591. <span class="md-nav__icon md-icon"></span>
  592. References
  593. </label>
  594. <ul class="md-nav__list" data-md-scrollfix>
  595. <li class="md-nav__item">
  596. <a href="../spec/" class="md-nav__link">
  597. API specification
  598. </a>
  599. </li>
  600. </ul>
  601. </nav>
  602. </li>
  603. <li class="md-nav__item md-nav__item--nested">
  604. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  605. <label class="md-nav__link" for="__nav_9">
  606. Contributing
  607. <span class="md-nav__icon md-icon"></span>
  608. </label>
  609. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  610. <label class="md-nav__title" for="__nav_9">
  611. <span class="md-nav__icon md-icon"></span>
  612. Contributing
  613. </label>
  614. <ul class="md-nav__list" data-md-scrollfix>
  615. <li class="md-nav__item">
  616. <a href="../contributing-devguide/" class="md-nav__link">
  617. Developer guide
  618. </a>
  619. </li>
  620. <li class="md-nav__item">
  621. <a href="../contributing-process/" class="md-nav__link">
  622. Contributing Process
  623. </a>
  624. </li>
  625. <li class="md-nav__item">
  626. <a href="../contributing-release/" class="md-nav__link">
  627. Release Process
  628. </a>
  629. </li>
  630. <li class="md-nav__item">
  631. <a href="../contributing-coc/" class="md-nav__link">
  632. Code of Conduct
  633. </a>
  634. </li>
  635. </ul>
  636. </nav>
  637. </li>
  638. <li class="md-nav__item">
  639. <a href="../stability-support/" class="md-nav__link">
  640. Stability and Support
  641. </a>
  642. </li>
  643. <li class="md-nav__item">
  644. <a href="../deprecation-policy/" class="md-nav__link">
  645. Deprecation Policy
  646. </a>
  647. </li>
  648. </ul>
  649. </nav>
  650. </div>
  651. </div>
  652. </div>
  653. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  654. <div class="md-sidebar__scrollwrap">
  655. <div class="md-sidebar__inner">
  656. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  657. <label class="md-nav__title" for="__toc">
  658. <span class="md-nav__icon md-icon"></span>
  659. Table of contents
  660. </label>
  661. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  662. <li class="md-nav__item">
  663. <a href="#google-cloud-secret-manager" class="md-nav__link">
  664. Google Cloud Secret Manager
  665. </a>
  666. </li>
  667. <li class="md-nav__item">
  668. <a href="#authentication" class="md-nav__link">
  669. Authentication
  670. </a>
  671. <nav class="md-nav" aria-label="Authentication">
  672. <ul class="md-nav__list">
  673. <li class="md-nav__item">
  674. <a href="#workload-identity" class="md-nav__link">
  675. Workload Identity
  676. </a>
  677. <nav class="md-nav" aria-label="Workload Identity">
  678. <ul class="md-nav__list">
  679. <li class="md-nav__item">
  680. <a href="#creating-workload-identity-service-accounts" class="md-nav__link">
  681. Creating Workload Identity Service Accounts
  682. </a>
  683. </li>
  684. <li class="md-nav__item">
  685. <a href="#using-service-accounts-directly" class="md-nav__link">
  686. Using Service Accounts directly
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="#using-pod-based-workload-identity" class="md-nav__link">
  691. Using Pod-based Workload Identity
  692. </a>
  693. </li>
  694. </ul>
  695. </nav>
  696. </li>
  697. <li class="md-nav__item">
  698. <a href="#gcp-service-account-authentication" class="md-nav__link">
  699. GCP Service Account authentication
  700. </a>
  701. <nav class="md-nav" aria-label="GCP Service Account authentication">
  702. <ul class="md-nav__list">
  703. <li class="md-nav__item">
  704. <a href="#update-secret-store" class="md-nav__link">
  705. Update secret store
  706. </a>
  707. </li>
  708. <li class="md-nav__item">
  709. <a href="#creating-external-secret" class="md-nav__link">
  710. Creating external secret
  711. </a>
  712. </li>
  713. </ul>
  714. </nav>
  715. </li>
  716. </ul>
  717. </nav>
  718. </li>
  719. </ul>
  720. </nav>
  721. </div>
  722. </div>
  723. </div>
  724. <div class="md-content" data-md-component="content">
  725. <article class="md-content__inner md-typeset">
  726. <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">
  727. <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>
  728. </a>
  729. <h1>Secret Manager</h1>
  730. <h2 id="google-cloud-secret-manager">Google Cloud Secret Manager</h2>
  731. <p>External Secrets Operator integrates with <a href="https://cloud.google.com/secret-manager">GCP Secret Manager</a> for secret management.</p>
  732. <h2 id="authentication">Authentication</h2>
  733. <h3 id="workload-identity">Workload Identity</h3>
  734. <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>
  735. <h4 id="creating-workload-identity-service-accounts">Creating Workload Identity Service Accounts</h4>
  736. <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>
  737. <p>Search <a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">the document</a> for this editable values and change them to your values:<br />
  738. <em>Note: If you have installed ESO, a serviceaccount has already been created. You can either patch the existing <code>external-secrets</code> SA or create a new one that fits your needs.</em></p>
  739. <ul>
  740. <li><code>CLUSTER_NAME</code>: The name of your cluster</li>
  741. <li><code>PROJECT_ID</code>: Your project ID (not your Project number nor your Project name)</li>
  742. <li><code>K8S_NAMESPACE</code>: For us following these steps here it will be <code>es</code>, but this will be the namespace where you deployed the external-secrets operator</li>
  743. <li><code>KSA_NAME</code>: external-secrets (if you are not creating a new one to attach to the deployment)</li>
  744. <li><code>GSA_NAME</code>: external-secrets for simplicity, or something else if you have to follow different naming convetions for cloud resources</li>
  745. <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>
  746. </ul>
  747. <h4 id="using-service-accounts-directly">Using Service Accounts directly</h4>
  748. <p>Let's assume you have created a service account correctly and attached a appropriate workload identity. It should roughly look like this:</p>
  749. <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>
  750. <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>
  751. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  752. <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>
  753. <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">es</span><span class="w"></span>
  754. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"></span>
  755. <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>
  756. </code></pre></div>
  757. <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>
  758. <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/v1beta1</span><span class="w"></span>
  759. <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>
  760. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  761. <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>
  762. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  763. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  764. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span><span class="w"></span>
  765. <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>
  766. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  767. <span class="w"> </span><span class="nt">workloadIdentity</span><span class="p">:</span><span class="w"></span>
  768. <span class="w"> </span><span class="c1"># name of the cluster region</span><span class="w"></span>
  769. <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>
  770. <span class="w"> </span><span class="c1"># name of the GKE cluster</span><span class="w"></span>
  771. <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>
  772. <span class="w"> </span><span class="c1"># projectID of the cluster (if omitted defaults to spec.provider.gcpsm.projectID)</span><span class="w"></span>
  773. <span class="w"> </span><span class="nt">clusterProjectID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-cluster-project</span><span class="w"></span>
  774. <span class="w"> </span><span class="c1"># reference the sa from above</span><span class="w"></span>
  775. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span><span class="w"></span>
  776. <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>
  777. <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>
  778. </code></pre></div>
  779. <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>
  780. <h4 id="using-pod-based-workload-identity">Using Pod-based Workload Identity</h4>
  781. <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>
  782. <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>
  783. <div class="highlight"><pre><span></span><code>helm install external-secrets external-secrets/external-secrets --namespace es
  784. </code></pre></div>
  785. <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>
  786. <div class="highlight"><pre><span></span><code><span class="c1"># ...</span><span class="w"></span>
  787. <span class="w"> </span><span class="nt">containers</span><span class="p">:</span><span class="w"></span>
  788. <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>
  789. <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>
  790. <span class="w"> </span><span class="nt">ports</span><span class="p">:</span><span class="w"></span>
  791. <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>
  792. <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>
  793. <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>
  794. <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>
  795. <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>
  796. <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>
  797. </code></pre></div>
  798. <p>The pod now has the identity. Now you need to configure the <code>SecretStore</code>.
  799. You just need to set the <code>projectID</code>, all other fields can be omitted.</p>
  800. <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/v1beta1</span><span class="w"></span>
  801. <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>
  802. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  803. <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>
  804. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  805. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  806. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span><span class="w"></span>
  807. <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>
  808. </code></pre></div>
  809. <h3 id="gcp-service-account-authentication">GCP Service Account authentication</h3>
  810. <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>
  811. <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>
  812. <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>
  813. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  814. <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>
  815. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"></span>
  816. <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>
  817. <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>
  818. <span class="nt">stringData</span><span class="p">:</span><span class="w"></span>
  819. <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>
  820. <span class="w"> </span><span class="no">{</span><span class="w"></span>
  821. <span class="w"> </span><span class="no">&quot;type&quot;: &quot;service_account&quot;,</span><span class="w"></span>
  822. <span class="w"> </span><span class="no">&quot;project_id&quot;: &quot;external-secrets-operator&quot;,</span><span class="w"></span>
  823. <span class="w"> </span><span class="no">&quot;private_key_id&quot;: &quot;&quot;,</span><span class="w"></span>
  824. <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>
  825. <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>
  826. <span class="w"> </span><span class="no">&quot;client_id&quot;: &quot;client ID&quot;,</span><span class="w"></span>
  827. <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>
  828. <span class="w"> </span><span class="no">&quot;token_uri&quot;: &quot;https://oauth2.googleapis.com/token&quot;,</span><span class="w"></span>
  829. <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>
  830. <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>
  831. <span class="w"> </span><span class="no">}</span><span class="w"></span>
  832. </code></pre></div>
  833. <h4 id="update-secret-store">Update secret store</h4>
  834. <p>Be sure the <code>gcpsm</code> provider is listed in the <code>Kind=SecretStore</code></p>
  835. <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/v1beta1</span><span class="w"></span>
  836. <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>
  837. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  838. <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>
  839. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  840. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  841. <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>
  842. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  843. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  844. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  845. <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>
  846. <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>
  847. <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>
  848. </code></pre></div>
  849. <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>
  850. <h4 id="creating-external-secret">Creating external secret</h4>
  851. <p>To create a kubernetes secret from the GCP Secret Manager secret a <code>Kind=ExternalSecret</code> is needed.</p>
  852. <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/v1beta1</span><span class="w"></span>
  853. <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>
  854. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  855. <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>
  856. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  857. <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>
  858. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  859. <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>
  860. <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>
  861. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  862. <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>
  863. <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>
  864. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  865. <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>
  866. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  867. <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>
  868. </code></pre></div>
  869. <p>The operator will fetch the GCP Secret Manager secret and inject it as a <code>Kind=Secret</code>
  870. <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
  871. </code></pre></div></p>
  872. </article>
  873. </div>
  874. </div>
  875. </main>
  876. <footer class="md-footer">
  877. <nav class="md-footer__inner md-grid" aria-label="Footer">
  878. <a href="../provider-azure-key-vault/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Key Vault" rel="prev">
  879. <div class="md-footer__button md-icon">
  880. <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>
  881. </div>
  882. <div class="md-footer__title">
  883. <div class="md-ellipsis">
  884. <span class="md-footer__direction">
  885. Previous
  886. </span>
  887. Key Vault
  888. </div>
  889. </div>
  890. </a>
  891. <a href="../provider-ibm-secrets-manager/" class="md-footer__link md-footer__link--next" aria-label="Next: Secrets Manager" rel="next">
  892. <div class="md-footer__title">
  893. <div class="md-ellipsis">
  894. <span class="md-footer__direction">
  895. Next
  896. </span>
  897. Secrets Manager
  898. </div>
  899. </div>
  900. <div class="md-footer__button md-icon">
  901. <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>
  902. </div>
  903. </a>
  904. </nav>
  905. <div class="md-footer-meta md-typeset">
  906. <div class="md-footer-meta__inner md-grid">
  907. <div class="md-copyright">
  908. Made with
  909. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  910. Material for MkDocs
  911. </a>
  912. </div>
  913. </div>
  914. </div>
  915. </footer>
  916. </div>
  917. <div class="md-dialog" data-md-component="dialog">
  918. <div class="md-dialog__inner md-typeset"></div>
  919. </div>
  920. <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>
  921. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  922. </body>
  923. </html>