index.html 35 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517
  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. </ul>
  199. </nav>
  200. </li>
  201. <li class="md-nav__item md-nav__item--nested">
  202. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  203. <label class="md-nav__link" for="__nav_4">
  204. Guides
  205. <span class="md-nav__icon md-icon"></span>
  206. </label>
  207. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  208. <label class="md-nav__title" for="__nav_4">
  209. <span class="md-nav__icon md-icon"></span>
  210. Guides
  211. </label>
  212. <ul class="md-nav__list" data-md-scrollfix>
  213. <li class="md-nav__item">
  214. <a href="guides-introduction/" class="md-nav__link">
  215. Introduction
  216. </a>
  217. </li>
  218. <li class="md-nav__item">
  219. <a href="guides-getting-started/" class="md-nav__link">
  220. Getting started
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  225. <label class="md-nav__link" for="__nav_4_3">
  226. Advanced Templating
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_4_3">
  231. <span class="md-nav__icon md-icon"></span>
  232. Advanced Templating
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="guides-templating/" class="md-nav__link">
  237. v2
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="guides-templating-v1/" class="md-nav__link">
  242. v1
  243. </a>
  244. </li>
  245. </ul>
  246. </nav>
  247. </li>
  248. <li class="md-nav__item">
  249. <a href="guides-controller-class/" class="md-nav__link">
  250. Controller Classes
  251. </a>
  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-multi-tenancy/" class="md-nav__link">
  265. Multi Tenancy
  266. </a>
  267. </li>
  268. <li class="md-nav__item">
  269. <a href="guides-metrics/" class="md-nav__link">
  270. Metrics
  271. </a>
  272. </li>
  273. <li class="md-nav__item">
  274. <a href="guides-using-latest-image/" class="md-nav__link">
  275. Using Latest Image
  276. </a>
  277. </li>
  278. </ul>
  279. </nav>
  280. </li>
  281. <li class="md-nav__item md-nav__item--nested">
  282. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  283. <label class="md-nav__link" for="__nav_5">
  284. Provider
  285. <span class="md-nav__icon md-icon"></span>
  286. </label>
  287. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  288. <label class="md-nav__title" for="__nav_5">
  289. <span class="md-nav__icon md-icon"></span>
  290. Provider
  291. </label>
  292. <ul class="md-nav__list" data-md-scrollfix>
  293. <li class="md-nav__item md-nav__item--nested">
  294. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  295. <label class="md-nav__link" for="__nav_5_1">
  296. AWS
  297. <span class="md-nav__icon md-icon"></span>
  298. </label>
  299. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  300. <label class="md-nav__title" for="__nav_5_1">
  301. <span class="md-nav__icon md-icon"></span>
  302. AWS
  303. </label>
  304. <ul class="md-nav__list" data-md-scrollfix>
  305. <li class="md-nav__item">
  306. <a href="provider-aws-secrets-manager/" class="md-nav__link">
  307. Secrets Manager
  308. </a>
  309. </li>
  310. <li class="md-nav__item">
  311. <a href="provider-aws-parameter-store/" class="md-nav__link">
  312. Parameter Store
  313. </a>
  314. </li>
  315. </ul>
  316. </nav>
  317. </li>
  318. <li class="md-nav__item md-nav__item--nested">
  319. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  320. <label class="md-nav__link" for="__nav_5_2">
  321. Azure
  322. <span class="md-nav__icon md-icon"></span>
  323. </label>
  324. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  325. <label class="md-nav__title" for="__nav_5_2">
  326. <span class="md-nav__icon md-icon"></span>
  327. Azure
  328. </label>
  329. <ul class="md-nav__list" data-md-scrollfix>
  330. <li class="md-nav__item">
  331. <a href="provider-azure-key-vault/" class="md-nav__link">
  332. Key Vault
  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_3" type="checkbox" id="__nav_5_3" >
  340. <label class="md-nav__link" for="__nav_5_3">
  341. Google
  342. <span class="md-nav__icon md-icon"></span>
  343. </label>
  344. <nav class="md-nav" aria-label="Google" data-md-level="2">
  345. <label class="md-nav__title" for="__nav_5_3">
  346. <span class="md-nav__icon md-icon"></span>
  347. Google
  348. </label>
  349. <ul class="md-nav__list" data-md-scrollfix>
  350. <li class="md-nav__item">
  351. <a href="provider-google-secrets-manager/" class="md-nav__link">
  352. Secret Manager
  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_4" type="checkbox" id="__nav_5_4" >
  360. <label class="md-nav__link" for="__nav_5_4">
  361. IBM
  362. <span class="md-nav__icon md-icon"></span>
  363. </label>
  364. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  365. <label class="md-nav__title" for="__nav_5_4">
  366. <span class="md-nav__icon md-icon"></span>
  367. IBM
  368. </label>
  369. <ul class="md-nav__list" data-md-scrollfix>
  370. <li class="md-nav__item">
  371. <a href="provider-ibm-secrets-manager/" class="md-nav__link">
  372. Secrets Manager
  373. </a>
  374. </li>
  375. </ul>
  376. </nav>
  377. </li>
  378. <li class="md-nav__item">
  379. <a href="provider-akeyless/" class="md-nav__link">
  380. Akeyless
  381. </a>
  382. </li>
  383. <li class="md-nav__item">
  384. <a href="provider-hashicorp-vault/" class="md-nav__link">
  385. HashiCorp Vault
  386. </a>
  387. </li>
  388. <li class="md-nav__item md-nav__item--nested">
  389. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  390. <label class="md-nav__link" for="__nav_5_7">
  391. Yandex
  392. <span class="md-nav__icon md-icon"></span>
  393. </label>
  394. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  395. <label class="md-nav__title" for="__nav_5_7">
  396. <span class="md-nav__icon md-icon"></span>
  397. Yandex
  398. </label>
  399. <ul class="md-nav__list" data-md-scrollfix>
  400. <li class="md-nav__item">
  401. <a href="provider-yandex-lockbox/" class="md-nav__link">
  402. Lockbox
  403. </a>
  404. </li>
  405. </ul>
  406. </nav>
  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_8" type="checkbox" id="__nav_5_8" >
  410. <label class="md-nav__link" for="__nav_5_8">
  411. Gitlab
  412. <span class="md-nav__icon md-icon"></span>
  413. </label>
  414. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  415. <label class="md-nav__title" for="__nav_5_8">
  416. <span class="md-nav__icon md-icon"></span>
  417. Gitlab
  418. </label>
  419. <ul class="md-nav__list" data-md-scrollfix>
  420. <li class="md-nav__item">
  421. <a href="provider-gitlab-project-variables/" class="md-nav__link">
  422. Gitlab Project Variables
  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_9" type="checkbox" id="__nav_5_9" >
  430. <label class="md-nav__link" for="__nav_5_9">
  431. Oracle
  432. <span class="md-nav__icon md-icon"></span>
  433. </label>
  434. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  435. <label class="md-nav__title" for="__nav_5_9">
  436. <span class="md-nav__icon md-icon"></span>
  437. Oracle
  438. </label>
  439. <ul class="md-nav__list" data-md-scrollfix>
  440. <li class="md-nav__item">
  441. <a href="provider-oracle-vault/" class="md-nav__link">
  442. Oracle Vault
  443. </a>
  444. </li>
  445. </ul>
  446. </nav>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="provider-webhook/" class="md-nav__link">
  450. Webhook
  451. </a>
  452. </li>
  453. <li class="md-nav__item">
  454. <a href="provider-fake/" class="md-nav__link">
  455. Fake
  456. </a>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="provider-kubernetes/" class="md-nav__link">
  460. Kubernetes
  461. </a>
  462. </li>
  463. </ul>
  464. </nav>
  465. </li>
  466. <li class="md-nav__item md-nav__item--nested">
  467. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  468. <label class="md-nav__link" for="__nav_6">
  469. Examples
  470. <span class="md-nav__icon md-icon"></span>
  471. </label>
  472. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  473. <label class="md-nav__title" for="__nav_6">
  474. <span class="md-nav__icon md-icon"></span>
  475. Examples
  476. </label>
  477. <ul class="md-nav__list" data-md-scrollfix>
  478. <li class="md-nav__item">
  479. <a href="examples-gitops-using-fluxcd/" class="md-nav__link">
  480. FluxCD
  481. </a>
  482. </li>
  483. <li class="md-nav__item">
  484. <a href="examples-anchore-engine-credentials/" class="md-nav__link">
  485. Anchore Engine
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  490. Jenkins
  491. </a>
  492. </li>
  493. </ul>
  494. </nav>
  495. </li>
  496. <li class="md-nav__item md-nav__item--nested">
  497. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  498. <label class="md-nav__link" for="__nav_7">
  499. External Resources
  500. <span class="md-nav__icon md-icon"></span>
  501. </label>
  502. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  503. <label class="md-nav__title" for="__nav_7">
  504. <span class="md-nav__icon md-icon"></span>
  505. External Resources
  506. </label>
  507. <ul class="md-nav__list" data-md-scrollfix>
  508. <li class="md-nav__item">
  509. <a href="eso-talks/" class="md-nav__link">
  510. Talks
  511. </a>
  512. </li>
  513. <li class="md-nav__item">
  514. <a href="eso-demos/" class="md-nav__link">
  515. Demos
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="eso-blogs/" class="md-nav__link">
  520. Blogs
  521. </a>
  522. </li>
  523. </ul>
  524. </nav>
  525. </li>
  526. <li class="md-nav__item md-nav__item--nested">
  527. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  528. <label class="md-nav__link" for="__nav_8">
  529. References
  530. <span class="md-nav__icon md-icon"></span>
  531. </label>
  532. <nav class="md-nav" aria-label="References" data-md-level="1">
  533. <label class="md-nav__title" for="__nav_8">
  534. <span class="md-nav__icon md-icon"></span>
  535. References
  536. </label>
  537. <ul class="md-nav__list" data-md-scrollfix>
  538. <li class="md-nav__item">
  539. <a href="spec/" class="md-nav__link">
  540. API specification
  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_9" type="checkbox" id="__nav_9" >
  548. <label class="md-nav__link" for="__nav_9">
  549. Contributing
  550. <span class="md-nav__icon md-icon"></span>
  551. </label>
  552. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  553. <label class="md-nav__title" for="__nav_9">
  554. <span class="md-nav__icon md-icon"></span>
  555. Contributing
  556. </label>
  557. <ul class="md-nav__list" data-md-scrollfix>
  558. <li class="md-nav__item">
  559. <a href="contributing-devguide/" class="md-nav__link">
  560. Developer guide
  561. </a>
  562. </li>
  563. <li class="md-nav__item">
  564. <a href="contributing-process/" class="md-nav__link">
  565. Contributing Process
  566. </a>
  567. </li>
  568. <li class="md-nav__item">
  569. <a href="contributing-release/" class="md-nav__link">
  570. Release Process
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="contributing-coc/" class="md-nav__link">
  575. Code of Conduct
  576. </a>
  577. </li>
  578. </ul>
  579. </nav>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="deprecation-policy/" class="md-nav__link">
  583. Deprecation Policy
  584. </a>
  585. </li>
  586. </ul>
  587. </nav>
  588. </div>
  589. </div>
  590. </div>
  591. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  592. <div class="md-sidebar__scrollwrap">
  593. <div class="md-sidebar__inner">
  594. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  595. <label class="md-nav__title" for="__toc">
  596. <span class="md-nav__icon md-icon"></span>
  597. Table of contents
  598. </label>
  599. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  600. <li class="md-nav__item">
  601. <a href="#what-is-the-goal-of-external-secrets-operator" class="md-nav__link">
  602. What is the goal of External Secrets Operator?
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="#where-to-get-started" class="md-nav__link">
  607. Where to get started
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="#how-to-get-involved" class="md-nav__link">
  612. How to get involved
  613. </a>
  614. </li>
  615. <li class="md-nav__item">
  616. <a href="#kicked-off-by" class="md-nav__link">
  617. Kicked off by
  618. </a>
  619. </li>
  620. </ul>
  621. </nav>
  622. </div>
  623. </div>
  624. </div>
  625. <div class="md-content" data-md-component="content">
  626. <article class="md-content__inner md-typeset">
  627. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/index.md" title="Edit this page" class="md-content__button md-icon">
  628. <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>
  629. </a>
  630. <h1 id="introduction">Introduction</h1>
  631. <p><img alt="high-level" src="pictures/diagrams-high-level-simple.png" /></p>
  632. <p><strong>External Secrets Operator</strong> is a Kubernetes operator that integrates external
  633. secret management systems like <a href="https://aws.amazon.com/secrets-manager/">AWS Secrets
  634. Manager</a>, <a href="https://www.vaultproject.io/">HashiCorp
  635. Vault</a>, <a href="https://cloud.google.com/secret-manager">Google Secrets
  636. Manager</a>, <a href="https://azure.microsoft.com/en-us/services/key-vault/">Azure Key
  637. Vault</a> and many more. The
  638. operator reads information from external APIs and automatically injects the
  639. values into a <a href="https://kubernetes.io/docs/concepts/configuration/secret/">Kubernetes
  640. Secret</a>.</p>
  641. <h3 id="what-is-the-goal-of-external-secrets-operator">What is the goal of External Secrets Operator?</h3>
  642. <p>The goal of External Secrets Operator is to synchronize secrets from external
  643. APIs into Kubernetes. ESO is a collection of custom API resources -
  644. <code>ExternalSecret</code>, <code>SecretStore</code> and <code>ClusterSecretStore</code> that provide a
  645. user-friendly abstraction for the external API that stores and manages the
  646. lifecycle of the secrets for you.</p>
  647. <h3 id="where-to-get-started">Where to get started</h3>
  648. <p>To get started, please read through <a href="api-overview/">API overview</a> this should
  649. give you a high-level overview to understand the API and use-cases. After that
  650. please follow one of our <a href="guides-introduction/">guides</a> to get a jump start
  651. using the operator. See our <a href="guides-getting-started/">getting started guide</a> for installation instructions.</p>
  652. <p>For a complete reference of the API types please refer to our <a href="spec/">API
  653. Reference</a>.</p>
  654. <h3 id="how-to-get-involved">How to get involved</h3>
  655. <p>This project is driven by it's users and contributors and we welcome everybody
  656. to get involved. Join our meetings, open issues or ask questions in Slack. The
  657. success of this project depends on your input: No contribution is too small -
  658. even opinions matter!</p>
  659. <p>How to get involved:</p>
  660. <ul>
  661. <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>
  662. (<a href="https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA">agenda</a>, <a href="https://meet.jit.si/SurroundingContentionsImportSubsequently">jitsi call</a>)</li>
  663. <li><a href="https://kubernetes.slack.com/messages/external-secrets">Kubernetes Slack
  664. #external-secrets</a></li>
  665. <li><a href="contributing-process/">Contributing Process</a></li>
  666. </ul>
  667. <h3 id="kicked-off-by">Kicked off by</h3>
  668. <p><img alt="cs-logo" src="pictures/cs_logo.png" />
  669. <img alt="godaddy-logo" src="pictures/godaddy_logo.png" /></p>
  670. </article>
  671. </div>
  672. </div>
  673. </main>
  674. <footer class="md-footer">
  675. <nav class="md-footer__inner md-grid" aria-label="Footer">
  676. <a href="api-overview/" class="md-footer__link md-footer__link--next" aria-label="Next: Overview" rel="next">
  677. <div class="md-footer__title">
  678. <div class="md-ellipsis">
  679. <span class="md-footer__direction">
  680. Next
  681. </span>
  682. Overview
  683. </div>
  684. </div>
  685. <div class="md-footer__button md-icon">
  686. <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>
  687. </div>
  688. </a>
  689. </nav>
  690. <div class="md-footer-meta md-typeset">
  691. <div class="md-footer-meta__inner md-grid">
  692. <div class="md-copyright">
  693. Made with
  694. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  695. Material for MkDocs
  696. </a>
  697. </div>
  698. </div>
  699. </div>
  700. </footer>
  701. </div>
  702. <div class="md-dialog" data-md-component="dialog">
  703. <div class="md-dialog__inner md-typeset"></div>
  704. </div>
  705. <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>
  706. <script src="assets/javascripts/bundle.e3b2bf44.min.js"></script>
  707. </body>
  708. </html>