index.html 34 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219
  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>Lockbox - 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="#yandex-lockbox" 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. Lockbox
  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--nested">
  258. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  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">
  270. <a href="../provider-azure-key-vault/" class="md-nav__link">
  271. Key Vault
  272. </a>
  273. </li>
  274. </ul>
  275. </nav>
  276. </li>
  277. <li class="md-nav__item md-nav__item--nested">
  278. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  279. <label class="md-nav__link" for="__nav_5_3">
  280. Google
  281. <span class="md-nav__icon md-icon"></span>
  282. </label>
  283. <nav class="md-nav" aria-label="Google" data-md-level="2">
  284. <label class="md-nav__title" for="__nav_5_3">
  285. <span class="md-nav__icon md-icon"></span>
  286. Google
  287. </label>
  288. <ul class="md-nav__list" data-md-scrollfix>
  289. <li class="md-nav__item">
  290. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  291. Secrets Manager
  292. </a>
  293. </li>
  294. </ul>
  295. </nav>
  296. </li>
  297. <li class="md-nav__item md-nav__item--nested">
  298. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  299. <label class="md-nav__link" for="__nav_5_4">
  300. IBM
  301. <span class="md-nav__icon md-icon"></span>
  302. </label>
  303. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  304. <label class="md-nav__title" for="__nav_5_4">
  305. <span class="md-nav__icon md-icon"></span>
  306. IBM
  307. </label>
  308. <ul class="md-nav__list" data-md-scrollfix>
  309. <li class="md-nav__item">
  310. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  311. Secrets Manager
  312. </a>
  313. </li>
  314. </ul>
  315. </nav>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../provider-akeyless/" class="md-nav__link">
  319. Akeyless
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  324. HashiCorp Vault
  325. </a>
  326. </li>
  327. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  328. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" checked>
  329. <label class="md-nav__link" for="__nav_5_7">
  330. Yandex
  331. <span class="md-nav__icon md-icon"></span>
  332. </label>
  333. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  334. <label class="md-nav__title" for="__nav_5_7">
  335. <span class="md-nav__icon md-icon"></span>
  336. Yandex
  337. </label>
  338. <ul class="md-nav__list" data-md-scrollfix>
  339. <li class="md-nav__item md-nav__item--active">
  340. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  341. <label class="md-nav__link md-nav__link--active" for="__toc">
  342. Lockbox
  343. <span class="md-nav__icon md-icon"></span>
  344. </label>
  345. <a href="./" class="md-nav__link md-nav__link--active">
  346. Lockbox
  347. </a>
  348. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  349. <label class="md-nav__title" for="__toc">
  350. <span class="md-nav__icon md-icon"></span>
  351. Table of contents
  352. </label>
  353. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  354. <li class="md-nav__item">
  355. <a href="#yandex-lockbox" class="md-nav__link">
  356. Yandex Lockbox
  357. </a>
  358. <nav class="md-nav" aria-label="Yandex Lockbox">
  359. <ul class="md-nav__list">
  360. <li class="md-nav__item">
  361. <a href="#prerequisites" class="md-nav__link">
  362. Prerequisites
  363. </a>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="#authentication" class="md-nav__link">
  367. Authentication
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="#creating-external-secret" class="md-nav__link">
  372. Creating external secret
  373. </a>
  374. </li>
  375. </ul>
  376. </nav>
  377. </li>
  378. </ul>
  379. </nav>
  380. </li>
  381. </ul>
  382. </nav>
  383. </li>
  384. <li class="md-nav__item md-nav__item--nested">
  385. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  386. <label class="md-nav__link" for="__nav_5_8">
  387. Gitlab
  388. <span class="md-nav__icon md-icon"></span>
  389. </label>
  390. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  391. <label class="md-nav__title" for="__nav_5_8">
  392. <span class="md-nav__icon md-icon"></span>
  393. Gitlab
  394. </label>
  395. <ul class="md-nav__list" data-md-scrollfix>
  396. <li class="md-nav__item">
  397. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  398. Gitlab Project Variables
  399. </a>
  400. </li>
  401. </ul>
  402. </nav>
  403. </li>
  404. <li class="md-nav__item md-nav__item--nested">
  405. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  406. <label class="md-nav__link" for="__nav_5_9">
  407. Oracle
  408. <span class="md-nav__icon md-icon"></span>
  409. </label>
  410. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  411. <label class="md-nav__title" for="__nav_5_9">
  412. <span class="md-nav__icon md-icon"></span>
  413. Oracle
  414. </label>
  415. <ul class="md-nav__list" data-md-scrollfix>
  416. <li class="md-nav__item">
  417. <a href="../provider-oracle-vault/" class="md-nav__link">
  418. Oracle Vault
  419. </a>
  420. </li>
  421. </ul>
  422. </nav>
  423. </li>
  424. <li class="md-nav__item">
  425. <a href="../provider-webhook/" class="md-nav__link">
  426. Webhook
  427. </a>
  428. </li>
  429. </ul>
  430. </nav>
  431. </li>
  432. <li class="md-nav__item md-nav__item--nested">
  433. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  434. <label class="md-nav__link" for="__nav_6">
  435. References
  436. <span class="md-nav__icon md-icon"></span>
  437. </label>
  438. <nav class="md-nav" aria-label="References" data-md-level="1">
  439. <label class="md-nav__title" for="__nav_6">
  440. <span class="md-nav__icon md-icon"></span>
  441. References
  442. </label>
  443. <ul class="md-nav__list" data-md-scrollfix>
  444. <li class="md-nav__item">
  445. <a href="../spec/" class="md-nav__link">
  446. API specification
  447. </a>
  448. </li>
  449. </ul>
  450. </nav>
  451. </li>
  452. <li class="md-nav__item md-nav__item--nested">
  453. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  454. <label class="md-nav__link" for="__nav_7">
  455. Contributing
  456. <span class="md-nav__icon md-icon"></span>
  457. </label>
  458. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  459. <label class="md-nav__title" for="__nav_7">
  460. <span class="md-nav__icon md-icon"></span>
  461. Contributing
  462. </label>
  463. <ul class="md-nav__list" data-md-scrollfix>
  464. <li class="md-nav__item">
  465. <a href="../contributing-devguide/" class="md-nav__link">
  466. Developer guide
  467. </a>
  468. </li>
  469. <li class="md-nav__item">
  470. <a href="../contributing-process/" class="md-nav__link">
  471. Contributing Process
  472. </a>
  473. </li>
  474. <li class="md-nav__item">
  475. <a href="../contributing-coc/" class="md-nav__link">
  476. Code of Conduct
  477. </a>
  478. </li>
  479. </ul>
  480. </nav>
  481. </li>
  482. <li class="md-nav__item">
  483. <a href="../deprecation-policy/" class="md-nav__link">
  484. Deprecation Policy
  485. </a>
  486. </li>
  487. </ul>
  488. </nav>
  489. </div>
  490. </div>
  491. </div>
  492. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  493. <div class="md-sidebar__scrollwrap">
  494. <div class="md-sidebar__inner">
  495. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  496. <label class="md-nav__title" for="__toc">
  497. <span class="md-nav__icon md-icon"></span>
  498. Table of contents
  499. </label>
  500. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  501. <li class="md-nav__item">
  502. <a href="#yandex-lockbox" class="md-nav__link">
  503. Yandex Lockbox
  504. </a>
  505. <nav class="md-nav" aria-label="Yandex Lockbox">
  506. <ul class="md-nav__list">
  507. <li class="md-nav__item">
  508. <a href="#prerequisites" class="md-nav__link">
  509. Prerequisites
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="#authentication" class="md-nav__link">
  514. Authentication
  515. </a>
  516. </li>
  517. <li class="md-nav__item">
  518. <a href="#creating-external-secret" class="md-nav__link">
  519. Creating external secret
  520. </a>
  521. </li>
  522. </ul>
  523. </nav>
  524. </li>
  525. </ul>
  526. </nav>
  527. </div>
  528. </div>
  529. </div>
  530. <div class="md-content" data-md-component="content">
  531. <article class="md-content__inner md-typeset">
  532. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/provider-yandex-lockbox.md" title="Edit this page" class="md-content__button md-icon">
  533. <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>
  534. </a>
  535. <h1>Lockbox</h1>
  536. <h2 id="yandex-lockbox">Yandex Lockbox</h2>
  537. <p>External Secrets Operator integrates with <a href="https://cloud.yandex.com/docs/lockbox/">Yandex Lockbox</a>
  538. for secret management.</p>
  539. <h3 id="prerequisites">Prerequisites</h3>
  540. <ul>
  541. <li><a href="../guides-getting-started/#installing-with-helm">External Secrets Operator installed</a></li>
  542. <li><a href="https://cloud.yandex.com/docs/cli/quickstart">Yandex.Cloud CLI installed</a></li>
  543. </ul>
  544. <h3 id="authentication">Authentication</h3>
  545. <p>At the moment, <a href="https://cloud.yandex.com/docs/iam/concepts/authorization/key">authorized key</a> authentication is only supported:</p>
  546. <ul>
  547. <li>Create a <a href="https://cloud.yandex.com/docs/iam/concepts/users/service-accounts">service account</a> in Yandex.Cloud:
  548. <div class="highlight"><pre><span></span><code>yc iam service-account create --name eso-service-account
  549. </code></pre></div></li>
  550. <li>Create an authorized key for the service account and save it to <code>authorized-key.json</code> file:
  551. <div class="highlight"><pre><span></span><code>yc iam key create <span class="se">\</span>
  552. --service-account-name eso-service-account <span class="se">\</span>
  553. --output authorized-key.json
  554. </code></pre></div></li>
  555. <li>Create a k8s secret containing the authorized key saved above:
  556. <div class="highlight"><pre><span></span><code>kubectl create secret generic yc-auth --from-file<span class="o">=</span>authorized-key<span class="o">=</span>authorized-key.json
  557. </code></pre></div></li>
  558. <li>Create a <a href="../api-secretstore/">SecretStore</a> pointing to <code>yc-auth</code> k8s secret:
  559. <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>
  560. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  561. <span class="nt">metadata</span><span class="p">:</span>
  562. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-store</span>
  563. <span class="nt">spec</span><span class="p">:</span>
  564. <span class="nt">provider</span><span class="p">:</span>
  565. <span class="nt">yandexlockbox</span><span class="p">:</span>
  566. <span class="nt">auth</span><span class="p">:</span>
  567. <span class="nt">authorizedKeySecretRef</span><span class="p">:</span>
  568. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">yc-auth</span>
  569. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">authorized-key</span>
  570. </code></pre></div></li>
  571. </ul>
  572. <h3 id="creating-external-secret">Creating external secret</h3>
  573. <p>To make External Secrets Operator sync a k8s secret with a Lockbox secret:</p>
  574. <ul>
  575. <li>Create a Lockbox secret, if not already created:
  576. <div class="highlight"><pre><span></span><code>yc lockbox secret create <span class="se">\</span>
  577. --name lockbox-secret <span class="se">\</span>
  578. --payload <span class="s1">&#39;[{&quot;key&quot;: &quot;password&quot;,&quot;textValue&quot;: &quot;p@$$w0rd&quot;}]&#39;</span>
  579. </code></pre></div></li>
  580. <li>Assign the <a href="https://cloud.yandex.com/docs/lockbox/security/#roles-list"><code>lockbox.payloadViewer</code></a> role
  581. for accessing the <code>lockbox-secret</code> payload to the service account used for authentication:
  582. <div class="highlight"><pre><span></span><code>yc lockbox secret add-access-binding <span class="se">\</span>
  583. --name lockbox-secret <span class="se">\</span>
  584. --service-account-name eso-service-account <span class="se">\</span>
  585. --role lockbox.payloadViewer
  586. </code></pre></div>
  587. Run the following command to ensure that the correct access binding has been added:
  588. <div class="highlight"><pre><span></span><code>yc lockbox secret list-access-bindings --name lockbox-secret
  589. </code></pre></div></li>
  590. <li>Create an <a href="../api-externalsecret/">ExternalSecret</a> pointing to <code>secret-store</code> and <code>lockbox-secret</code>:
  591. <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>
  592. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  593. <span class="nt">metadata</span><span class="p">:</span>
  594. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secret</span>
  595. <span class="nt">spec</span><span class="p">:</span>
  596. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1h</span>
  597. <span class="nt">secretStoreRef</span><span class="p">:</span>
  598. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret-store</span>
  599. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  600. <span class="nt">target</span><span class="p">:</span>
  601. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">k8s-secret</span> <span class="c1"># the target k8s secret name</span>
  602. <span class="nt">data</span><span class="p">:</span>
  603. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">password</span> <span class="c1"># the target k8s secret key</span>
  604. <span class="nt">remoteRef</span><span class="p">:</span>
  605. <span class="nt">key</span><span class="p">:</span> <span class="err">*****</span> <span class="c1"># ID of lockbox-secret</span>
  606. <span class="nt">property</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">password</span> <span class="c1"># (optional) payload entry key of lockbox-secret</span>
  607. </code></pre></div></li>
  608. </ul>
  609. <p>The operator will fetch the Yandex Lockbox secret and inject it as a <code>Kind=Secret</code>
  610. <div class="highlight"><pre><span></span><code><span class="l l-Scalar l-Scalar-Plain">kubectl get secret k8s-secret -n &lt;namespace&gt; | -o jsonpath=&#39;{.data.password}&#39; | base64 -d</span>
  611. </code></pre></div></p>
  612. </article>
  613. </div>
  614. </div>
  615. </main>
  616. <footer class="md-footer">
  617. <nav class="md-footer__inner md-grid" aria-label="Footer">
  618. <a href="../provider-hashicorp-vault/" class="md-footer__link md-footer__link--prev" aria-label="Previous: HashiCorp Vault" rel="prev">
  619. <div class="md-footer__button md-icon">
  620. <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>
  621. </div>
  622. <div class="md-footer__title">
  623. <div class="md-ellipsis">
  624. <span class="md-footer__direction">
  625. Previous
  626. </span>
  627. HashiCorp Vault
  628. </div>
  629. </div>
  630. </a>
  631. <a href="../provider-gitlab-project-variables/" class="md-footer__link md-footer__link--next" aria-label="Next: Gitlab Project Variables" rel="next">
  632. <div class="md-footer__title">
  633. <div class="md-ellipsis">
  634. <span class="md-footer__direction">
  635. Next
  636. </span>
  637. Gitlab Project Variables
  638. </div>
  639. </div>
  640. <div class="md-footer__button md-icon">
  641. <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>
  642. </div>
  643. </a>
  644. </nav>
  645. <div class="md-footer-meta md-typeset">
  646. <div class="md-footer-meta__inner md-grid">
  647. <div class="md-footer-copyright">
  648. Made with
  649. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  650. Material for MkDocs
  651. </a>
  652. </div>
  653. </div>
  654. </div>
  655. </footer>
  656. </div>
  657. <div class="md-dialog" data-md-component="dialog">
  658. <div class="md-dialog__inner md-typeset"></div>
  659. </div>
  660. <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>
  661. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  662. </body>
  663. </html>