index.html 40 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793
  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. <li class="md-nav__item">
  164. <a href="#sponsored-by" class="md-nav__link">
  165. Sponsored by
  166. </a>
  167. </li>
  168. </ul>
  169. </nav>
  170. </li>
  171. <li class="md-nav__item">
  172. <a href="overview/" class="md-nav__link">
  173. Overview
  174. </a>
  175. </li>
  176. <li class="md-nav__item md-nav__item--nested">
  177. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  178. <label class="md-nav__link" for="__nav_3">
  179. API Types
  180. <span class="md-nav__icon md-icon"></span>
  181. </label>
  182. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  183. <label class="md-nav__title" for="__nav_3">
  184. <span class="md-nav__icon md-icon"></span>
  185. API Types
  186. </label>
  187. <ul class="md-nav__list" data-md-scrollfix>
  188. <li class="md-nav__item">
  189. <a href="api/externalsecret/" class="md-nav__link">
  190. ExternalSecret
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="api/secretstore/" class="md-nav__link">
  195. SecretStore
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="api/clustersecretstore/" class="md-nav__link">
  200. ClusterSecretStore
  201. </a>
  202. </li>
  203. <li class="md-nav__item">
  204. <a href="api/clusterexternalsecret/" class="md-nav__link">
  205. ClusterExternalSecret
  206. </a>
  207. </li>
  208. </ul>
  209. </nav>
  210. </li>
  211. <li class="md-nav__item md-nav__item--nested">
  212. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  213. <label class="md-nav__link" for="__nav_4">
  214. Guides
  215. <span class="md-nav__icon md-icon"></span>
  216. </label>
  217. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  218. <label class="md-nav__title" for="__nav_4">
  219. <span class="md-nav__icon md-icon"></span>
  220. Guides
  221. </label>
  222. <ul class="md-nav__list" data-md-scrollfix>
  223. <li class="md-nav__item">
  224. <a href="guides/introduction/" class="md-nav__link">
  225. Introduction
  226. </a>
  227. </li>
  228. <li class="md-nav__item">
  229. <a href="guides/getting-started/" class="md-nav__link">
  230. Getting started
  231. </a>
  232. </li>
  233. <li class="md-nav__item md-nav__item--nested">
  234. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  235. <label class="md-nav__link" for="__nav_4_3">
  236. Advanced Templating
  237. <span class="md-nav__icon md-icon"></span>
  238. </label>
  239. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  240. <label class="md-nav__title" for="__nav_4_3">
  241. <span class="md-nav__icon md-icon"></span>
  242. Advanced Templating
  243. </label>
  244. <ul class="md-nav__list" data-md-scrollfix>
  245. <li class="md-nav__item">
  246. <a href="guides/templating/" class="md-nav__link">
  247. v2
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="guides/templating-v1/" class="md-nav__link">
  252. v1
  253. </a>
  254. </li>
  255. </ul>
  256. </nav>
  257. </li>
  258. <li class="md-nav__item">
  259. <a href="guides/all-keys-one-secret/" class="md-nav__link">
  260. All keys, One secret
  261. </a>
  262. </li>
  263. <li class="md-nav__item">
  264. <a href="guides/common-k8s-secret-types/" class="md-nav__link">
  265. Common K8S Secret Types
  266. </a>
  267. </li>
  268. <li class="md-nav__item">
  269. <a href="guides/controller-class/" class="md-nav__link">
  270. Controller Classes
  271. </a>
  272. </li>
  273. <li class="md-nav__item">
  274. <a href="guides/ownership-deletion-policy/" class="md-nav__link">
  275. Lifecycle: ownership & deletion
  276. </a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="guides/decoding-strategy/" class="md-nav__link">
  280. Decoding Strategies
  281. </a>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="guides/getallsecrets/" class="md-nav__link">
  285. Getting Multiple Secrets
  286. </a>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="guides/multi-tenancy/" class="md-nav__link">
  290. Multi Tenancy
  291. </a>
  292. </li>
  293. <li class="md-nav__item">
  294. <a href="guides/metrics/" class="md-nav__link">
  295. Metrics
  296. </a>
  297. </li>
  298. <li class="md-nav__item">
  299. <a href="guides/datafrom-rewrite/" class="md-nav__link">
  300. Rewriting Keys
  301. </a>
  302. </li>
  303. <li class="md-nav__item">
  304. <a href="guides/v1beta1/" class="md-nav__link">
  305. Upgrading to v1beta1
  306. </a>
  307. </li>
  308. <li class="md-nav__item">
  309. <a href="guides/using-latest-image/" class="md-nav__link">
  310. Using Latest Image
  311. </a>
  312. </li>
  313. </ul>
  314. </nav>
  315. </li>
  316. <li class="md-nav__item md-nav__item--nested">
  317. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  318. <label class="md-nav__link" for="__nav_5">
  319. Provider
  320. <span class="md-nav__icon md-icon"></span>
  321. </label>
  322. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  323. <label class="md-nav__title" for="__nav_5">
  324. <span class="md-nav__icon md-icon"></span>
  325. Provider
  326. </label>
  327. <ul class="md-nav__list" data-md-scrollfix>
  328. <li class="md-nav__item md-nav__item--nested">
  329. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  330. <label class="md-nav__link" for="__nav_5_1">
  331. AWS
  332. <span class="md-nav__icon md-icon"></span>
  333. </label>
  334. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  335. <label class="md-nav__title" for="__nav_5_1">
  336. <span class="md-nav__icon md-icon"></span>
  337. AWS
  338. </label>
  339. <ul class="md-nav__list" data-md-scrollfix>
  340. <li class="md-nav__item">
  341. <a href="provider/aws-secrets-manager/" class="md-nav__link">
  342. Secrets Manager
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="provider/aws-parameter-store/" class="md-nav__link">
  347. Parameter Store
  348. </a>
  349. </li>
  350. </ul>
  351. </nav>
  352. </li>
  353. <li class="md-nav__item md-nav__item--nested">
  354. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  355. <label class="md-nav__link" for="__nav_5_2">
  356. Azure
  357. <span class="md-nav__icon md-icon"></span>
  358. </label>
  359. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  360. <label class="md-nav__title" for="__nav_5_2">
  361. <span class="md-nav__icon md-icon"></span>
  362. Azure
  363. </label>
  364. <ul class="md-nav__list" data-md-scrollfix>
  365. <li class="md-nav__item">
  366. <a href="provider/azure-key-vault/" class="md-nav__link">
  367. Key Vault
  368. </a>
  369. </li>
  370. </ul>
  371. </nav>
  372. </li>
  373. <li class="md-nav__item md-nav__item--nested">
  374. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  375. <label class="md-nav__link" for="__nav_5_3">
  376. Google
  377. <span class="md-nav__icon md-icon"></span>
  378. </label>
  379. <nav class="md-nav" aria-label="Google" data-md-level="2">
  380. <label class="md-nav__title" for="__nav_5_3">
  381. <span class="md-nav__icon md-icon"></span>
  382. Google
  383. </label>
  384. <ul class="md-nav__list" data-md-scrollfix>
  385. <li class="md-nav__item">
  386. <a href="provider/google-secrets-manager/" class="md-nav__link">
  387. Secret Manager
  388. </a>
  389. </li>
  390. </ul>
  391. </nav>
  392. </li>
  393. <li class="md-nav__item md-nav__item--nested">
  394. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  395. <label class="md-nav__link" for="__nav_5_4">
  396. IBM
  397. <span class="md-nav__icon md-icon"></span>
  398. </label>
  399. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  400. <label class="md-nav__title" for="__nav_5_4">
  401. <span class="md-nav__icon md-icon"></span>
  402. IBM
  403. </label>
  404. <ul class="md-nav__list" data-md-scrollfix>
  405. <li class="md-nav__item">
  406. <a href="provider/ibm-secrets-manager/" class="md-nav__link">
  407. Secrets Manager
  408. </a>
  409. </li>
  410. </ul>
  411. </nav>
  412. </li>
  413. <li class="md-nav__item">
  414. <a href="provider/akeyless/" class="md-nav__link">
  415. Akeyless
  416. </a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="provider/hashicorp-vault/" class="md-nav__link">
  420. HashiCorp Vault
  421. </a>
  422. </li>
  423. <li class="md-nav__item md-nav__item--nested">
  424. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  425. <label class="md-nav__link" for="__nav_5_7">
  426. Yandex
  427. <span class="md-nav__icon md-icon"></span>
  428. </label>
  429. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  430. <label class="md-nav__title" for="__nav_5_7">
  431. <span class="md-nav__icon md-icon"></span>
  432. Yandex
  433. </label>
  434. <ul class="md-nav__list" data-md-scrollfix>
  435. <li class="md-nav__item">
  436. <a href="provider/yandex-certificate-manager/" class="md-nav__link">
  437. Certificate Manager
  438. </a>
  439. </li>
  440. <li class="md-nav__item">
  441. <a href="provider/yandex-lockbox/" class="md-nav__link">
  442. Lockbox
  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_8" type="checkbox" id="__nav_5_8" >
  450. <label class="md-nav__link" for="__nav_5_8">
  451. Gitlab
  452. <span class="md-nav__icon md-icon"></span>
  453. </label>
  454. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  455. <label class="md-nav__title" for="__nav_5_8">
  456. <span class="md-nav__icon md-icon"></span>
  457. Gitlab
  458. </label>
  459. <ul class="md-nav__list" data-md-scrollfix>
  460. <li class="md-nav__item">
  461. <a href="provider/gitlab-project-variables/" class="md-nav__link">
  462. Gitlab Project Variables
  463. </a>
  464. </li>
  465. </ul>
  466. </nav>
  467. </li>
  468. <li class="md-nav__item md-nav__item--nested">
  469. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  470. <label class="md-nav__link" for="__nav_5_9">
  471. Oracle
  472. <span class="md-nav__icon md-icon"></span>
  473. </label>
  474. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  475. <label class="md-nav__title" for="__nav_5_9">
  476. <span class="md-nav__icon md-icon"></span>
  477. Oracle
  478. </label>
  479. <ul class="md-nav__list" data-md-scrollfix>
  480. <li class="md-nav__item">
  481. <a href="provider/oracle-vault/" class="md-nav__link">
  482. Oracle Vault
  483. </a>
  484. </li>
  485. </ul>
  486. </nav>
  487. </li>
  488. <li class="md-nav__item md-nav__item--nested">
  489. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  490. <label class="md-nav__link" for="__nav_5_10">
  491. 1Password
  492. <span class="md-nav__icon md-icon"></span>
  493. </label>
  494. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  495. <label class="md-nav__title" for="__nav_5_10">
  496. <span class="md-nav__icon md-icon"></span>
  497. 1Password
  498. </label>
  499. <ul class="md-nav__list" data-md-scrollfix>
  500. <li class="md-nav__item">
  501. <a href="provider/1password-automation/" class="md-nav__link">
  502. Secrets Automation
  503. </a>
  504. </li>
  505. </ul>
  506. </nav>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="provider/webhook/" class="md-nav__link">
  510. Webhook
  511. </a>
  512. </li>
  513. <li class="md-nav__item">
  514. <a href="provider/fake/" class="md-nav__link">
  515. Fake
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="provider/kubernetes/" class="md-nav__link">
  520. Kubernetes
  521. </a>
  522. </li>
  523. <li class="md-nav__item md-nav__item--nested">
  524. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  525. <label class="md-nav__link" for="__nav_5_14">
  526. senhasegura
  527. <span class="md-nav__icon md-icon"></span>
  528. </label>
  529. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  530. <label class="md-nav__title" for="__nav_5_14">
  531. <span class="md-nav__icon md-icon"></span>
  532. senhasegura
  533. </label>
  534. <ul class="md-nav__list" data-md-scrollfix>
  535. <li class="md-nav__item">
  536. <a href="provider/senhasegura-dsm/" class="md-nav__link">
  537. DevOps Secrets Management (DSM)
  538. </a>
  539. </li>
  540. </ul>
  541. </nav>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="provider/doppler/" class="md-nav__link">
  545. Doppler
  546. </a>
  547. </li>
  548. </ul>
  549. </nav>
  550. </li>
  551. <li class="md-nav__item md-nav__item--nested">
  552. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  553. <label class="md-nav__link" for="__nav_6">
  554. Examples
  555. <span class="md-nav__icon md-icon"></span>
  556. </label>
  557. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  558. <label class="md-nav__title" for="__nav_6">
  559. <span class="md-nav__icon md-icon"></span>
  560. Examples
  561. </label>
  562. <ul class="md-nav__list" data-md-scrollfix>
  563. <li class="md-nav__item">
  564. <a href="examples/gitops-using-fluxcd/" class="md-nav__link">
  565. FluxCD
  566. </a>
  567. </li>
  568. <li class="md-nav__item">
  569. <a href="examples/anchore-engine-credentials/" class="md-nav__link">
  570. Anchore Engine
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  575. Jenkins
  576. </a>
  577. </li>
  578. </ul>
  579. </nav>
  580. </li>
  581. <li class="md-nav__item md-nav__item--nested">
  582. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  583. <label class="md-nav__link" for="__nav_7">
  584. External Resources
  585. <span class="md-nav__icon md-icon"></span>
  586. </label>
  587. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  588. <label class="md-nav__title" for="__nav_7">
  589. <span class="md-nav__icon md-icon"></span>
  590. External Resources
  591. </label>
  592. <ul class="md-nav__list" data-md-scrollfix>
  593. <li class="md-nav__item">
  594. <a href="eso-talks/" class="md-nav__link">
  595. Talks
  596. </a>
  597. </li>
  598. <li class="md-nav__item">
  599. <a href="eso-demos/" class="md-nav__link">
  600. Demos
  601. </a>
  602. </li>
  603. <li class="md-nav__item">
  604. <a href="eso-blogs/" class="md-nav__link">
  605. Blogs
  606. </a>
  607. </li>
  608. </ul>
  609. </nav>
  610. </li>
  611. <li class="md-nav__item md-nav__item--nested">
  612. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  613. <label class="md-nav__link" for="__nav_8">
  614. References
  615. <span class="md-nav__icon md-icon"></span>
  616. </label>
  617. <nav class="md-nav" aria-label="References" data-md-level="1">
  618. <label class="md-nav__title" for="__nav_8">
  619. <span class="md-nav__icon md-icon"></span>
  620. References
  621. </label>
  622. <ul class="md-nav__list" data-md-scrollfix>
  623. <li class="md-nav__item">
  624. <a href="spec/" class="md-nav__link">
  625. API specification
  626. </a>
  627. </li>
  628. </ul>
  629. </nav>
  630. </li>
  631. <li class="md-nav__item md-nav__item--nested">
  632. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  633. <label class="md-nav__link" for="__nav_9">
  634. Contributing
  635. <span class="md-nav__icon md-icon"></span>
  636. </label>
  637. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  638. <label class="md-nav__title" for="__nav_9">
  639. <span class="md-nav__icon md-icon"></span>
  640. Contributing
  641. </label>
  642. <ul class="md-nav__list" data-md-scrollfix>
  643. <li class="md-nav__item">
  644. <a href="contributing/devguide/" class="md-nav__link">
  645. Developer guide
  646. </a>
  647. </li>
  648. <li class="md-nav__item">
  649. <a href="contributing/process/" class="md-nav__link">
  650. Contributing Process
  651. </a>
  652. </li>
  653. <li class="md-nav__item">
  654. <a href="contributing/release/" class="md-nav__link">
  655. Release Process
  656. </a>
  657. </li>
  658. <li class="md-nav__item">
  659. <a href="contributing/coc/" class="md-nav__link">
  660. Code of Conduct
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="contributing/roadmap/" class="md-nav__link">
  665. Roadmap
  666. </a>
  667. </li>
  668. </ul>
  669. </nav>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="faq/" class="md-nav__link">
  673. FAQ
  674. </a>
  675. </li>
  676. <li class="md-nav__item">
  677. <a href="stability-support/" class="md-nav__link">
  678. Stability and Support
  679. </a>
  680. </li>
  681. <li class="md-nav__item">
  682. <a href="deprecation-policy/" class="md-nav__link">
  683. Deprecation Policy
  684. </a>
  685. </li>
  686. </ul>
  687. </nav>
  688. </div>
  689. </div>
  690. </div>
  691. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  692. <div class="md-sidebar__scrollwrap">
  693. <div class="md-sidebar__inner">
  694. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  695. <label class="md-nav__title" for="__toc">
  696. <span class="md-nav__icon md-icon"></span>
  697. Table of contents
  698. </label>
  699. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  700. <li class="md-nav__item">
  701. <a href="#what-is-the-goal-of-external-secrets-operator" class="md-nav__link">
  702. What is the goal of External Secrets Operator?
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="#where-to-get-started" class="md-nav__link">
  707. Where to get started
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="#how-to-get-involved" class="md-nav__link">
  712. How to get involved
  713. </a>
  714. </li>
  715. <li class="md-nav__item">
  716. <a href="#kicked-off-by" class="md-nav__link">
  717. Kicked off by
  718. </a>
  719. </li>
  720. <li class="md-nav__item">
  721. <a href="#sponsored-by" class="md-nav__link">
  722. Sponsored by
  723. </a>
  724. </li>
  725. </ul>
  726. </nav>
  727. </div>
  728. </div>
  729. </div>
  730. <div class="md-content" data-md-component="content">
  731. <article class="md-content__inner md-typeset">
  732. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/index.md" title="Edit this page" class="md-content__button md-icon">
  733. <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>
  734. </a>
  735. <h1 id="introduction">Introduction</h1>
  736. <p><img alt="high-level" src="pictures/diagrams-high-level-simple.png" /></p>
  737. <p><strong>External Secrets Operator</strong> is a Kubernetes operator that integrates external
  738. secret management systems like <a href="https://aws.amazon.com/secrets-manager/">AWS Secrets
  739. Manager</a>, <a href="https://www.vaultproject.io/">HashiCorp
  740. Vault</a>, <a href="https://cloud.google.com/secret-manager">Google Secrets
  741. Manager</a>, <a href="https://azure.microsoft.com/en-us/services/key-vault/">Azure Key
  742. Vault</a> and many more. The
  743. operator reads information from external APIs and automatically injects the
  744. values into a <a href="https://kubernetes.io/docs/concepts/configuration/secret/">Kubernetes
  745. Secret</a>.</p>
  746. <h3 id="what-is-the-goal-of-external-secrets-operator">What is the goal of External Secrets Operator?</h3>
  747. <p>The goal of External Secrets Operator is to synchronize secrets from external
  748. APIs into Kubernetes. ESO is a collection of custom API resources -
  749. <code>ExternalSecret</code>, <code>SecretStore</code> and <code>ClusterSecretStore</code> that provide a
  750. user-friendly abstraction for the external API that stores and manages the
  751. lifecycle of the secrets for you.</p>
  752. <h3 id="where-to-get-started">Where to get started</h3>
  753. <p>To get started, please read through <a href="overview/">API overview</a> this should
  754. give you a high-level overview to understand the API and use-cases. After that
  755. please follow one of our <a href="guides/introduction/">guides</a> to get a jump start
  756. using the operator. See our <a href="guides/getting-started/">getting started guide</a> for installation instructions.</p>
  757. <p>For a complete reference of the API types please refer to our <a href="spec/">API
  758. Reference</a>.</p>
  759. <h3 id="how-to-get-involved">How to get involved</h3>
  760. <p>This project is driven by it's users and contributors and we welcome everybody
  761. to get involved. Join our meetings, open issues or ask questions in Slack. The
  762. success of this project depends on your input: No contribution is too small -
  763. even opinions matter!</p>
  764. <p>How to get involved:</p>
  765. <ul>
  766. <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> on Wednesday
  767. (<a href="https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA">agenda</a>, <a href="https://meet.jit.si/eso-community-meeting">jitsi call</a>)</li>
  768. <li><a href="https://kubernetes.slack.com/messages/external-secrets">Kubernetes Slack
  769. #external-secrets</a></li>
  770. <li><a href="contributing/process/">Contributing Process</a></li>
  771. <li><a href="https://twitter.com/ExtSecretsOptr">Twitter</a></li>
  772. </ul>
  773. <h3 id="kicked-off-by">Kicked off by</h3>
  774. <p><img alt="godaddy-logo" src="pictures/godaddy_logo.png" /></p>
  775. <h3 id="sponsored-by">Sponsored by</h3>
  776. <p><img alt="cs-logo" src="pictures/cs_logo.png" />
  777. <img alt="Form3" src="pictures/form3_logo.png" />
  778. <img alt="Pento" src="pictures/pento_logo.png" /></p>
  779. </article>
  780. </div>
  781. </div>
  782. </main>
  783. <footer class="md-footer">
  784. <nav class="md-footer__inner md-grid" aria-label="Footer">
  785. <a href="overview/" class="md-footer__link md-footer__link--next" aria-label="Next: Overview" rel="next">
  786. <div class="md-footer__title">
  787. <div class="md-ellipsis">
  788. <span class="md-footer__direction">
  789. Next
  790. </span>
  791. Overview
  792. </div>
  793. </div>
  794. <div class="md-footer__button md-icon">
  795. <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>
  796. </div>
  797. </a>
  798. </nav>
  799. <div class="md-footer-meta md-typeset">
  800. <div class="md-footer-meta__inner md-grid">
  801. <div class="md-copyright">
  802. <div class="md-copyright__highlight">
  803. &copy; 2022 The external-secrets Authors.<br/>
  804. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  805. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  806. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  807. </div>
  808. Made with
  809. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  810. Material for MkDocs
  811. </a>
  812. </div>
  813. </div>
  814. </div>
  815. </footer>
  816. </div>
  817. <div class="md-dialog" data-md-component="dialog">
  818. <div class="md-dialog__inner md-typeset"></div>
  819. </div>
  820. <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>
  821. <script src="assets/javascripts/bundle.e3b2bf44.min.js"></script>
  822. </body>
  823. </html>