index.html 36 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573
  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.2.3, mkdocs-material-8.1.10">
  8. <title>External Secrets Operator</title>
  9. <link rel="stylesheet" href="assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="assets/stylesheets/palette.e6a45f82.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:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL(".",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  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. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../.">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href="." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <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>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. Introduction
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <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>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <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" required>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <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>
  72. <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>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <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>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <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>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href="." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <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>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <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>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item md-nav__item--active">
  129. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  130. <label class="md-nav__link md-nav__link--active" for="__toc">
  131. Introduction
  132. <span class="md-nav__icon md-icon"></span>
  133. </label>
  134. <a href="." class="md-nav__link md-nav__link--active">
  135. Introduction
  136. </a>
  137. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  138. <label class="md-nav__title" for="__toc">
  139. <span class="md-nav__icon md-icon"></span>
  140. Table of contents
  141. </label>
  142. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  143. <li class="md-nav__item">
  144. <a href="#what-is-the-goal-of-external-secrets-operator" class="md-nav__link">
  145. What is the goal of External Secrets Operator?
  146. </a>
  147. </li>
  148. <li class="md-nav__item">
  149. <a href="#where-to-get-started" class="md-nav__link">
  150. Where to get started
  151. </a>
  152. </li>
  153. <li class="md-nav__item">
  154. <a href="#how-to-get-involved" class="md-nav__link">
  155. How to get involved
  156. </a>
  157. </li>
  158. <li class="md-nav__item">
  159. <a href="#kicked-off-by" class="md-nav__link">
  160. Kicked off by
  161. </a>
  162. </li>
  163. </ul>
  164. </nav>
  165. </li>
  166. <li class="md-nav__item">
  167. <a href="api-overview/" class="md-nav__link">
  168. Overview
  169. </a>
  170. </li>
  171. <li class="md-nav__item md-nav__item--nested">
  172. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  173. <label class="md-nav__link" for="__nav_3">
  174. API Types
  175. <span class="md-nav__icon md-icon"></span>
  176. </label>
  177. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  178. <label class="md-nav__title" for="__nav_3">
  179. <span class="md-nav__icon md-icon"></span>
  180. API Types
  181. </label>
  182. <ul class="md-nav__list" data-md-scrollfix>
  183. <li class="md-nav__item">
  184. <a href="api-externalsecret/" class="md-nav__link">
  185. ExternalSecret
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="api-secretstore/" class="md-nav__link">
  190. SecretStore
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="api-clustersecretstore/" class="md-nav__link">
  195. ClusterSecretStore
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="api-clusterexternalsecret/" class="md-nav__link">
  200. ClusterExternalSecret
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  208. <label class="md-nav__link" for="__nav_4">
  209. Guides
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_4">
  214. <span class="md-nav__icon md-icon"></span>
  215. Guides
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="guides-introduction/" class="md-nav__link">
  220. Introduction
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="guides-getting-started/" class="md-nav__link">
  225. Getting started
  226. </a>
  227. </li>
  228. <li class="md-nav__item md-nav__item--nested">
  229. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  230. <label class="md-nav__link" for="__nav_4_3">
  231. Advanced Templating
  232. <span class="md-nav__icon md-icon"></span>
  233. </label>
  234. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  235. <label class="md-nav__title" for="__nav_4_3">
  236. <span class="md-nav__icon md-icon"></span>
  237. Advanced Templating
  238. </label>
  239. <ul class="md-nav__list" data-md-scrollfix>
  240. <li class="md-nav__item">
  241. <a href="guides-templating/" class="md-nav__link">
  242. v2
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="guides-templating-v1/" class="md-nav__link">
  247. v1
  248. </a>
  249. </li>
  250. </ul>
  251. </nav>
  252. </li>
  253. <li class="md-nav__item">
  254. <a href="guides-all-keys-one-secret/" class="md-nav__link">
  255. All keys, One secret
  256. </a>
  257. </li>
  258. <li class="md-nav__item">
  259. <a href="guides-common-k8s-secret-types/" class="md-nav__link">
  260. Common K8S Secret Types
  261. </a>
  262. </li>
  263. <li class="md-nav__item">
  264. <a href="guides-controller-class/" class="md-nav__link">
  265. Controller Classes
  266. </a>
  267. </li>
  268. <li class="md-nav__item">
  269. <a href="guides-ownership-deletion-policy/" class="md-nav__link">
  270. Lifecycle: ownership & deletion
  271. </a>
  272. </li>
  273. <li class="md-nav__item">
  274. <a href="guides-getallsecrets/" class="md-nav__link">
  275. Getting Multiple Secrets
  276. </a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="guides-multi-tenancy/" class="md-nav__link">
  280. Multi Tenancy
  281. </a>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="guides-metrics/" class="md-nav__link">
  285. Metrics
  286. </a>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="guides-v1beta1/" class="md-nav__link">
  290. Upgrading to v1beta1
  291. </a>
  292. </li>
  293. <li class="md-nav__item">
  294. <a href="guides-using-latest-image/" class="md-nav__link">
  295. Using Latest Image
  296. </a>
  297. </li>
  298. </ul>
  299. </nav>
  300. </li>
  301. <li class="md-nav__item md-nav__item--nested">
  302. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  303. <label class="md-nav__link" for="__nav_5">
  304. Provider
  305. <span class="md-nav__icon md-icon"></span>
  306. </label>
  307. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  308. <label class="md-nav__title" for="__nav_5">
  309. <span class="md-nav__icon md-icon"></span>
  310. Provider
  311. </label>
  312. <ul class="md-nav__list" data-md-scrollfix>
  313. <li class="md-nav__item md-nav__item--nested">
  314. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  315. <label class="md-nav__link" for="__nav_5_1">
  316. AWS
  317. <span class="md-nav__icon md-icon"></span>
  318. </label>
  319. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  320. <label class="md-nav__title" for="__nav_5_1">
  321. <span class="md-nav__icon md-icon"></span>
  322. AWS
  323. </label>
  324. <ul class="md-nav__list" data-md-scrollfix>
  325. <li class="md-nav__item">
  326. <a href="provider-aws-secrets-manager/" class="md-nav__link">
  327. Secrets Manager
  328. </a>
  329. </li>
  330. <li class="md-nav__item">
  331. <a href="provider-aws-parameter-store/" class="md-nav__link">
  332. Parameter Store
  333. </a>
  334. </li>
  335. </ul>
  336. </nav>
  337. </li>
  338. <li class="md-nav__item md-nav__item--nested">
  339. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  340. <label class="md-nav__link" for="__nav_5_2">
  341. Azure
  342. <span class="md-nav__icon md-icon"></span>
  343. </label>
  344. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  345. <label class="md-nav__title" for="__nav_5_2">
  346. <span class="md-nav__icon md-icon"></span>
  347. Azure
  348. </label>
  349. <ul class="md-nav__list" data-md-scrollfix>
  350. <li class="md-nav__item">
  351. <a href="provider-azure-key-vault/" class="md-nav__link">
  352. Key Vault
  353. </a>
  354. </li>
  355. </ul>
  356. </nav>
  357. </li>
  358. <li class="md-nav__item md-nav__item--nested">
  359. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  360. <label class="md-nav__link" for="__nav_5_3">
  361. Google
  362. <span class="md-nav__icon md-icon"></span>
  363. </label>
  364. <nav class="md-nav" aria-label="Google" data-md-level="2">
  365. <label class="md-nav__title" for="__nav_5_3">
  366. <span class="md-nav__icon md-icon"></span>
  367. Google
  368. </label>
  369. <ul class="md-nav__list" data-md-scrollfix>
  370. <li class="md-nav__item">
  371. <a href="provider-google-secrets-manager/" class="md-nav__link">
  372. Secret Manager
  373. </a>
  374. </li>
  375. </ul>
  376. </nav>
  377. </li>
  378. <li class="md-nav__item md-nav__item--nested">
  379. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  380. <label class="md-nav__link" for="__nav_5_4">
  381. IBM
  382. <span class="md-nav__icon md-icon"></span>
  383. </label>
  384. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  385. <label class="md-nav__title" for="__nav_5_4">
  386. <span class="md-nav__icon md-icon"></span>
  387. IBM
  388. </label>
  389. <ul class="md-nav__list" data-md-scrollfix>
  390. <li class="md-nav__item">
  391. <a href="provider-ibm-secrets-manager/" class="md-nav__link">
  392. Secrets Manager
  393. </a>
  394. </li>
  395. </ul>
  396. </nav>
  397. </li>
  398. <li class="md-nav__item">
  399. <a href="provider-akeyless/" class="md-nav__link">
  400. Akeyless
  401. </a>
  402. </li>
  403. <li class="md-nav__item">
  404. <a href="provider-hashicorp-vault/" class="md-nav__link">
  405. HashiCorp Vault
  406. </a>
  407. </li>
  408. <li class="md-nav__item md-nav__item--nested">
  409. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  410. <label class="md-nav__link" for="__nav_5_7">
  411. Yandex
  412. <span class="md-nav__icon md-icon"></span>
  413. </label>
  414. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  415. <label class="md-nav__title" for="__nav_5_7">
  416. <span class="md-nav__icon md-icon"></span>
  417. Yandex
  418. </label>
  419. <ul class="md-nav__list" data-md-scrollfix>
  420. <li class="md-nav__item">
  421. <a href="provider-yandex-lockbox/" class="md-nav__link">
  422. Lockbox
  423. </a>
  424. </li>
  425. </ul>
  426. </nav>
  427. </li>
  428. <li class="md-nav__item md-nav__item--nested">
  429. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  430. <label class="md-nav__link" for="__nav_5_8">
  431. Gitlab
  432. <span class="md-nav__icon md-icon"></span>
  433. </label>
  434. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  435. <label class="md-nav__title" for="__nav_5_8">
  436. <span class="md-nav__icon md-icon"></span>
  437. Gitlab
  438. </label>
  439. <ul class="md-nav__list" data-md-scrollfix>
  440. <li class="md-nav__item">
  441. <a href="provider-gitlab-project-variables/" class="md-nav__link">
  442. Gitlab Project Variables
  443. </a>
  444. </li>
  445. </ul>
  446. </nav>
  447. </li>
  448. <li class="md-nav__item md-nav__item--nested">
  449. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  450. <label class="md-nav__link" for="__nav_5_9">
  451. Oracle
  452. <span class="md-nav__icon md-icon"></span>
  453. </label>
  454. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  455. <label class="md-nav__title" for="__nav_5_9">
  456. <span class="md-nav__icon md-icon"></span>
  457. Oracle
  458. </label>
  459. <ul class="md-nav__list" data-md-scrollfix>
  460. <li class="md-nav__item">
  461. <a href="provider-oracle-vault/" class="md-nav__link">
  462. Oracle Vault
  463. </a>
  464. </li>
  465. </ul>
  466. </nav>
  467. </li>
  468. <li class="md-nav__item">
  469. <a href="provider-webhook/" class="md-nav__link">
  470. Webhook
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="provider-fake/" class="md-nav__link">
  475. Fake
  476. </a>
  477. </li>
  478. <li class="md-nav__item">
  479. <a href="provider-kubernetes/" class="md-nav__link">
  480. Kubernetes
  481. </a>
  482. </li>
  483. </ul>
  484. </nav>
  485. </li>
  486. <li class="md-nav__item md-nav__item--nested">
  487. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  488. <label class="md-nav__link" for="__nav_6">
  489. Examples
  490. <span class="md-nav__icon md-icon"></span>
  491. </label>
  492. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  493. <label class="md-nav__title" for="__nav_6">
  494. <span class="md-nav__icon md-icon"></span>
  495. Examples
  496. </label>
  497. <ul class="md-nav__list" data-md-scrollfix>
  498. <li class="md-nav__item">
  499. <a href="examples-gitops-using-fluxcd/" class="md-nav__link">
  500. FluxCD
  501. </a>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="examples-anchore-engine-credentials/" class="md-nav__link">
  505. Anchore Engine
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  510. Jenkins
  511. </a>
  512. </li>
  513. </ul>
  514. </nav>
  515. </li>
  516. <li class="md-nav__item md-nav__item--nested">
  517. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  518. <label class="md-nav__link" for="__nav_7">
  519. External Resources
  520. <span class="md-nav__icon md-icon"></span>
  521. </label>
  522. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  523. <label class="md-nav__title" for="__nav_7">
  524. <span class="md-nav__icon md-icon"></span>
  525. External Resources
  526. </label>
  527. <ul class="md-nav__list" data-md-scrollfix>
  528. <li class="md-nav__item">
  529. <a href="eso-talks/" class="md-nav__link">
  530. Talks
  531. </a>
  532. </li>
  533. <li class="md-nav__item">
  534. <a href="eso-demos/" class="md-nav__link">
  535. Demos
  536. </a>
  537. </li>
  538. <li class="md-nav__item">
  539. <a href="eso-blogs/" class="md-nav__link">
  540. Blogs
  541. </a>
  542. </li>
  543. </ul>
  544. </nav>
  545. </li>
  546. <li class="md-nav__item md-nav__item--nested">
  547. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  548. <label class="md-nav__link" for="__nav_8">
  549. References
  550. <span class="md-nav__icon md-icon"></span>
  551. </label>
  552. <nav class="md-nav" aria-label="References" data-md-level="1">
  553. <label class="md-nav__title" for="__nav_8">
  554. <span class="md-nav__icon md-icon"></span>
  555. References
  556. </label>
  557. <ul class="md-nav__list" data-md-scrollfix>
  558. <li class="md-nav__item">
  559. <a href="spec/" class="md-nav__link">
  560. API specification
  561. </a>
  562. </li>
  563. </ul>
  564. </nav>
  565. </li>
  566. <li class="md-nav__item md-nav__item--nested">
  567. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  568. <label class="md-nav__link" for="__nav_9">
  569. Contributing
  570. <span class="md-nav__icon md-icon"></span>
  571. </label>
  572. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  573. <label class="md-nav__title" for="__nav_9">
  574. <span class="md-nav__icon md-icon"></span>
  575. Contributing
  576. </label>
  577. <ul class="md-nav__list" data-md-scrollfix>
  578. <li class="md-nav__item">
  579. <a href="contributing-devguide/" class="md-nav__link">
  580. Developer guide
  581. </a>
  582. </li>
  583. <li class="md-nav__item">
  584. <a href="contributing-process/" class="md-nav__link">
  585. Contributing Process
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="contributing-release/" class="md-nav__link">
  590. Release Process
  591. </a>
  592. </li>
  593. <li class="md-nav__item">
  594. <a href="contributing-coc/" class="md-nav__link">
  595. Code of Conduct
  596. </a>
  597. </li>
  598. </ul>
  599. </nav>
  600. </li>
  601. <li class="md-nav__item">
  602. <a href="deprecation-policy/" class="md-nav__link">
  603. Deprecation Policy
  604. </a>
  605. </li>
  606. </ul>
  607. </nav>
  608. </div>
  609. </div>
  610. </div>
  611. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  612. <div class="md-sidebar__scrollwrap">
  613. <div class="md-sidebar__inner">
  614. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  615. <label class="md-nav__title" for="__toc">
  616. <span class="md-nav__icon md-icon"></span>
  617. Table of contents
  618. </label>
  619. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  620. <li class="md-nav__item">
  621. <a href="#what-is-the-goal-of-external-secrets-operator" class="md-nav__link">
  622. What is the goal of External Secrets Operator?
  623. </a>
  624. </li>
  625. <li class="md-nav__item">
  626. <a href="#where-to-get-started" class="md-nav__link">
  627. Where to get started
  628. </a>
  629. </li>
  630. <li class="md-nav__item">
  631. <a href="#how-to-get-involved" class="md-nav__link">
  632. How to get involved
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="#kicked-off-by" class="md-nav__link">
  637. Kicked off by
  638. </a>
  639. </li>
  640. </ul>
  641. </nav>
  642. </div>
  643. </div>
  644. </div>
  645. <div class="md-content" data-md-component="content">
  646. <article class="md-content__inner md-typeset">
  647. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/index.md" title="Edit this page" class="md-content__button md-icon">
  648. <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>
  649. </a>
  650. <h1 id="introduction">Introduction</h1>
  651. <p><img alt="high-level" src="pictures/diagrams-high-level-simple.png" /></p>
  652. <p><strong>External Secrets Operator</strong> is a Kubernetes operator that integrates external
  653. secret management systems like <a href="https://aws.amazon.com/secrets-manager/">AWS Secrets
  654. Manager</a>, <a href="https://www.vaultproject.io/">HashiCorp
  655. Vault</a>, <a href="https://cloud.google.com/secret-manager">Google Secrets
  656. Manager</a>, <a href="https://azure.microsoft.com/en-us/services/key-vault/">Azure Key
  657. Vault</a> and many more. The
  658. operator reads information from external APIs and automatically injects the
  659. values into a <a href="https://kubernetes.io/docs/concepts/configuration/secret/">Kubernetes
  660. Secret</a>.</p>
  661. <h3 id="what-is-the-goal-of-external-secrets-operator">What is the goal of External Secrets Operator?</h3>
  662. <p>The goal of External Secrets Operator is to synchronize secrets from external
  663. APIs into Kubernetes. ESO is a collection of custom API resources -
  664. <code>ExternalSecret</code>, <code>SecretStore</code> and <code>ClusterSecretStore</code> that provide a
  665. user-friendly abstraction for the external API that stores and manages the
  666. lifecycle of the secrets for you.</p>
  667. <h3 id="where-to-get-started">Where to get started</h3>
  668. <p>To get started, please read through <a href="api-overview/">API overview</a> this should
  669. give you a high-level overview to understand the API and use-cases. After that
  670. please follow one of our <a href="guides-introduction/">guides</a> to get a jump start
  671. using the operator. See our <a href="guides-getting-started/">getting started guide</a> for installation instructions.</p>
  672. <p>For a complete reference of the API types please refer to our <a href="spec/">API
  673. Reference</a>.</p>
  674. <h3 id="how-to-get-involved">How to get involved</h3>
  675. <p>This project is driven by it's users and contributors and we welcome everybody
  676. to get involved. Join our meetings, open issues or ask questions in Slack. The
  677. success of this project depends on your input: No contribution is too small -
  678. even opinions matter!</p>
  679. <p>How to get involved:</p>
  680. <ul>
  681. <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>
  682. (<a href="https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA">agenda</a>, <a href="https://meet.jit.si/SurroundingContentionsImportSubsequently">jitsi call</a>)</li>
  683. <li><a href="https://kubernetes.slack.com/messages/external-secrets">Kubernetes Slack
  684. #external-secrets</a></li>
  685. <li><a href="contributing-process/">Contributing Process</a></li>
  686. </ul>
  687. <h3 id="kicked-off-by">Kicked off by</h3>
  688. <p><img alt="cs-logo" src="pictures/cs_logo.png" />
  689. <img alt="godaddy-logo" src="pictures/godaddy_logo.png" /></p>
  690. </article>
  691. </div>
  692. </div>
  693. </main>
  694. <footer class="md-footer">
  695. <nav class="md-footer__inner md-grid" aria-label="Footer">
  696. <a href="api-overview/" class="md-footer__link md-footer__link--next" aria-label="Next: Overview" rel="next">
  697. <div class="md-footer__title">
  698. <div class="md-ellipsis">
  699. <span class="md-footer__direction">
  700. Next
  701. </span>
  702. Overview
  703. </div>
  704. </div>
  705. <div class="md-footer__button md-icon">
  706. <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>
  707. </div>
  708. </a>
  709. </nav>
  710. <div class="md-footer-meta md-typeset">
  711. <div class="md-footer-meta__inner md-grid">
  712. <div class="md-copyright">
  713. Made with
  714. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  715. Material for MkDocs
  716. </a>
  717. </div>
  718. </div>
  719. </div>
  720. </footer>
  721. </div>
  722. <div class="md-dialog" data-md-component="dialog">
  723. <div class="md-dialog__inner md-typeset"></div>
  724. </div>
  725. <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.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  726. <script src="assets/javascripts/bundle.e3b2bf44.min.js"></script>
  727. </body>
  728. </html>