index.html 29 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168
  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>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="#introduction" 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. Introduction
  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 md-nav__item--active">
  116. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  117. <label class="md-nav__link md-nav__link--active" for="__toc">
  118. Introduction
  119. <span class="md-nav__icon md-icon"></span>
  120. </label>
  121. <a href="." class="md-nav__link md-nav__link--active">
  122. Introduction
  123. </a>
  124. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  125. <label class="md-nav__title" for="__toc">
  126. <span class="md-nav__icon md-icon"></span>
  127. Table of contents
  128. </label>
  129. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  130. <li class="md-nav__item">
  131. <a href="#what-is-the-goal-of-external-secrets-operator" class="md-nav__link">
  132. What is the goal of External Secrets Operator?
  133. </a>
  134. </li>
  135. <li class="md-nav__item">
  136. <a href="#where-to-get-started" class="md-nav__link">
  137. Where to get started
  138. </a>
  139. </li>
  140. <li class="md-nav__item">
  141. <a href="#how-to-get-involved" class="md-nav__link">
  142. How to get involved
  143. </a>
  144. </li>
  145. <li class="md-nav__item">
  146. <a href="#kicked-off-by" class="md-nav__link">
  147. Kicked off by
  148. </a>
  149. </li>
  150. </ul>
  151. </nav>
  152. </li>
  153. <li class="md-nav__item">
  154. <a href="api-overview/" class="md-nav__link">
  155. Overview
  156. </a>
  157. </li>
  158. <li class="md-nav__item md-nav__item--nested">
  159. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  160. <label class="md-nav__link" for="__nav_3">
  161. API Types
  162. <span class="md-nav__icon md-icon"></span>
  163. </label>
  164. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  165. <label class="md-nav__title" for="__nav_3">
  166. <span class="md-nav__icon md-icon"></span>
  167. API Types
  168. </label>
  169. <ul class="md-nav__list" data-md-scrollfix>
  170. <li class="md-nav__item">
  171. <a href="api-externalsecret/" class="md-nav__link">
  172. ExternalSecret
  173. </a>
  174. </li>
  175. <li class="md-nav__item">
  176. <a href="api-secretstore/" class="md-nav__link">
  177. SecretStore
  178. </a>
  179. </li>
  180. <li class="md-nav__item">
  181. <a href="api-clustersecretstore/" class="md-nav__link">
  182. ClusterSecretStore
  183. </a>
  184. </li>
  185. </ul>
  186. </nav>
  187. </li>
  188. <li class="md-nav__item md-nav__item--nested">
  189. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  190. <label class="md-nav__link" for="__nav_4">
  191. Guides
  192. <span class="md-nav__icon md-icon"></span>
  193. </label>
  194. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  195. <label class="md-nav__title" for="__nav_4">
  196. <span class="md-nav__icon md-icon"></span>
  197. Guides
  198. </label>
  199. <ul class="md-nav__list" data-md-scrollfix>
  200. <li class="md-nav__item">
  201. <a href="guides-introduction/" class="md-nav__link">
  202. Introduction
  203. </a>
  204. </li>
  205. <li class="md-nav__item">
  206. <a href="guides-getting-started/" class="md-nav__link">
  207. Getting started
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="guides-templating/" class="md-nav__link">
  212. Advanced Templating
  213. </a>
  214. </li>
  215. <li class="md-nav__item">
  216. <a href="guides-controller-class/" class="md-nav__link">
  217. Controller Classes
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="guides-all-keys-one-secret/" class="md-nav__link">
  222. All keys, One secret
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="guides-common-k8s-secret-types/" class="md-nav__link">
  227. Common K8S Secret Types
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="guides-multi-tenancy/" class="md-nav__link">
  232. Multi Tenancy
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="guides-metrics/" class="md-nav__link">
  237. Metrics
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="guides-using-latest-image/" class="md-nav__link">
  242. Using Latest Image
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="guides-gitops-using-fluxcd/" class="md-nav__link">
  247. GitOps using FluxCD
  248. </a>
  249. </li>
  250. </ul>
  251. </nav>
  252. </li>
  253. <li class="md-nav__item md-nav__item--nested">
  254. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  255. <label class="md-nav__link" for="__nav_5">
  256. Provider
  257. <span class="md-nav__icon md-icon"></span>
  258. </label>
  259. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  260. <label class="md-nav__title" for="__nav_5">
  261. <span class="md-nav__icon md-icon"></span>
  262. Provider
  263. </label>
  264. <ul class="md-nav__list" data-md-scrollfix>
  265. <li class="md-nav__item md-nav__item--nested">
  266. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  267. <label class="md-nav__link" for="__nav_5_1">
  268. AWS
  269. <span class="md-nav__icon md-icon"></span>
  270. </label>
  271. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_5_1">
  273. <span class="md-nav__icon md-icon"></span>
  274. AWS
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="provider-aws-secrets-manager/" class="md-nav__link">
  279. Secrets Manager
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="provider-aws-parameter-store/" class="md-nav__link">
  284. Parameter Store
  285. </a>
  286. </li>
  287. </ul>
  288. </nav>
  289. </li>
  290. <li class="md-nav__item md-nav__item--nested">
  291. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  292. <label class="md-nav__link" for="__nav_5_2">
  293. Azure
  294. <span class="md-nav__icon md-icon"></span>
  295. </label>
  296. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  297. <label class="md-nav__title" for="__nav_5_2">
  298. <span class="md-nav__icon md-icon"></span>
  299. Azure
  300. </label>
  301. <ul class="md-nav__list" data-md-scrollfix>
  302. <li class="md-nav__item">
  303. <a href="provider-azure-key-vault/" class="md-nav__link">
  304. Key Vault
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  312. <label class="md-nav__link" for="__nav_5_3">
  313. Google
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="Google" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_5_3">
  318. <span class="md-nav__icon md-icon"></span>
  319. Google
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="provider-google-secrets-manager/" class="md-nav__link">
  324. Secrets Manager
  325. </a>
  326. </li>
  327. </ul>
  328. </nav>
  329. </li>
  330. <li class="md-nav__item md-nav__item--nested">
  331. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  332. <label class="md-nav__link" for="__nav_5_4">
  333. IBM
  334. <span class="md-nav__icon md-icon"></span>
  335. </label>
  336. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  337. <label class="md-nav__title" for="__nav_5_4">
  338. <span class="md-nav__icon md-icon"></span>
  339. IBM
  340. </label>
  341. <ul class="md-nav__list" data-md-scrollfix>
  342. <li class="md-nav__item">
  343. <a href="provider-ibm-secrets-manager/" class="md-nav__link">
  344. Secrets Manager
  345. </a>
  346. </li>
  347. </ul>
  348. </nav>
  349. </li>
  350. <li class="md-nav__item">
  351. <a href="provider-akeyless/" class="md-nav__link">
  352. Akeyless
  353. </a>
  354. </li>
  355. <li class="md-nav__item">
  356. <a href="provider-hashicorp-vault/" class="md-nav__link">
  357. HashiCorp Vault
  358. </a>
  359. </li>
  360. <li class="md-nav__item md-nav__item--nested">
  361. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  362. <label class="md-nav__link" for="__nav_5_7">
  363. Yandex
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  367. <label class="md-nav__title" for="__nav_5_7">
  368. <span class="md-nav__icon md-icon"></span>
  369. Yandex
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="provider-yandex-lockbox/" class="md-nav__link">
  374. Lockbox
  375. </a>
  376. </li>
  377. </ul>
  378. </nav>
  379. </li>
  380. <li class="md-nav__item md-nav__item--nested">
  381. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  382. <label class="md-nav__link" for="__nav_5_8">
  383. Gitlab
  384. <span class="md-nav__icon md-icon"></span>
  385. </label>
  386. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  387. <label class="md-nav__title" for="__nav_5_8">
  388. <span class="md-nav__icon md-icon"></span>
  389. Gitlab
  390. </label>
  391. <ul class="md-nav__list" data-md-scrollfix>
  392. <li class="md-nav__item">
  393. <a href="provider-gitlab-project-variables/" class="md-nav__link">
  394. Gitlab Project Variables
  395. </a>
  396. </li>
  397. </ul>
  398. </nav>
  399. </li>
  400. <li class="md-nav__item md-nav__item--nested">
  401. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  402. <label class="md-nav__link" for="__nav_5_9">
  403. Oracle
  404. <span class="md-nav__icon md-icon"></span>
  405. </label>
  406. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  407. <label class="md-nav__title" for="__nav_5_9">
  408. <span class="md-nav__icon md-icon"></span>
  409. Oracle
  410. </label>
  411. <ul class="md-nav__list" data-md-scrollfix>
  412. <li class="md-nav__item">
  413. <a href="provider-oracle-vault/" class="md-nav__link">
  414. Oracle Vault
  415. </a>
  416. </li>
  417. </ul>
  418. </nav>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="provider-webhook/" class="md-nav__link">
  422. Webhook
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="provider-fake/" class="md-nav__link">
  427. Fake
  428. </a>
  429. </li>
  430. </ul>
  431. </nav>
  432. </li>
  433. <li class="md-nav__item md-nav__item--nested">
  434. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  435. <label class="md-nav__link" for="__nav_6">
  436. References
  437. <span class="md-nav__icon md-icon"></span>
  438. </label>
  439. <nav class="md-nav" aria-label="References" data-md-level="1">
  440. <label class="md-nav__title" for="__nav_6">
  441. <span class="md-nav__icon md-icon"></span>
  442. References
  443. </label>
  444. <ul class="md-nav__list" data-md-scrollfix>
  445. <li class="md-nav__item">
  446. <a href="spec/" class="md-nav__link">
  447. API specification
  448. </a>
  449. </li>
  450. </ul>
  451. </nav>
  452. </li>
  453. <li class="md-nav__item md-nav__item--nested">
  454. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  455. <label class="md-nav__link" for="__nav_7">
  456. Contributing
  457. <span class="md-nav__icon md-icon"></span>
  458. </label>
  459. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  460. <label class="md-nav__title" for="__nav_7">
  461. <span class="md-nav__icon md-icon"></span>
  462. Contributing
  463. </label>
  464. <ul class="md-nav__list" data-md-scrollfix>
  465. <li class="md-nav__item">
  466. <a href="contributing-devguide/" class="md-nav__link">
  467. Developer guide
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="contributing-process/" class="md-nav__link">
  472. Contributing Process
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="contributing-coc/" class="md-nav__link">
  477. Code of Conduct
  478. </a>
  479. </li>
  480. </ul>
  481. </nav>
  482. </li>
  483. <li class="md-nav__item">
  484. <a href="deprecation-policy/" class="md-nav__link">
  485. Deprecation Policy
  486. </a>
  487. </li>
  488. </ul>
  489. </nav>
  490. </div>
  491. </div>
  492. </div>
  493. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  494. <div class="md-sidebar__scrollwrap">
  495. <div class="md-sidebar__inner">
  496. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  497. <label class="md-nav__title" for="__toc">
  498. <span class="md-nav__icon md-icon"></span>
  499. Table of contents
  500. </label>
  501. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  502. <li class="md-nav__item">
  503. <a href="#what-is-the-goal-of-external-secrets-operator" class="md-nav__link">
  504. What is the goal of External Secrets Operator?
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="#where-to-get-started" class="md-nav__link">
  509. Where to get started
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="#how-to-get-involved" class="md-nav__link">
  514. How to get involved
  515. </a>
  516. </li>
  517. <li class="md-nav__item">
  518. <a href="#kicked-off-by" class="md-nav__link">
  519. Kicked off by
  520. </a>
  521. </li>
  522. </ul>
  523. </nav>
  524. </div>
  525. </div>
  526. </div>
  527. <div class="md-content" data-md-component="content">
  528. <article class="md-content__inner md-typeset">
  529. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/index.md" title="Edit this page" class="md-content__button md-icon">
  530. <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>
  531. </a>
  532. <h1 id="introduction">Introduction</h1>
  533. <p><img alt="high-level" src="pictures/diagrams-high-level-simple.png" /></p>
  534. <p><strong>External Secrets Operator</strong> is a Kubernetes operator that integrates external
  535. secret management systems like <a href="https://aws.amazon.com/secrets-manager/">AWS Secrets
  536. Manager</a>, <a href="https://www.vaultproject.io/">HashiCorp
  537. Vault</a>, <a href="https://cloud.google.com/secret-manager">Google Secrets
  538. Manager</a>, <a href="https://azure.microsoft.com/en-us/services/key-vault/">Azure Key
  539. Vault</a> and many more. The
  540. operator reads information from external APIs and automatically injects the
  541. values into a <a href="https://kubernetes.io/docs/concepts/configuration/secret/">Kubernetes
  542. Secret</a>.</p>
  543. <h3 id="what-is-the-goal-of-external-secrets-operator">What is the goal of External Secrets Operator?</h3>
  544. <p>The goal of External Secrets Operator is to synchronize secrets from external
  545. APIs into Kubernetes. ESO is a collection of custom API resources -
  546. <code>ExternalSecret</code>, <code>SecretStore</code> and <code>ClusterSecretStore</code> that provide a
  547. user-friendly abstraction for the external API that stores and manages the
  548. lifecycle of the secrets for you.</p>
  549. <h3 id="where-to-get-started">Where to get started</h3>
  550. <p>To get started, please read through <a href="api-overview/">API overview</a> this should
  551. give you a high-level overview to understand the API and use-cases. After that
  552. please follow one of our <a href="guides-introduction/">guides</a> to get a jump start
  553. using the operator. See our <a href="guides-getting-started/">getting started guide</a> for installation instructions.</p>
  554. <p>For a complete reference of the API types please refer to our <a href="spec/">API
  555. Reference</a>.</p>
  556. <h3 id="how-to-get-involved">How to get involved</h3>
  557. <p>This project is driven by it's users and contributors and we welcome everybody
  558. to get involved. Join our meetings, open issues or ask questions in Slack. The
  559. success of this project depends on your input: No contribution is too small -
  560. even opinions matter!</p>
  561. <p>How to get involved:</p>
  562. <ul>
  563. <li>Bi-weekly Development Meeting every odd week at <a href="https://dateful.com/time-zone-converter?t=17:30&amp;tz=Europe/Berlin">5:30 PM Berlin Time</a>
  564. (<a href="https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA">agenda</a>, <a href="https://meet.jit.si/SurroundingContentionsImportSubsequently">jitsi call</a>)</li>
  565. <li><a href="https://kubernetes.slack.com/messages/external-secrets">Kubernetes Slack
  566. #external-secrets</a></li>
  567. <li><a href="contributing-process/">Contributing Process</a></li>
  568. </ul>
  569. <h3 id="kicked-off-by">Kicked off by</h3>
  570. <p><img alt="cs-logo" src="pictures/cs_logo.png" />
  571. <img alt="godaddy-logo" src="pictures/godaddy_logo.png" /></p>
  572. </article>
  573. </div>
  574. </div>
  575. </main>
  576. <footer class="md-footer">
  577. <nav class="md-footer__inner md-grid" aria-label="Footer">
  578. <a href="api-overview/" class="md-footer__link md-footer__link--next" aria-label="Next: Overview" rel="next">
  579. <div class="md-footer__title">
  580. <div class="md-ellipsis">
  581. <span class="md-footer__direction">
  582. Next
  583. </span>
  584. Overview
  585. </div>
  586. </div>
  587. <div class="md-footer__button md-icon">
  588. <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>
  589. </div>
  590. </a>
  591. </nav>
  592. <div class="md-footer-meta md-typeset">
  593. <div class="md-footer-meta__inner md-grid">
  594. <div class="md-footer-copyright">
  595. Made with
  596. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  597. Material for MkDocs
  598. </a>
  599. </div>
  600. </div>
  601. </div>
  602. </footer>
  603. </div>
  604. <div class="md-dialog" data-md-component="dialog">
  605. <div class="md-dialog__inner md-typeset"></div>
  606. </div>
  607. <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>
  608. <script src="assets/javascripts/bundle.76f349be.min.js"></script>
  609. </body>
  610. </html>