index.html 36 KB

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