index.html 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407
  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>HashiCorp 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="#hashicorp-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. HashiCorp 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-all-keys-one-secret/" class="md-nav__link">
  184. All keys, One secret
  185. </a>
  186. </li>
  187. <li class="md-nav__item">
  188. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  189. Common K8S Secret Types
  190. </a>
  191. </li>
  192. <li class="md-nav__item">
  193. <a href="../guides-multi-tenancy/" class="md-nav__link">
  194. Multi Tenancy
  195. </a>
  196. </li>
  197. <li class="md-nav__item">
  198. <a href="../guides-metrics/" class="md-nav__link">
  199. Metrics
  200. </a>
  201. </li>
  202. </ul>
  203. </nav>
  204. </li>
  205. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  206. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  207. <label class="md-nav__link" for="__nav_5">
  208. Provider
  209. <span class="md-nav__icon md-icon"></span>
  210. </label>
  211. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  212. <label class="md-nav__title" for="__nav_5">
  213. <span class="md-nav__icon md-icon"></span>
  214. Provider
  215. </label>
  216. <ul class="md-nav__list" data-md-scrollfix>
  217. <li class="md-nav__item md-nav__item--nested">
  218. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  219. <label class="md-nav__link" for="__nav_5_1">
  220. AWS
  221. <span class="md-nav__icon md-icon"></span>
  222. </label>
  223. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  224. <label class="md-nav__title" for="__nav_5_1">
  225. <span class="md-nav__icon md-icon"></span>
  226. AWS
  227. </label>
  228. <ul class="md-nav__list" data-md-scrollfix>
  229. <li class="md-nav__item">
  230. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  231. Secrets Manager
  232. </a>
  233. </li>
  234. <li class="md-nav__item">
  235. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  236. Parameter Store
  237. </a>
  238. </li>
  239. </ul>
  240. </nav>
  241. </li>
  242. <li class="md-nav__item md-nav__item--nested">
  243. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  244. <label class="md-nav__link" for="__nav_5_2">
  245. Azure
  246. <span class="md-nav__icon md-icon"></span>
  247. </label>
  248. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  249. <label class="md-nav__title" for="__nav_5_2">
  250. <span class="md-nav__icon md-icon"></span>
  251. Azure
  252. </label>
  253. <ul class="md-nav__list" data-md-scrollfix>
  254. <li class="md-nav__item">
  255. <a href="../provider-azure-key-vault/" class="md-nav__link">
  256. Key Vault
  257. </a>
  258. </li>
  259. </ul>
  260. </nav>
  261. </li>
  262. <li class="md-nav__item md-nav__item--nested">
  263. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  264. <label class="md-nav__link" for="__nav_5_3">
  265. Google
  266. <span class="md-nav__icon md-icon"></span>
  267. </label>
  268. <nav class="md-nav" aria-label="Google" data-md-level="2">
  269. <label class="md-nav__title" for="__nav_5_3">
  270. <span class="md-nav__icon md-icon"></span>
  271. Google
  272. </label>
  273. <ul class="md-nav__list" data-md-scrollfix>
  274. <li class="md-nav__item">
  275. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  276. Secrets Manager
  277. </a>
  278. </li>
  279. </ul>
  280. </nav>
  281. </li>
  282. <li class="md-nav__item md-nav__item--nested">
  283. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  284. <label class="md-nav__link" for="__nav_5_4">
  285. IBM
  286. <span class="md-nav__icon md-icon"></span>
  287. </label>
  288. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  289. <label class="md-nav__title" for="__nav_5_4">
  290. <span class="md-nav__icon md-icon"></span>
  291. IBM
  292. </label>
  293. <ul class="md-nav__list" data-md-scrollfix>
  294. <li class="md-nav__item">
  295. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  296. Secrets Manager
  297. </a>
  298. </li>
  299. </ul>
  300. </nav>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../provider-akeyless/" class="md-nav__link">
  304. Akeyless
  305. </a>
  306. </li>
  307. <li class="md-nav__item md-nav__item--active">
  308. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  309. <label class="md-nav__link md-nav__link--active" for="__toc">
  310. HashiCorp Vault
  311. <span class="md-nav__icon md-icon"></span>
  312. </label>
  313. <a href="./" class="md-nav__link md-nav__link--active">
  314. HashiCorp Vault
  315. </a>
  316. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  317. <label class="md-nav__title" for="__toc">
  318. <span class="md-nav__icon md-icon"></span>
  319. Table of contents
  320. </label>
  321. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="#hashicorp-vault" class="md-nav__link">
  324. Hashicorp Vault
  325. </a>
  326. <nav class="md-nav" aria-label="Hashicorp Vault">
  327. <ul class="md-nav__list">
  328. <li class="md-nav__item">
  329. <a href="#example" class="md-nav__link">
  330. Example
  331. </a>
  332. <nav class="md-nav" aria-label="Example">
  333. <ul class="md-nav__list">
  334. <li class="md-nav__item">
  335. <a href="#limitations" class="md-nav__link">
  336. Limitations
  337. </a>
  338. </li>
  339. </ul>
  340. </nav>
  341. </li>
  342. <li class="md-nav__item">
  343. <a href="#authentication" class="md-nav__link">
  344. Authentication
  345. </a>
  346. <nav class="md-nav" aria-label="Authentication">
  347. <ul class="md-nav__list">
  348. <li class="md-nav__item">
  349. <a href="#token-based-authentication" class="md-nav__link">
  350. Token-based authentication
  351. </a>
  352. </li>
  353. <li class="md-nav__item">
  354. <a href="#approle-authentication-example" class="md-nav__link">
  355. AppRole authentication example
  356. </a>
  357. </li>
  358. <li class="md-nav__item">
  359. <a href="#kubernetes-authentication" class="md-nav__link">
  360. Kubernetes authentication
  361. </a>
  362. </li>
  363. <li class="md-nav__item">
  364. <a href="#ldap-authentication" class="md-nav__link">
  365. LDAP authentication
  366. </a>
  367. </li>
  368. <li class="md-nav__item">
  369. <a href="#jwtoidc-authentication" class="md-nav__link">
  370. JWT/OIDC authentication
  371. </a>
  372. </li>
  373. </ul>
  374. </nav>
  375. </li>
  376. </ul>
  377. </nav>
  378. </li>
  379. </ul>
  380. </nav>
  381. </li>
  382. <li class="md-nav__item md-nav__item--nested">
  383. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  384. <label class="md-nav__link" for="__nav_5_7">
  385. Yandex
  386. <span class="md-nav__icon md-icon"></span>
  387. </label>
  388. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  389. <label class="md-nav__title" for="__nav_5_7">
  390. <span class="md-nav__icon md-icon"></span>
  391. Yandex
  392. </label>
  393. <ul class="md-nav__list" data-md-scrollfix>
  394. <li class="md-nav__item">
  395. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  396. Lockbox
  397. </a>
  398. </li>
  399. </ul>
  400. </nav>
  401. </li>
  402. <li class="md-nav__item md-nav__item--nested">
  403. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  404. <label class="md-nav__link" for="__nav_5_8">
  405. Gitlab
  406. <span class="md-nav__icon md-icon"></span>
  407. </label>
  408. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  409. <label class="md-nav__title" for="__nav_5_8">
  410. <span class="md-nav__icon md-icon"></span>
  411. Gitlab
  412. </label>
  413. <ul class="md-nav__list" data-md-scrollfix>
  414. <li class="md-nav__item">
  415. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  416. Gitlab Project Variables
  417. </a>
  418. </li>
  419. </ul>
  420. </nav>
  421. </li>
  422. <li class="md-nav__item md-nav__item--nested">
  423. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  424. <label class="md-nav__link" for="__nav_5_9">
  425. Oracle
  426. <span class="md-nav__icon md-icon"></span>
  427. </label>
  428. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  429. <label class="md-nav__title" for="__nav_5_9">
  430. <span class="md-nav__icon md-icon"></span>
  431. Oracle
  432. </label>
  433. <ul class="md-nav__list" data-md-scrollfix>
  434. <li class="md-nav__item">
  435. <a href="../provider-oracle-vault/" class="md-nav__link">
  436. Oracle Vault
  437. </a>
  438. </li>
  439. </ul>
  440. </nav>
  441. </li>
  442. </ul>
  443. </nav>
  444. </li>
  445. <li class="md-nav__item md-nav__item--nested">
  446. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  447. <label class="md-nav__link" for="__nav_6">
  448. References
  449. <span class="md-nav__icon md-icon"></span>
  450. </label>
  451. <nav class="md-nav" aria-label="References" data-md-level="1">
  452. <label class="md-nav__title" for="__nav_6">
  453. <span class="md-nav__icon md-icon"></span>
  454. References
  455. </label>
  456. <ul class="md-nav__list" data-md-scrollfix>
  457. <li class="md-nav__item">
  458. <a href="../spec/" class="md-nav__link">
  459. API specification
  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_7" type="checkbox" id="__nav_7" >
  467. <label class="md-nav__link" for="__nav_7">
  468. Contributing
  469. <span class="md-nav__icon md-icon"></span>
  470. </label>
  471. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  472. <label class="md-nav__title" for="__nav_7">
  473. <span class="md-nav__icon md-icon"></span>
  474. Contributing
  475. </label>
  476. <ul class="md-nav__list" data-md-scrollfix>
  477. <li class="md-nav__item">
  478. <a href="../contributing-devguide/" class="md-nav__link">
  479. Developer guide
  480. </a>
  481. </li>
  482. <li class="md-nav__item">
  483. <a href="../contributing-process/" class="md-nav__link">
  484. Contributing Process
  485. </a>
  486. </li>
  487. <li class="md-nav__item">
  488. <a href="../contributing-coc/" class="md-nav__link">
  489. Code of Conduct
  490. </a>
  491. </li>
  492. </ul>
  493. </nav>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../deprecation-policy/" class="md-nav__link">
  497. Deprecation Policy
  498. </a>
  499. </li>
  500. </ul>
  501. </nav>
  502. </div>
  503. </div>
  504. </div>
  505. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  506. <div class="md-sidebar__scrollwrap">
  507. <div class="md-sidebar__inner">
  508. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  509. <label class="md-nav__title" for="__toc">
  510. <span class="md-nav__icon md-icon"></span>
  511. Table of contents
  512. </label>
  513. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  514. <li class="md-nav__item">
  515. <a href="#hashicorp-vault" class="md-nav__link">
  516. Hashicorp Vault
  517. </a>
  518. <nav class="md-nav" aria-label="Hashicorp Vault">
  519. <ul class="md-nav__list">
  520. <li class="md-nav__item">
  521. <a href="#example" class="md-nav__link">
  522. Example
  523. </a>
  524. <nav class="md-nav" aria-label="Example">
  525. <ul class="md-nav__list">
  526. <li class="md-nav__item">
  527. <a href="#limitations" class="md-nav__link">
  528. Limitations
  529. </a>
  530. </li>
  531. </ul>
  532. </nav>
  533. </li>
  534. <li class="md-nav__item">
  535. <a href="#authentication" class="md-nav__link">
  536. Authentication
  537. </a>
  538. <nav class="md-nav" aria-label="Authentication">
  539. <ul class="md-nav__list">
  540. <li class="md-nav__item">
  541. <a href="#token-based-authentication" class="md-nav__link">
  542. Token-based authentication
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="#approle-authentication-example" class="md-nav__link">
  547. AppRole authentication example
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="#kubernetes-authentication" class="md-nav__link">
  552. Kubernetes authentication
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="#ldap-authentication" class="md-nav__link">
  557. LDAP authentication
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="#jwtoidc-authentication" class="md-nav__link">
  562. JWT/OIDC authentication
  563. </a>
  564. </li>
  565. </ul>
  566. </nav>
  567. </li>
  568. </ul>
  569. </nav>
  570. </li>
  571. </ul>
  572. </nav>
  573. </div>
  574. </div>
  575. </div>
  576. <div class="md-content" data-md-component="content">
  577. <article class="md-content__inner md-typeset">
  578. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/provider-hashicorp-vault.md" title="Edit this page" class="md-content__button md-icon">
  579. <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>
  580. </a>
  581. <h1>HashiCorp Vault</h1>
  582. <p><img alt="HCP Vault" src="../pictures/diagrams-provider-vault.png" /></p>
  583. <h2 id="hashicorp-vault">Hashicorp Vault</h2>
  584. <p>External Secrets Operator integrates with <a href="https://www.vaultproject.io/">HashiCorp Vault</a> for secret
  585. management. Vault itself implements lots of different secret engines, as of now we only support the
  586. <a href="https://www.vaultproject.io/docs/secrets/kv">KV Secrets Engine</a>.</p>
  587. <h3 id="example">Example</h3>
  588. <p>First, create a SecretStore with a vault backend. For the sake of simplicity we'll use a static token <code>root</code>:</p>
  589. <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>
  590. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  591. <span class="nt">metadata</span><span class="p">:</span>
  592. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">vault-backend</span>
  593. <span class="nt">spec</span><span class="p">:</span>
  594. <span class="nt">provider</span><span class="p">:</span>
  595. <span class="nt">vault</span><span class="p">:</span>
  596. <span class="nt">server</span><span class="p">:</span> <span class="s">&quot;http://my.vault.server:8200&quot;</span>
  597. <span class="nt">path</span><span class="p">:</span> <span class="s">&quot;secret&quot;</span>
  598. <span class="nt">version</span><span class="p">:</span> <span class="s">&quot;v2&quot;</span>
  599. <span class="nt">auth</span><span class="p">:</span>
  600. <span class="c1"># points to a secret that contains a vault token</span>
  601. <span class="c1"># https://www.vaultproject.io/docs/auth/token</span>
  602. <span class="nt">tokenSecretRef</span><span class="p">:</span>
  603. <span class="nt">name</span><span class="p">:</span> <span class="s">&quot;vault-token&quot;</span>
  604. <span class="nt">namespace</span><span class="p">:</span> <span class="s">&quot;default&quot;</span>
  605. <span class="nt">key</span><span class="p">:</span> <span class="s">&quot;token&quot;</span>
  606. <span class="nn">---</span>
  607. <span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">v1</span>
  608. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Secret</span>
  609. <span class="nt">metadata</span><span class="p">:</span>
  610. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">vault-token</span>
  611. <span class="nt">data</span><span class="p">:</span>
  612. <span class="nt">token</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">cm9vdA==</span> <span class="c1"># &quot;root&quot;</span>
  613. </code></pre></div>
  614. <p>Then create a simple k/v pair at path <code>secret/foo</code>:</p>
  615. <div class="highlight"><pre><span></span><code>vault kv put secret/foo my-value=s3cr3t
  616. </code></pre></div>
  617. <p>Now create a ExternalSecret that uses the above SecretStore:</p>
  618. <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>
  619. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  620. <span class="nt">metadata</span><span class="p">:</span>
  621. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">vault-example</span>
  622. <span class="nt">spec</span><span class="p">:</span>
  623. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="s">&quot;15s&quot;</span>
  624. <span class="nt">secretStoreRef</span><span class="p">:</span>
  625. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">vault-backend</span>
  626. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  627. <span class="nt">target</span><span class="p">:</span>
  628. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-sync</span>
  629. <span class="nt">data</span><span class="p">:</span>
  630. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">foobar</span>
  631. <span class="nt">remoteRef</span><span class="p">:</span>
  632. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret/foo</span>
  633. <span class="nt">property</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">my-value</span>
  634. <span class="nn">---</span>
  635. <span class="c1"># will create a secret with:</span>
  636. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Secret</span>
  637. <span class="nt">metadata</span><span class="p">:</span>
  638. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-sync</span>
  639. <span class="nt">data</span><span class="p">:</span>
  640. <span class="nt">foobar</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">czNjcjN0</span>
  641. </code></pre></div>
  642. <h4 id="limitations">Limitations</h4>
  643. <p>Vault supports only simple key/value pairs - nested objects are not supported. Hence specifying <code>gjson</code> properties like other providers support it is not supported.</p>
  644. <h3 id="authentication">Authentication</h3>
  645. <p>We support three different modes for authentication:
  646. <a href="https://www.vaultproject.io/docs/auth/token">token-based</a>,
  647. <a href="https://www.vaultproject.io/docs/auth/approle">appRole</a> and
  648. <a href="https://www.vaultproject.io/docs/auth/kubernetes">kubernetes-native</a>, each one comes with it's own
  649. trade-offs. Depending on the authentication method you need to adapt your environment.</p>
  650. <h4 id="token-based-authentication">Token-based authentication</h4>
  651. <p>A static token is stored in a <code>Kind=Secret</code> and is used to authenticate with vault.</p>
  652. <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>
  653. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  654. <span class="nt">metadata</span><span class="p">:</span>
  655. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">vault-backend</span>
  656. <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  657. <span class="nt">spec</span><span class="p">:</span>
  658. <span class="nt">provider</span><span class="p">:</span>
  659. <span class="nt">vault</span><span class="p">:</span>
  660. <span class="nt">server</span><span class="p">:</span> <span class="s">&quot;https://vault.acme.org&quot;</span>
  661. <span class="nt">path</span><span class="p">:</span> <span class="s">&quot;secret&quot;</span>
  662. <span class="nt">version</span><span class="p">:</span> <span class="s">&quot;v2&quot;</span>
  663. <span class="nt">auth</span><span class="p">:</span>
  664. <span class="c1"># points to a secret that contains a vault token</span>
  665. <span class="c1"># https://www.vaultproject.io/docs/auth/token</span>
  666. <span class="nt">tokenSecretRef</span><span class="p">:</span>
  667. <span class="nt">name</span><span class="p">:</span> <span class="s">&quot;my-secret&quot;</span>
  668. <span class="nt">namespace</span><span class="p">:</span> <span class="s">&quot;secret-admin&quot;</span>
  669. <span class="nt">key</span><span class="p">:</span> <span class="s">&quot;vault-token&quot;</span>
  670. </code></pre></div>
  671. <h4 id="approle-authentication-example">AppRole authentication example</h4>
  672. <p><a href="https://www.vaultproject.io/docs/auth/approle">AppRole authentication</a> reads the secret id from a
  673. <code>Kind=Secret</code> and uses the specified <code>roleId</code> to aquire a temporary token to fetch secrets.</p>
  674. <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>
  675. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  676. <span class="nt">metadata</span><span class="p">:</span>
  677. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">vault-backend</span>
  678. <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  679. <span class="nt">spec</span><span class="p">:</span>
  680. <span class="nt">provider</span><span class="p">:</span>
  681. <span class="nt">vault</span><span class="p">:</span>
  682. <span class="nt">server</span><span class="p">:</span> <span class="s">&quot;https://vault.acme.org&quot;</span>
  683. <span class="nt">path</span><span class="p">:</span> <span class="s">&quot;secret&quot;</span>
  684. <span class="nt">version</span><span class="p">:</span> <span class="s">&quot;v2&quot;</span>
  685. <span class="nt">auth</span><span class="p">:</span>
  686. <span class="c1"># VaultAppRole authenticates with Vault using the</span>
  687. <span class="c1"># App Role auth mechanism</span>
  688. <span class="c1"># https://www.vaultproject.io/docs/auth/approle</span>
  689. <span class="nt">appRole</span><span class="p">:</span>
  690. <span class="c1"># Path where the App Role authentication backend is mounted</span>
  691. <span class="nt">path</span><span class="p">:</span> <span class="s">&quot;approle&quot;</span>
  692. <span class="c1"># RoleID configured in the App Role authentication backend</span>
  693. <span class="nt">roleId</span><span class="p">:</span> <span class="s">&quot;db02de05-fa39-4855-059b-67221c5c2f63&quot;</span>
  694. <span class="c1"># Reference to a key in a K8 Secret that contains the App Role SecretId</span>
  695. <span class="nt">secretRef</span><span class="p">:</span>
  696. <span class="nt">name</span><span class="p">:</span> <span class="s">&quot;my-secret&quot;</span>
  697. <span class="nt">namespace</span><span class="p">:</span> <span class="s">&quot;secret-admin&quot;</span>
  698. <span class="nt">key</span><span class="p">:</span> <span class="s">&quot;secret-id&quot;</span>
  699. </code></pre></div>
  700. <h4 id="kubernetes-authentication">Kubernetes authentication</h4>
  701. <p><a href="https://www.vaultproject.io/docs/auth/kubernetes">Kubernetes-native authentication</a> has three
  702. options of optaining credentials for vault:</p>
  703. <ol>
  704. <li>by using a service account jwt referenced in <code>serviceAccountRef</code></li>
  705. <li>by using the jwt from a <code>Kind=Secret</code> referenced by the <code>secretRef</code></li>
  706. <li>by using transient credentials from the mounted service account token within the
  707. external-secrets operator</li>
  708. </ol>
  709. <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>
  710. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  711. <span class="nt">metadata</span><span class="p">:</span>
  712. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">vault-backend</span>
  713. <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  714. <span class="nt">spec</span><span class="p">:</span>
  715. <span class="nt">provider</span><span class="p">:</span>
  716. <span class="nt">vault</span><span class="p">:</span>
  717. <span class="nt">server</span><span class="p">:</span> <span class="s">&quot;https://vault.acme.org&quot;</span>
  718. <span class="nt">path</span><span class="p">:</span> <span class="s">&quot;secret&quot;</span>
  719. <span class="nt">version</span><span class="p">:</span> <span class="s">&quot;v2&quot;</span>
  720. <span class="nt">auth</span><span class="p">:</span>
  721. <span class="c1"># Authenticate against Vault using a Kubernetes ServiceAccount</span>
  722. <span class="c1"># token stored in a Secret.</span>
  723. <span class="c1"># https://www.vaultproject.io/docs/auth/kubernetes</span>
  724. <span class="nt">kubernetes</span><span class="p">:</span>
  725. <span class="c1"># Path where the Kubernetes authentication backend is mounted in Vault</span>
  726. <span class="nt">mountPath</span><span class="p">:</span> <span class="s">&quot;kubernetes&quot;</span>
  727. <span class="c1"># A required field containing the Vault Role to assume.</span>
  728. <span class="nt">role</span><span class="p">:</span> <span class="s">&quot;demo&quot;</span>
  729. <span class="c1"># Optional service account field containing the name</span>
  730. <span class="c1"># of a kubernetes ServiceAccount</span>
  731. <span class="nt">serviceAccountRef</span><span class="p">:</span>
  732. <span class="nt">name</span><span class="p">:</span> <span class="s">&quot;my-sa&quot;</span>
  733. <span class="nt">namespace</span><span class="p">:</span> <span class="s">&quot;secret-admin&quot;</span>
  734. <span class="c1"># Optional secret field containing a Kubernetes ServiceAccount JWT</span>
  735. <span class="c1"># used for authenticating with Vault</span>
  736. <span class="nt">secretRef</span><span class="p">:</span>
  737. <span class="nt">name</span><span class="p">:</span> <span class="s">&quot;my-secret&quot;</span>
  738. <span class="nt">namespace</span><span class="p">:</span> <span class="s">&quot;secret-admin&quot;</span>
  739. <span class="nt">key</span><span class="p">:</span> <span class="s">&quot;vault&quot;</span>
  740. </code></pre></div>
  741. <h4 id="ldap-authentication">LDAP authentication</h4>
  742. <p><a href="https://www.vaultproject.io/docs/auth/ldap">LDAP authentication</a> uses
  743. username/password pair to get an access token. Username is stored directly in
  744. a <code>Kind=SecretStore</code> or <code>Kind=ClusterSecretStore</code> resource, password is stored
  745. in a <code>Kind=Secret</code> referenced by the <code>secretRef</code>.</p>
  746. <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>
  747. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  748. <span class="nt">metadata</span><span class="p">:</span>
  749. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">vault-backend</span>
  750. <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  751. <span class="nt">spec</span><span class="p">:</span>
  752. <span class="nt">provider</span><span class="p">:</span>
  753. <span class="nt">vault</span><span class="p">:</span>
  754. <span class="nt">server</span><span class="p">:</span> <span class="s">&quot;https://vault.acme.org&quot;</span>
  755. <span class="nt">path</span><span class="p">:</span> <span class="s">&quot;secret&quot;</span>
  756. <span class="nt">version</span><span class="p">:</span> <span class="s">&quot;v2&quot;</span>
  757. <span class="nt">auth</span><span class="p">:</span>
  758. <span class="c1"># VaultLdap authenticates with Vault using the LDAP auth mechanism</span>
  759. <span class="c1"># https://www.vaultproject.io/docs/auth/ldap</span>
  760. <span class="nt">ldap</span><span class="p">:</span>
  761. <span class="c1"># LDAP username</span>
  762. <span class="nt">username</span><span class="p">:</span> <span class="s">&quot;username&quot;</span>
  763. <span class="nt">secretRef</span><span class="p">:</span>
  764. <span class="nt">name</span><span class="p">:</span> <span class="s">&quot;my-secret&quot;</span>
  765. <span class="nt">namespace</span><span class="p">:</span> <span class="s">&quot;secret-admin&quot;</span>
  766. <span class="nt">key</span><span class="p">:</span> <span class="s">&quot;ldap-password&quot;</span>
  767. </code></pre></div>
  768. <h4 id="jwtoidc-authentication">JWT/OIDC authentication</h4>
  769. <p><a href="https://www.vaultproject.io/docs/auth/jwt">JWT/OIDC</a> uses a
  770. <a href="https://jwt.io/">JWT</a> token stored in a <code>Kind=Secret</code> and referenced by the
  771. <code>secretRef</code>. Optionally a <code>role</code> field can be defined in a <code>Kind=SecretStore</code>
  772. or <code>Kind=ClusterSecretStore</code> resource.</p>
  773. <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>
  774. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  775. <span class="nt">metadata</span><span class="p">:</span>
  776. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">vault-backend</span>
  777. <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
  778. <span class="nt">spec</span><span class="p">:</span>
  779. <span class="nt">provider</span><span class="p">:</span>
  780. <span class="nt">vault</span><span class="p">:</span>
  781. <span class="nt">server</span><span class="p">:</span> <span class="s">&quot;https://vault.acme.org&quot;</span>
  782. <span class="nt">path</span><span class="p">:</span> <span class="s">&quot;secret&quot;</span>
  783. <span class="nt">version</span><span class="p">:</span> <span class="s">&quot;v2&quot;</span>
  784. <span class="nt">auth</span><span class="p">:</span>
  785. <span class="c1"># VaultJwt authenticates with Vault using the JWT/OIDC auth mechanism</span>
  786. <span class="c1"># https://www.vaultproject.io/docs/auth/jwt</span>
  787. <span class="nt">jwt</span><span class="p">:</span>
  788. <span class="c1"># JWT role configured in a Vault server, optional.</span>
  789. <span class="nt">role</span><span class="p">:</span> <span class="s">&quot;vault-jwt-role&quot;</span>
  790. <span class="nt">secretRef</span><span class="p">:</span>
  791. <span class="nt">name</span><span class="p">:</span> <span class="s">&quot;my-secret&quot;</span>
  792. <span class="nt">namespace</span><span class="p">:</span> <span class="s">&quot;secret-admin&quot;</span>
  793. <span class="nt">key</span><span class="p">:</span> <span class="s">&quot;jwt-token&quot;</span>
  794. </code></pre></div>
  795. </article>
  796. </div>
  797. </div>
  798. </main>
  799. <footer class="md-footer">
  800. <nav class="md-footer__inner md-grid" aria-label="Footer">
  801. <a href="../provider-akeyless/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Akeyless" rel="prev">
  802. <div class="md-footer__button md-icon">
  803. <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>
  804. </div>
  805. <div class="md-footer__title">
  806. <div class="md-ellipsis">
  807. <span class="md-footer__direction">
  808. Previous
  809. </span>
  810. Akeyless
  811. </div>
  812. </div>
  813. </a>
  814. <a href="../provider-yandex-lockbox/" class="md-footer__link md-footer__link--next" aria-label="Next: Lockbox" rel="next">
  815. <div class="md-footer__title">
  816. <div class="md-ellipsis">
  817. <span class="md-footer__direction">
  818. Next
  819. </span>
  820. Lockbox
  821. </div>
  822. </div>
  823. <div class="md-footer__button md-icon">
  824. <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>
  825. </div>
  826. </a>
  827. </nav>
  828. <div class="md-footer-meta md-typeset">
  829. <div class="md-footer-meta__inner md-grid">
  830. <div class="md-footer-copyright">
  831. Made with
  832. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  833. Material for MkDocs
  834. </a>
  835. </div>
  836. </div>
  837. </div>
  838. </footer>
  839. </div>
  840. <div class="md-dialog" data-md-component="dialog">
  841. <div class="md-dialog__inner md-typeset"></div>
  842. </div>
  843. <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": null}</script>
  844. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  845. </body>
  846. </html>