index.html 39 KB

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