index.html 29 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120
  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-all-keys-one-secret/" class="md-nav__link">
  217. All keys, One secret
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="guides-common-k8s-secret-types/" class="md-nav__link">
  222. Common K8S Secret Types
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="guides-multi-tenancy/" class="md-nav__link">
  227. Multi Tenancy
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="guides-metrics/" class="md-nav__link">
  232. Metrics
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="guides-using-latest-image/" class="md-nav__link">
  237. Using Latest Image
  238. </a>
  239. </li>
  240. </ul>
  241. </nav>
  242. </li>
  243. <li class="md-nav__item md-nav__item--nested">
  244. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  245. <label class="md-nav__link" for="__nav_5">
  246. Provider
  247. <span class="md-nav__icon md-icon"></span>
  248. </label>
  249. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  250. <label class="md-nav__title" for="__nav_5">
  251. <span class="md-nav__icon md-icon"></span>
  252. Provider
  253. </label>
  254. <ul class="md-nav__list" data-md-scrollfix>
  255. <li class="md-nav__item md-nav__item--nested">
  256. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  257. <label class="md-nav__link" for="__nav_5_1">
  258. AWS
  259. <span class="md-nav__icon md-icon"></span>
  260. </label>
  261. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  262. <label class="md-nav__title" for="__nav_5_1">
  263. <span class="md-nav__icon md-icon"></span>
  264. AWS
  265. </label>
  266. <ul class="md-nav__list" data-md-scrollfix>
  267. <li class="md-nav__item">
  268. <a href="provider-aws-secrets-manager/" class="md-nav__link">
  269. Secrets Manager
  270. </a>
  271. </li>
  272. <li class="md-nav__item">
  273. <a href="provider-aws-parameter-store/" class="md-nav__link">
  274. Parameter Store
  275. </a>
  276. </li>
  277. </ul>
  278. </nav>
  279. </li>
  280. <li class="md-nav__item md-nav__item--nested">
  281. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  282. <label class="md-nav__link" for="__nav_5_2">
  283. Azure
  284. <span class="md-nav__icon md-icon"></span>
  285. </label>
  286. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  287. <label class="md-nav__title" for="__nav_5_2">
  288. <span class="md-nav__icon md-icon"></span>
  289. Azure
  290. </label>
  291. <ul class="md-nav__list" data-md-scrollfix>
  292. <li class="md-nav__item">
  293. <a href="provider-azure-key-vault/" class="md-nav__link">
  294. Key Vault
  295. </a>
  296. </li>
  297. </ul>
  298. </nav>
  299. </li>
  300. <li class="md-nav__item md-nav__item--nested">
  301. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  302. <label class="md-nav__link" for="__nav_5_3">
  303. Google
  304. <span class="md-nav__icon md-icon"></span>
  305. </label>
  306. <nav class="md-nav" aria-label="Google" data-md-level="2">
  307. <label class="md-nav__title" for="__nav_5_3">
  308. <span class="md-nav__icon md-icon"></span>
  309. Google
  310. </label>
  311. <ul class="md-nav__list" data-md-scrollfix>
  312. <li class="md-nav__item">
  313. <a href="provider-google-secrets-manager/" class="md-nav__link">
  314. Secrets Manager
  315. </a>
  316. </li>
  317. </ul>
  318. </nav>
  319. </li>
  320. <li class="md-nav__item md-nav__item--nested">
  321. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  322. <label class="md-nav__link" for="__nav_5_4">
  323. IBM
  324. <span class="md-nav__icon md-icon"></span>
  325. </label>
  326. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  327. <label class="md-nav__title" for="__nav_5_4">
  328. <span class="md-nav__icon md-icon"></span>
  329. IBM
  330. </label>
  331. <ul class="md-nav__list" data-md-scrollfix>
  332. <li class="md-nav__item">
  333. <a href="provider-ibm-secrets-manager/" class="md-nav__link">
  334. Secrets Manager
  335. </a>
  336. </li>
  337. </ul>
  338. </nav>
  339. </li>
  340. <li class="md-nav__item">
  341. <a href="provider-akeyless/" class="md-nav__link">
  342. Akeyless
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="provider-hashicorp-vault/" class="md-nav__link">
  347. HashiCorp Vault
  348. </a>
  349. </li>
  350. <li class="md-nav__item md-nav__item--nested">
  351. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  352. <label class="md-nav__link" for="__nav_5_7">
  353. Yandex
  354. <span class="md-nav__icon md-icon"></span>
  355. </label>
  356. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  357. <label class="md-nav__title" for="__nav_5_7">
  358. <span class="md-nav__icon md-icon"></span>
  359. Yandex
  360. </label>
  361. <ul class="md-nav__list" data-md-scrollfix>
  362. <li class="md-nav__item">
  363. <a href="provider-yandex-lockbox/" class="md-nav__link">
  364. Lockbox
  365. </a>
  366. </li>
  367. </ul>
  368. </nav>
  369. </li>
  370. <li class="md-nav__item md-nav__item--nested">
  371. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  372. <label class="md-nav__link" for="__nav_5_8">
  373. Gitlab
  374. <span class="md-nav__icon md-icon"></span>
  375. </label>
  376. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  377. <label class="md-nav__title" for="__nav_5_8">
  378. <span class="md-nav__icon md-icon"></span>
  379. Gitlab
  380. </label>
  381. <ul class="md-nav__list" data-md-scrollfix>
  382. <li class="md-nav__item">
  383. <a href="provider-gitlab-project-variables/" class="md-nav__link">
  384. Gitlab Project Variables
  385. </a>
  386. </li>
  387. </ul>
  388. </nav>
  389. </li>
  390. <li class="md-nav__item md-nav__item--nested">
  391. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  392. <label class="md-nav__link" for="__nav_5_9">
  393. Oracle
  394. <span class="md-nav__icon md-icon"></span>
  395. </label>
  396. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  397. <label class="md-nav__title" for="__nav_5_9">
  398. <span class="md-nav__icon md-icon"></span>
  399. Oracle
  400. </label>
  401. <ul class="md-nav__list" data-md-scrollfix>
  402. <li class="md-nav__item">
  403. <a href="provider-oracle-vault/" class="md-nav__link">
  404. Oracle Vault
  405. </a>
  406. </li>
  407. </ul>
  408. </nav>
  409. </li>
  410. </ul>
  411. </nav>
  412. </li>
  413. <li class="md-nav__item md-nav__item--nested">
  414. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  415. <label class="md-nav__link" for="__nav_6">
  416. References
  417. <span class="md-nav__icon md-icon"></span>
  418. </label>
  419. <nav class="md-nav" aria-label="References" data-md-level="1">
  420. <label class="md-nav__title" for="__nav_6">
  421. <span class="md-nav__icon md-icon"></span>
  422. References
  423. </label>
  424. <ul class="md-nav__list" data-md-scrollfix>
  425. <li class="md-nav__item">
  426. <a href="spec/" class="md-nav__link">
  427. API specification
  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_7" type="checkbox" id="__nav_7" >
  435. <label class="md-nav__link" for="__nav_7">
  436. Contributing
  437. <span class="md-nav__icon md-icon"></span>
  438. </label>
  439. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  440. <label class="md-nav__title" for="__nav_7">
  441. <span class="md-nav__icon md-icon"></span>
  442. Contributing
  443. </label>
  444. <ul class="md-nav__list" data-md-scrollfix>
  445. <li class="md-nav__item">
  446. <a href="contributing-devguide/" class="md-nav__link">
  447. Developer guide
  448. </a>
  449. </li>
  450. <li class="md-nav__item">
  451. <a href="contributing-process/" class="md-nav__link">
  452. Contributing Process
  453. </a>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="contributing-coc/" class="md-nav__link">
  457. Code of Conduct
  458. </a>
  459. </li>
  460. </ul>
  461. </nav>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="deprecation-policy/" class="md-nav__link">
  465. Deprecation Policy
  466. </a>
  467. </li>
  468. </ul>
  469. </nav>
  470. </div>
  471. </div>
  472. </div>
  473. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  474. <div class="md-sidebar__scrollwrap">
  475. <div class="md-sidebar__inner">
  476. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  477. <label class="md-nav__title" for="__toc">
  478. <span class="md-nav__icon md-icon"></span>
  479. Table of contents
  480. </label>
  481. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  482. <li class="md-nav__item">
  483. <a href="#what-is-the-goal-of-external-secrets-operator" class="md-nav__link">
  484. What is the goal of External Secrets Operator?
  485. </a>
  486. </li>
  487. <li class="md-nav__item">
  488. <a href="#where-to-get-started" class="md-nav__link">
  489. Where to get started
  490. </a>
  491. </li>
  492. <li class="md-nav__item">
  493. <a href="#how-to-get-involved" class="md-nav__link">
  494. How to get involved
  495. </a>
  496. </li>
  497. <li class="md-nav__item">
  498. <a href="#kicked-off-by" class="md-nav__link">
  499. Kicked off by
  500. </a>
  501. </li>
  502. </ul>
  503. </nav>
  504. </div>
  505. </div>
  506. </div>
  507. <div class="md-content" data-md-component="content">
  508. <article class="md-content__inner md-typeset">
  509. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/index.md" title="Edit this page" class="md-content__button md-icon">
  510. <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>
  511. </a>
  512. <h1 id="introduction">Introduction</h1>
  513. <p><img alt="high-level" src="pictures/diagrams-high-level-simple.png" /></p>
  514. <p><strong>External Secrets Operator</strong> is a Kubernetes operator that integrates external
  515. secret management systems like <a href="https://aws.amazon.com/secrets-manager/">AWS Secrets
  516. Manager</a>, <a href="https://www.vaultproject.io/">HashiCorp
  517. Vault</a>, <a href="https://cloud.google.com/secret-manager">Google Secrets
  518. Manager</a>, <a href="https://azure.microsoft.com/en-us/services/key-vault/">Azure Key
  519. Vault</a> and many more. The
  520. operator reads information from external APIs and automatically injects the
  521. values into a <a href="https://kubernetes.io/docs/concepts/configuration/secret/">Kubernetes
  522. Secret</a>.</p>
  523. <h3 id="what-is-the-goal-of-external-secrets-operator">What is the goal of External Secrets Operator?</h3>
  524. <p>The goal of External Secrets Operator is to synchronize secrets from external
  525. APIs into Kubernetes. ESO is a collection of custom API resources -
  526. <code>ExternalSecret</code>, <code>SecretStore</code> and <code>ClusterSecretStore</code> that provide a
  527. user-friendly abstraction for the external API that stores and manages the
  528. lifecycle of the secrets for you.</p>
  529. <h3 id="where-to-get-started">Where to get started</h3>
  530. <p>To get started, please read through <a href="api-overview/">API overview</a> this should
  531. give you a high-level overview to understand the API and use-cases. After that
  532. please follow one of our <a href="guides-introduction/">guides</a> to get a jump start
  533. using the operator.</p>
  534. <p>For a complete reference of the API types please refer to our <a href="spec/">API
  535. Reference</a>.</p>
  536. <h3 id="how-to-get-involved">How to get involved</h3>
  537. <p>This project is driven by it's users and contributors and we welcome everybody
  538. to get involved. Join our meetings, open issues or ask questions in Slack. The
  539. success of this project depends on your input: No contribution is too small -
  540. even opinions matter!</p>
  541. <p>How to get involved:</p>
  542. <ul>
  543. <li>Monthly Meeting: we announce our meetings on slack
  544. (<a href="https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA">agenda</a>)</li>
  545. <li><a href="https://kubernetes.slack.com/messages/external-secrets">Kubernetes Slack
  546. #external-secrets</a></li>
  547. <li><a href="contributing-process/">Contributing Process</a></li>
  548. </ul>
  549. <h3 id="kicked-off-by">Kicked off by</h3>
  550. <p><img alt="cs-logo" src="pictures/cs_logo.png" />
  551. <img alt="godaddy-logo" src="pictures/godaddy_logo.png" /></p>
  552. </article>
  553. </div>
  554. </div>
  555. </main>
  556. <footer class="md-footer">
  557. <nav class="md-footer__inner md-grid" aria-label="Footer">
  558. <a href="api-overview/" class="md-footer__link md-footer__link--next" aria-label="Next: Overview" rel="next">
  559. <div class="md-footer__title">
  560. <div class="md-ellipsis">
  561. <span class="md-footer__direction">
  562. Next
  563. </span>
  564. Overview
  565. </div>
  566. </div>
  567. <div class="md-footer__button md-icon">
  568. <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>
  569. </div>
  570. </a>
  571. </nav>
  572. <div class="md-footer-meta md-typeset">
  573. <div class="md-footer-meta__inner md-grid">
  574. <div class="md-footer-copyright">
  575. Made with
  576. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  577. Material for MkDocs
  578. </a>
  579. </div>
  580. </div>
  581. </div>
  582. </footer>
  583. </div>
  584. <div class="md-dialog" data-md-component="dialog">
  585. <div class="md-dialog__inner md-typeset"></div>
  586. </div>
  587. <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>
  588. <script src="assets/javascripts/bundle.76f349be.min.js"></script>
  589. </body>
  590. </html>