index.html 27 KB

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