index.html 40 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="icon" href="../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.1, mkdocs-material-7.1.8">
  8. <title>Key Vault - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.ca7ac06f.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.f1a3b89f.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
  14. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){"undefined"!=typeof location$&&location$.subscribe(function(t){gtag("config","G-QP38TD8K7V",{page_path:t.pathname})})})</script>
  15. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  16. </head>
  17. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  18. <script>function __prefix(e){return new URL("..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#azure-key-vault" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <header class="md-header" data-md-component="header">
  30. <nav class="md-header__inner md-grid" aria-label="Header">
  31. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  32. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  33. </a>
  34. <label class="md-header__button md-icon" for="__drawer">
  35. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  36. </label>
  37. <div class="md-header__title" data-md-component="header-title">
  38. <div class="md-header__ellipsis">
  39. <div class="md-header__topic">
  40. <span class="md-ellipsis">
  41. External Secrets Operator
  42. </span>
  43. </div>
  44. <div class="md-header__topic" data-md-component="header-topic">
  45. <span class="md-ellipsis">
  46. Key Vault
  47. </span>
  48. </div>
  49. </div>
  50. </div>
  51. <label class="md-header__button md-icon" for="__search">
  52. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  53. </label>
  54. <div class="md-search" data-md-component="search" role="dialog">
  55. <label class="md-search__overlay" for="__search"></label>
  56. <div class="md-search__inner" role="search">
  57. <form class="md-search__form" name="search">
  58. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
  59. <label class="md-search__icon md-icon" for="__search">
  60. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  61. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  62. </label>
  63. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  64. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  65. </button>
  66. </form>
  67. <div class="md-search__output">
  68. <div class="md-search__scrollwrap" data-md-scrollfix>
  69. <div class="md-search-result" data-md-component="search-result">
  70. <div class="md-search-result__meta">
  71. Initializing search
  72. </div>
  73. <ol class="md-search-result__list"></ol>
  74. </div>
  75. </div>
  76. </div>
  77. </div>
  78. </div>
  79. <div class="md-header__source">
  80. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  81. <div class="md-source__icon md-icon">
  82. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  83. </div>
  84. <div class="md-source__repository">
  85. External Secrets Operator
  86. </div>
  87. </a>
  88. </div>
  89. </nav>
  90. </header>
  91. <div class="md-container" data-md-component="container">
  92. <main class="md-main" data-md-component="main">
  93. <div class="md-main__inner md-grid">
  94. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  95. <div class="md-sidebar__scrollwrap">
  96. <div class="md-sidebar__inner">
  97. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  98. <label class="md-nav__title" for="__drawer">
  99. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  100. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  101. </a>
  102. External Secrets Operator
  103. </label>
  104. <div class="md-nav__source">
  105. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  106. <div class="md-source__icon md-icon">
  107. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  108. </div>
  109. <div class="md-source__repository">
  110. External Secrets Operator
  111. </div>
  112. </a>
  113. </div>
  114. <ul class="md-nav__list" data-md-scrollfix>
  115. <li class="md-nav__item">
  116. <a href=".." class="md-nav__link">
  117. Introduction
  118. </a>
  119. </li>
  120. <li class="md-nav__item">
  121. <a href="../api-overview/" class="md-nav__link">
  122. Overview
  123. </a>
  124. </li>
  125. <li class="md-nav__item md-nav__item--nested">
  126. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  127. <label class="md-nav__link" for="__nav_3">
  128. API Types
  129. <span class="md-nav__icon md-icon"></span>
  130. </label>
  131. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  132. <label class="md-nav__title" for="__nav_3">
  133. <span class="md-nav__icon md-icon"></span>
  134. API Types
  135. </label>
  136. <ul class="md-nav__list" data-md-scrollfix>
  137. <li class="md-nav__item">
  138. <a href="../api-externalsecret/" class="md-nav__link">
  139. ExternalSecret
  140. </a>
  141. </li>
  142. <li class="md-nav__item">
  143. <a href="../api-secretstore/" class="md-nav__link">
  144. SecretStore
  145. </a>
  146. </li>
  147. <li class="md-nav__item">
  148. <a href="../api-clustersecretstore/" class="md-nav__link">
  149. ClusterSecretStore
  150. </a>
  151. </li>
  152. </ul>
  153. </nav>
  154. </li>
  155. <li class="md-nav__item md-nav__item--nested">
  156. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  157. <label class="md-nav__link" for="__nav_4">
  158. Guides
  159. <span class="md-nav__icon md-icon"></span>
  160. </label>
  161. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  162. <label class="md-nav__title" for="__nav_4">
  163. <span class="md-nav__icon md-icon"></span>
  164. Guides
  165. </label>
  166. <ul class="md-nav__list" data-md-scrollfix>
  167. <li class="md-nav__item">
  168. <a href="../guides-introduction/" class="md-nav__link">
  169. Introduction
  170. </a>
  171. </li>
  172. <li class="md-nav__item">
  173. <a href="../guides-getting-started/" class="md-nav__link">
  174. Getting started
  175. </a>
  176. </li>
  177. <li class="md-nav__item">
  178. <a href="../guides-templating/" class="md-nav__link">
  179. Advanced Templating
  180. </a>
  181. </li>
  182. <li class="md-nav__item">
  183. <a href="../guides-controller-class/" class="md-nav__link">
  184. Controller Classes
  185. </a>
  186. </li>
  187. <li class="md-nav__item">
  188. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  189. All keys, One secret
  190. </a>
  191. </li>
  192. <li class="md-nav__item">
  193. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  194. Common K8S Secret Types
  195. </a>
  196. </li>
  197. <li class="md-nav__item">
  198. <a href="../guides-multi-tenancy/" class="md-nav__link">
  199. Multi Tenancy
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../guides-metrics/" class="md-nav__link">
  204. Metrics
  205. </a>
  206. </li>
  207. <li class="md-nav__item">
  208. <a href="../guides-using-latest-image/" class="md-nav__link">
  209. Using Latest Image
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../guides-gitops-using-fluxcd/" class="md-nav__link">
  214. GitOps using FluxCD
  215. </a>
  216. </li>
  217. </ul>
  218. </nav>
  219. </li>
  220. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  221. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  222. <label class="md-nav__link" for="__nav_5">
  223. Provider
  224. <span class="md-nav__icon md-icon"></span>
  225. </label>
  226. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  227. <label class="md-nav__title" for="__nav_5">
  228. <span class="md-nav__icon md-icon"></span>
  229. Provider
  230. </label>
  231. <ul class="md-nav__list" data-md-scrollfix>
  232. <li class="md-nav__item md-nav__item--nested">
  233. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  234. <label class="md-nav__link" for="__nav_5_1">
  235. AWS
  236. <span class="md-nav__icon md-icon"></span>
  237. </label>
  238. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  239. <label class="md-nav__title" for="__nav_5_1">
  240. <span class="md-nav__icon md-icon"></span>
  241. AWS
  242. </label>
  243. <ul class="md-nav__list" data-md-scrollfix>
  244. <li class="md-nav__item">
  245. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  246. Secrets Manager
  247. </a>
  248. </li>
  249. <li class="md-nav__item">
  250. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  251. Parameter Store
  252. </a>
  253. </li>
  254. </ul>
  255. </nav>
  256. </li>
  257. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  258. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
  259. <label class="md-nav__link" for="__nav_5_2">
  260. Azure
  261. <span class="md-nav__icon md-icon"></span>
  262. </label>
  263. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  264. <label class="md-nav__title" for="__nav_5_2">
  265. <span class="md-nav__icon md-icon"></span>
  266. Azure
  267. </label>
  268. <ul class="md-nav__list" data-md-scrollfix>
  269. <li class="md-nav__item md-nav__item--active">
  270. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  271. <label class="md-nav__link md-nav__link--active" for="__toc">
  272. Key Vault
  273. <span class="md-nav__icon md-icon"></span>
  274. </label>
  275. <a href="./" class="md-nav__link md-nav__link--active">
  276. Key Vault
  277. </a>
  278. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  279. <label class="md-nav__title" for="__toc">
  280. <span class="md-nav__icon md-icon"></span>
  281. Table of contents
  282. </label>
  283. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  284. <li class="md-nav__item">
  285. <a href="#azure-key-vault" class="md-nav__link">
  286. Azure Key vault
  287. </a>
  288. <nav class="md-nav" aria-label="Azure Key vault">
  289. <ul class="md-nav__list">
  290. <li class="md-nav__item">
  291. <a href="#authentication" class="md-nav__link">
  292. Authentication
  293. </a>
  294. <nav class="md-nav" aria-label="Authentication">
  295. <ul class="md-nav__list">
  296. <li class="md-nav__item">
  297. <a href="#service-principal-key-authentication" class="md-nav__link">
  298. Service Principal key authentication
  299. </a>
  300. </li>
  301. <li class="md-nav__item">
  302. <a href="#managed-identity-authentication" class="md-nav__link">
  303. Managed Identity authentication
  304. </a>
  305. </li>
  306. </ul>
  307. </nav>
  308. </li>
  309. <li class="md-nav__item">
  310. <a href="#update-secret-store" class="md-nav__link">
  311. Update secret store
  312. </a>
  313. </li>
  314. <li class="md-nav__item">
  315. <a href="#object-types" class="md-nav__link">
  316. Object Types
  317. </a>
  318. </li>
  319. <li class="md-nav__item">
  320. <a href="#creating-external-secret" class="md-nav__link">
  321. Creating external secret
  322. </a>
  323. </li>
  324. </ul>
  325. </nav>
  326. </li>
  327. </ul>
  328. </nav>
  329. </li>
  330. </ul>
  331. </nav>
  332. </li>
  333. <li class="md-nav__item md-nav__item--nested">
  334. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  335. <label class="md-nav__link" for="__nav_5_3">
  336. Google
  337. <span class="md-nav__icon md-icon"></span>
  338. </label>
  339. <nav class="md-nav" aria-label="Google" data-md-level="2">
  340. <label class="md-nav__title" for="__nav_5_3">
  341. <span class="md-nav__icon md-icon"></span>
  342. Google
  343. </label>
  344. <ul class="md-nav__list" data-md-scrollfix>
  345. <li class="md-nav__item">
  346. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  347. Secrets Manager
  348. </a>
  349. </li>
  350. </ul>
  351. </nav>
  352. </li>
  353. <li class="md-nav__item md-nav__item--nested">
  354. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  355. <label class="md-nav__link" for="__nav_5_4">
  356. IBM
  357. <span class="md-nav__icon md-icon"></span>
  358. </label>
  359. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  360. <label class="md-nav__title" for="__nav_5_4">
  361. <span class="md-nav__icon md-icon"></span>
  362. IBM
  363. </label>
  364. <ul class="md-nav__list" data-md-scrollfix>
  365. <li class="md-nav__item">
  366. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  367. Secrets Manager
  368. </a>
  369. </li>
  370. </ul>
  371. </nav>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../provider-akeyless/" class="md-nav__link">
  375. Akeyless
  376. </a>
  377. </li>
  378. <li class="md-nav__item">
  379. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  380. HashiCorp Vault
  381. </a>
  382. </li>
  383. <li class="md-nav__item md-nav__item--nested">
  384. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  385. <label class="md-nav__link" for="__nav_5_7">
  386. Yandex
  387. <span class="md-nav__icon md-icon"></span>
  388. </label>
  389. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  390. <label class="md-nav__title" for="__nav_5_7">
  391. <span class="md-nav__icon md-icon"></span>
  392. Yandex
  393. </label>
  394. <ul class="md-nav__list" data-md-scrollfix>
  395. <li class="md-nav__item">
  396. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  397. Lockbox
  398. </a>
  399. </li>
  400. </ul>
  401. </nav>
  402. </li>
  403. <li class="md-nav__item md-nav__item--nested">
  404. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  405. <label class="md-nav__link" for="__nav_5_8">
  406. Gitlab
  407. <span class="md-nav__icon md-icon"></span>
  408. </label>
  409. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  410. <label class="md-nav__title" for="__nav_5_8">
  411. <span class="md-nav__icon md-icon"></span>
  412. Gitlab
  413. </label>
  414. <ul class="md-nav__list" data-md-scrollfix>
  415. <li class="md-nav__item">
  416. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  417. Gitlab Project Variables
  418. </a>
  419. </li>
  420. </ul>
  421. </nav>
  422. </li>
  423. <li class="md-nav__item md-nav__item--nested">
  424. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  425. <label class="md-nav__link" for="__nav_5_9">
  426. Oracle
  427. <span class="md-nav__icon md-icon"></span>
  428. </label>
  429. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  430. <label class="md-nav__title" for="__nav_5_9">
  431. <span class="md-nav__icon md-icon"></span>
  432. Oracle
  433. </label>
  434. <ul class="md-nav__list" data-md-scrollfix>
  435. <li class="md-nav__item">
  436. <a href="../provider-oracle-vault/" class="md-nav__link">
  437. Oracle Vault
  438. </a>
  439. </li>
  440. </ul>
  441. </nav>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../provider-webhook/" class="md-nav__link">
  445. Webhook
  446. </a>
  447. </li>
  448. </ul>
  449. </nav>
  450. </li>
  451. <li class="md-nav__item md-nav__item--nested">
  452. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  453. <label class="md-nav__link" for="__nav_6">
  454. References
  455. <span class="md-nav__icon md-icon"></span>
  456. </label>
  457. <nav class="md-nav" aria-label="References" data-md-level="1">
  458. <label class="md-nav__title" for="__nav_6">
  459. <span class="md-nav__icon md-icon"></span>
  460. References
  461. </label>
  462. <ul class="md-nav__list" data-md-scrollfix>
  463. <li class="md-nav__item">
  464. <a href="../spec/" class="md-nav__link">
  465. API specification
  466. </a>
  467. </li>
  468. </ul>
  469. </nav>
  470. </li>
  471. <li class="md-nav__item md-nav__item--nested">
  472. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  473. <label class="md-nav__link" for="__nav_7">
  474. Contributing
  475. <span class="md-nav__icon md-icon"></span>
  476. </label>
  477. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  478. <label class="md-nav__title" for="__nav_7">
  479. <span class="md-nav__icon md-icon"></span>
  480. Contributing
  481. </label>
  482. <ul class="md-nav__list" data-md-scrollfix>
  483. <li class="md-nav__item">
  484. <a href="../contributing-devguide/" class="md-nav__link">
  485. Developer guide
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="../contributing-process/" class="md-nav__link">
  490. Contributing Process
  491. </a>
  492. </li>
  493. <li class="md-nav__item">
  494. <a href="../contributing-coc/" class="md-nav__link">
  495. Code of Conduct
  496. </a>
  497. </li>
  498. </ul>
  499. </nav>
  500. </li>
  501. <li class="md-nav__item">
  502. <a href="../deprecation-policy/" class="md-nav__link">
  503. Deprecation Policy
  504. </a>
  505. </li>
  506. </ul>
  507. </nav>
  508. </div>
  509. </div>
  510. </div>
  511. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  512. <div class="md-sidebar__scrollwrap">
  513. <div class="md-sidebar__inner">
  514. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  515. <label class="md-nav__title" for="__toc">
  516. <span class="md-nav__icon md-icon"></span>
  517. Table of contents
  518. </label>
  519. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  520. <li class="md-nav__item">
  521. <a href="#azure-key-vault" class="md-nav__link">
  522. Azure Key vault
  523. </a>
  524. <nav class="md-nav" aria-label="Azure Key vault">
  525. <ul class="md-nav__list">
  526. <li class="md-nav__item">
  527. <a href="#authentication" class="md-nav__link">
  528. Authentication
  529. </a>
  530. <nav class="md-nav" aria-label="Authentication">
  531. <ul class="md-nav__list">
  532. <li class="md-nav__item">
  533. <a href="#service-principal-key-authentication" class="md-nav__link">
  534. Service Principal key authentication
  535. </a>
  536. </li>
  537. <li class="md-nav__item">
  538. <a href="#managed-identity-authentication" class="md-nav__link">
  539. Managed Identity authentication
  540. </a>
  541. </li>
  542. </ul>
  543. </nav>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="#update-secret-store" class="md-nav__link">
  547. Update secret store
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="#object-types" class="md-nav__link">
  552. Object Types
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="#creating-external-secret" class="md-nav__link">
  557. Creating external secret
  558. </a>
  559. </li>
  560. </ul>
  561. </nav>
  562. </li>
  563. </ul>
  564. </nav>
  565. </div>
  566. </div>
  567. </div>
  568. <div class="md-content" data-md-component="content">
  569. <article class="md-content__inner md-typeset">
  570. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/provider-azure-key-vault.md" title="Edit this page" class="md-content__button md-icon">
  571. <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>
  572. </a>
  573. <h1>Key Vault</h1>
  574. <p><img alt="aws sm" src="../pictures/eso-az-kv-azure-kv.png" /></p>
  575. <h2 id="azure-key-vault">Azure Key vault</h2>
  576. <p>External Secrets Operator integrates with <a href="https://azure.microsoft.com/en-us/services/key-vault/">Azure Key vault</a> for secrets, certificates and Keys management.</p>
  577. <h3 id="authentication">Authentication</h3>
  578. <p>We support Service Principals and Managed Identity <a href="https://docs.microsoft.com/en-us/azure/key-vault/general/authentication">authentication</a>.</p>
  579. <p>To use Managed Identity authentication, you should use <a href="https://azure.github.io/aad-pod-identity/docs/">aad-pod-identity</a> to assign the identity to external-secrets operator. To add the selector to external-secrets operator, use <code>podLabels</code> in your values.yaml in case of Helm installation of external-secrets.</p>
  580. <h4 id="service-principal-key-authentication">Service Principal key authentication</h4>
  581. <p>A service Principal client and Secret is created and the JSON keyfile is stored in a <code>Kind=Secret</code>. The <code>ClientID</code> and <code>ClientSecret</code> should be configured for the secret. This service principal should have proper access rights to the keyvault to be managed by the operator</p>
  582. <h4 id="managed-identity-authentication">Managed Identity authentication</h4>
  583. <p>A Managed Identity should be created in Azure, and that Identity should have proper rights to the keyvault to be managed by the operator.</p>
  584. <p>If there are multiple Managed Identitites for different keyvaults, the operator should have been assigned all identities via <a href="https://azure.github.io/aad-pod-identity/docs/">aad-pod-identity</a>, then the SecretStore configuration should include the Id of the idenetity to be used via the <code>identityId</code> field.</p>
  585. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">v1</span>
  586. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Secret</span>
  587. <span class="nt">metadata</span><span class="p">:</span>
  588. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">azure-secret-sp</span>
  589. <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Opaque</span>
  590. <span class="nt">data</span><span class="p">:</span>
  591. <span class="nt">ClientID</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">bXktc2VydmljZS1wcmluY2lwbGUtY2xpZW50LWlkCg==</span> <span class="c1">#service-principal-ID</span>
  592. <span class="nt">ClientSecret</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">bXktc2VydmljZS1wcmluY2lwbGUtY2xpZW50LXNlY3JldAo=</span> <span class="c1">#service-principal-secret</span>
  593. </code></pre></div>
  594. <h3 id="update-secret-store">Update secret store</h3>
  595. <p>Be sure the <code>azurekv</code> provider is listed in the <code>Kind=SecretStore</code></p>
  596. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  597. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  598. <span class="nt">metadata</span><span class="p">:</span>
  599. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-secret-store</span>
  600. <span class="nt">spec</span><span class="p">:</span>
  601. <span class="nt">provider</span><span class="p">:</span>
  602. <span class="c1"># provider type: azure keyvault</span>
  603. <span class="nt">azurekv</span><span class="p">:</span>
  604. <span class="c1"># azure tenant ID, see: https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-how-to-find-tenant</span>
  605. <span class="nt">tenantId</span><span class="p">:</span> <span class="s">&quot;d3bc2180-xxxx-xxxx-xxxx-154105743342&quot;</span>
  606. <span class="c1"># URL of your vault instance, see: https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates</span>
  607. <span class="nt">vaultUrl</span><span class="p">:</span> <span class="s">&quot;https://my-keyvault-name.vault.azure.net&quot;</span>
  608. <span class="nt">authSecretRef</span><span class="p">:</span>
  609. <span class="c1"># points to the secret that contains</span>
  610. <span class="c1"># the azure service principal credentials</span>
  611. <span class="nt">clientId</span><span class="p">:</span>
  612. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">azure-secret-sp</span>
  613. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ClientID</span>
  614. <span class="nt">clientSecret</span><span class="p">:</span>
  615. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">azure-secret-sp</span>
  616. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ClientSecret</span>
  617. </code></pre></div>
  618. <p>Or in case of Managed Idenetity authentication:</p>
  619. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  620. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  621. <span class="nt">metadata</span><span class="p">:</span>
  622. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-secret-store</span>
  623. <span class="nt">spec</span><span class="p">:</span>
  624. <span class="nt">provider</span><span class="p">:</span>
  625. <span class="c1"># provider type: azure keyvault</span>
  626. <span class="nt">azurekv</span><span class="p">:</span>
  627. <span class="nt">authType</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ManagedIdentity</span>
  628. <span class="c1"># Optionally set the Id of the Managed Identity, if multiple identities are assigned to external-secrets operator</span>
  629. <span class="nt">identityId</span><span class="p">:</span> <span class="s">&quot;&lt;MI_clientId&gt;&quot;</span>
  630. <span class="c1"># URL of your vault instance, see: https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates</span>
  631. <span class="nt">vaultUrl</span><span class="p">:</span> <span class="s">&quot;https://my-keyvault-name.vault.azure.net&quot;</span>
  632. </code></pre></div>
  633. <h3 id="object-types">Object Types</h3>
  634. <p>Azure KeyVault manages different <a href="https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#object-types">object types</a>, we support <code>keys</code>, <code>secrets</code> and <code>certificates</code>. Simply prefix the key with <code>key</code>, <code>secret</code> or <code>cert</code> to retrieve the desired type (defaults to secret).</p>
  635. <table>
  636. <thead>
  637. <tr>
  638. <th>Object Type</th>
  639. <th>Return Value</th>
  640. </tr>
  641. </thead>
  642. <tbody>
  643. <tr>
  644. <td><code>secret</code></td>
  645. <td>the raw secret value.</td>
  646. </tr>
  647. <tr>
  648. <td><code>key</code></td>
  649. <td>A JWK which contains the public key. Azure KeyVault does <strong>not</strong> export the private key. You may want to use <a href="../guides-templating/">template functions</a> to transform this JWK into PEM encoded PKIX ASN.1 DER format.</td>
  650. </tr>
  651. <tr>
  652. <td><code>certificate</code></td>
  653. <td>The raw CER contents of the x509 certificate. You may want to use <a href="../guides-templating/">template functions</a> to transform this into your desired encoding</td>
  654. </tr>
  655. </tbody>
  656. </table>
  657. <h3 id="creating-external-secret">Creating external secret</h3>
  658. <p>To create a kubernetes secret from the Azure Key vault secret a <code>Kind=ExternalSecret</code> is needed.</p>
  659. <p>You can manage keys/secrets/certificates saved inside the keyvault , by setting a "/" prefixed type in the secret name , the default type is a <code>secret</code>. other supported values are <code>cert</code> and <code>key</code></p>
  660. <p>to select all secrets inside the key vault , you can use the <code>dataFrom</code> directive</p>
  661. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  662. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  663. <span class="nt">metadata</span><span class="p">:</span>
  664. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-external-secret</span>
  665. <span class="nt">spec</span><span class="p">:</span>
  666. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1h</span>
  667. <span class="nt">secretStoreRef</span><span class="p">:</span>
  668. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  669. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-secret-store</span>
  670. <span class="nt">target</span><span class="p">:</span>
  671. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-to-be-created</span>
  672. <span class="nt">creationPolicy</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Owner</span>
  673. <span class="nt">data</span><span class="p">:</span>
  674. <span class="c1"># name of the SECRET in the Azure KV (no prefix is by default a SECRET)</span>
  675. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev-secret-test</span>
  676. <span class="nt">remoteRef</span><span class="p">:</span>
  677. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev-secret-test</span>
  678. <span class="c1"># explicit type and name of secret in the Azure KV</span>
  679. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev-another-secret-test</span>
  680. <span class="nt">remoteRef</span><span class="p">:</span>
  681. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret/dev-secret-test</span>
  682. <span class="c1"># type/name of certificate in the Azure KV</span>
  683. <span class="c1"># raw value will be returned, use templating features for data processing</span>
  684. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev-cert-test</span>
  685. <span class="nt">remoteRef</span><span class="p">:</span>
  686. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">cert/dev-cert-test</span>
  687. <span class="c1"># type/name of the public key in the Azure KV</span>
  688. <span class="c1"># the key is returned PEM encoded</span>
  689. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dev-key-test</span>
  690. <span class="nt">remoteRef</span><span class="p">:</span>
  691. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">key/dev-key-test</span>
  692. </code></pre></div>
  693. <p>The operator will fetch the Azure Key vault secret and inject it as a <code>Kind=Secret</code>
  694. <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
  695. </code></pre></div></p>
  696. </article>
  697. </div>
  698. </div>
  699. </main>
  700. <footer class="md-footer">
  701. <nav class="md-footer__inner md-grid" aria-label="Footer">
  702. <a href="../provider-aws-parameter-store/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Parameter Store" rel="prev">
  703. <div class="md-footer__button md-icon">
  704. <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>
  705. </div>
  706. <div class="md-footer__title">
  707. <div class="md-ellipsis">
  708. <span class="md-footer__direction">
  709. Previous
  710. </span>
  711. Parameter Store
  712. </div>
  713. </div>
  714. </a>
  715. <a href="../provider-google-secrets-manager/" class="md-footer__link md-footer__link--next" aria-label="Next: Secrets Manager" rel="next">
  716. <div class="md-footer__title">
  717. <div class="md-ellipsis">
  718. <span class="md-footer__direction">
  719. Next
  720. </span>
  721. Secrets Manager
  722. </div>
  723. </div>
  724. <div class="md-footer__button md-icon">
  725. <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>
  726. </div>
  727. </a>
  728. </nav>
  729. <div class="md-footer-meta md-typeset">
  730. <div class="md-footer-meta__inner md-grid">
  731. <div class="md-footer-copyright">
  732. Made with
  733. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  734. Material for MkDocs
  735. </a>
  736. </div>
  737. </div>
  738. </div>
  739. </footer>
  740. </div>
  741. <div class="md-dialog" data-md-component="dialog">
  742. <div class="md-dialog__inner md-typeset"></div>
  743. </div>
  744. <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.b0710199.min.js", "version": {"provider": "mike"}}</script>
  745. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  746. </body>
  747. </html>