index.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232
  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="next" href="introduction/overview/">
  7. <link rel="icon" href="assets/images/favicon.png">
  8. <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.9">
  9. <title>Introduction - External Secrets Operator</title>
  10. <link rel="stylesheet" href="assets/stylesheets/main.85bb2934.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,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__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 id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  16. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  17. </head>
  18. <body dir="ltr">
  19. <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#introduction" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  31. <aside class="md-banner md-banner--warning">
  32. <div class="md-banner__inner md-grid md-typeset">
  33. You're not viewing the latest version.
  34. <a href="../.">
  35. <strong>Click here to go to latest.</strong>
  36. </a>
  37. </div>
  38. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  39. </aside>
  40. </div>
  41. <header class="md-header" data-md-component="header">
  42. <nav class="md-header__inner md-grid" aria-label="Header">
  43. <a href="." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  44. <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>
  45. </a>
  46. <label class="md-header__button md-icon" for="__drawer">
  47. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  48. </label>
  49. <div class="md-header__title" data-md-component="header-title">
  50. <div class="md-header__ellipsis">
  51. <div class="md-header__topic">
  52. <span class="md-ellipsis">
  53. External Secrets Operator
  54. </span>
  55. </div>
  56. <div class="md-header__topic" data-md-component="header-topic">
  57. <span class="md-ellipsis">
  58. Introduction
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <label class="md-header__button md-icon" for="__search">
  64. <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>
  65. </label>
  66. <div class="md-search" data-md-component="search" role="dialog">
  67. <label class="md-search__overlay" for="__search"></label>
  68. <div class="md-search__inner" role="search">
  69. <form class="md-search__form" name="search">
  70. <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>
  71. <label class="md-search__icon md-icon" for="__search">
  72. <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>
  73. <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>
  74. </label>
  75. <nav class="md-search__options" aria-label="Search">
  76. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  77. <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>
  78. </button>
  79. </nav>
  80. </form>
  81. <div class="md-search__output">
  82. <div class="md-search__scrollwrap" data-md-scrollfix>
  83. <div class="md-search-result" data-md-component="search-result">
  84. <div class="md-search-result__meta">
  85. Initializing search
  86. </div>
  87. <ol class="md-search-result__list" role="presentation"></ol>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. <div class="md-header__source">
  94. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  95. <div class="md-source__icon md-icon">
  96. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
  97. </div>
  98. <div class="md-source__repository">
  99. External Secrets Operator
  100. </div>
  101. </a>
  102. </div>
  103. </nav>
  104. </header>
  105. <div class="md-container" data-md-component="container">
  106. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  107. <div class="md-grid">
  108. <ul class="md-tabs__list">
  109. <li class="md-tabs__item">
  110. <a href="." class="md-tabs__link md-tabs__link--active">
  111. Introduction
  112. </a>
  113. </li>
  114. <li class="md-tabs__item">
  115. <a href="api/components/" class="md-tabs__link">
  116. API
  117. </a>
  118. </li>
  119. <li class="md-tabs__item">
  120. <a href="guides/introduction/" class="md-tabs__link">
  121. Guides
  122. </a>
  123. </li>
  124. <li class="md-tabs__item">
  125. <a href="provider/aws-secrets-manager/" class="md-tabs__link">
  126. Provider
  127. </a>
  128. </li>
  129. <li class="md-tabs__item">
  130. <a href="examples/gitops-using-fluxcd/" class="md-tabs__link">
  131. Examples
  132. </a>
  133. </li>
  134. <li class="md-tabs__item">
  135. <a href="contributing/devguide/" class="md-tabs__link">
  136. Community
  137. </a>
  138. </li>
  139. </ul>
  140. </div>
  141. </nav>
  142. <main class="md-main" data-md-component="main">
  143. <div class="md-main__inner md-grid">
  144. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  145. <div class="md-sidebar__scrollwrap">
  146. <div class="md-sidebar__inner">
  147. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  148. <label class="md-nav__title" for="__drawer">
  149. <a href="." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  150. <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>
  151. </a>
  152. External Secrets Operator
  153. </label>
  154. <div class="md-nav__source">
  155. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  156. <div class="md-source__icon md-icon">
  157. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
  158. </div>
  159. <div class="md-source__repository">
  160. External Secrets Operator
  161. </div>
  162. </a>
  163. </div>
  164. <ul class="md-nav__list" data-md-scrollfix>
  165. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  166. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" checked>
  167. <div class="md-nav__link md-nav__link--index md-nav__link--active">
  168. <a href=".">Introduction</a>
  169. <label for="__nav_1">
  170. <span class="md-nav__icon md-icon"></span>
  171. </label>
  172. </div>
  173. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="true">
  174. <label class="md-nav__title" for="__nav_1">
  175. <span class="md-nav__icon md-icon"></span>
  176. Introduction
  177. </label>
  178. <ul class="md-nav__list" data-md-scrollfix>
  179. <li class="md-nav__item">
  180. <a href="introduction/overview/" class="md-nav__link">
  181. Overview
  182. </a>
  183. </li>
  184. <li class="md-nav__item">
  185. <a href="introduction/getting-started/" class="md-nav__link">
  186. Getting started
  187. </a>
  188. </li>
  189. <li class="md-nav__item">
  190. <a href="introduction/faq/" class="md-nav__link">
  191. FAQ
  192. </a>
  193. </li>
  194. <li class="md-nav__item">
  195. <a href="introduction/stability-support/" class="md-nav__link">
  196. Stability and Support
  197. </a>
  198. </li>
  199. <li class="md-nav__item">
  200. <a href="introduction/deprecation-policy/" class="md-nav__link">
  201. Deprecation Policy
  202. </a>
  203. </li>
  204. </ul>
  205. </nav>
  206. </li>
  207. <li class="md-nav__item md-nav__item--nested">
  208. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  209. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  210. API
  211. <span class="md-nav__icon md-icon"></span>
  212. </label>
  213. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  214. <label class="md-nav__title" for="__nav_2">
  215. <span class="md-nav__icon md-icon"></span>
  216. API
  217. </label>
  218. <ul class="md-nav__list" data-md-scrollfix>
  219. <li class="md-nav__item">
  220. <a href="api/components/" class="md-nav__link">
  221. Components
  222. </a>
  223. </li>
  224. <li class="md-nav__item md-nav__item--nested">
  225. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  226. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  227. Core Resources
  228. <span class="md-nav__icon md-icon"></span>
  229. </label>
  230. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  231. <label class="md-nav__title" for="__nav_2_2">
  232. <span class="md-nav__icon md-icon"></span>
  233. Core Resources
  234. </label>
  235. <ul class="md-nav__list" data-md-scrollfix>
  236. <li class="md-nav__item">
  237. <a href="api/externalsecret/" class="md-nav__link">
  238. ExternalSecret
  239. </a>
  240. </li>
  241. <li class="md-nav__item">
  242. <a href="api/secretstore/" class="md-nav__link">
  243. SecretStore
  244. </a>
  245. </li>
  246. <li class="md-nav__item">
  247. <a href="api/clustersecretstore/" class="md-nav__link">
  248. ClusterSecretStore
  249. </a>
  250. </li>
  251. <li class="md-nav__item">
  252. <a href="api/clusterexternalsecret/" class="md-nav__link">
  253. ClusterExternalSecret
  254. </a>
  255. </li>
  256. <li class="md-nav__item">
  257. <a href="api/pushsecret/" class="md-nav__link">
  258. PushSecret
  259. </a>
  260. </li>
  261. </ul>
  262. </nav>
  263. </li>
  264. <li class="md-nav__item md-nav__item--nested">
  265. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  266. <div class="md-nav__link md-nav__link--index ">
  267. <a href="api/generator/">Generators</a>
  268. <label for="__nav_2_3">
  269. <span class="md-nav__icon md-icon"></span>
  270. </label>
  271. </div>
  272. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  273. <label class="md-nav__title" for="__nav_2_3">
  274. <span class="md-nav__icon md-icon"></span>
  275. Generators
  276. </label>
  277. <ul class="md-nav__list" data-md-scrollfix>
  278. <li class="md-nav__item">
  279. <a href="api/generator/acr/" class="md-nav__link">
  280. Azure Container Registry
  281. </a>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="api/generator/ecr/" class="md-nav__link">
  285. AWS Elastic Container Registry
  286. </a>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="api/generator/gcr/" class="md-nav__link">
  290. Google Container Registry
  291. </a>
  292. </li>
  293. <li class="md-nav__item">
  294. <a href="api/generator/vault/" class="md-nav__link">
  295. Vault Dynamic Secret
  296. </a>
  297. </li>
  298. <li class="md-nav__item">
  299. <a href="api/generator/password/" class="md-nav__link">
  300. Password
  301. </a>
  302. </li>
  303. <li class="md-nav__item">
  304. <a href="api/generator/fake/" class="md-nav__link">
  305. Fake
  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 md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  313. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  314. Reference Docs
  315. <span class="md-nav__icon md-icon"></span>
  316. </label>
  317. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  318. <label class="md-nav__title" for="__nav_2_4">
  319. <span class="md-nav__icon md-icon"></span>
  320. Reference Docs
  321. </label>
  322. <ul class="md-nav__list" data-md-scrollfix>
  323. <li class="md-nav__item">
  324. <a href="api/spec/" class="md-nav__link">
  325. API specification
  326. </a>
  327. </li>
  328. <li class="md-nav__item">
  329. <a href="api/controller-options/" class="md-nav__link">
  330. Controller Options
  331. </a>
  332. </li>
  333. <li class="md-nav__item">
  334. <a href="api/metrics/" class="md-nav__link">
  335. Metrics
  336. </a>
  337. </li>
  338. </ul>
  339. </nav>
  340. </li>
  341. </ul>
  342. </nav>
  343. </li>
  344. <li class="md-nav__item md-nav__item--nested">
  345. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  346. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  347. Guides
  348. <span class="md-nav__icon md-icon"></span>
  349. </label>
  350. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  351. <label class="md-nav__title" for="__nav_3">
  352. <span class="md-nav__icon md-icon"></span>
  353. Guides
  354. </label>
  355. <ul class="md-nav__list" data-md-scrollfix>
  356. <li class="md-nav__item">
  357. <a href="guides/introduction/" class="md-nav__link">
  358. Introduction
  359. </a>
  360. </li>
  361. <li class="md-nav__item md-nav__item--nested">
  362. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  363. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  364. External Secrets
  365. <span class="md-nav__icon md-icon"></span>
  366. </label>
  367. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  368. <label class="md-nav__title" for="__nav_3_2">
  369. <span class="md-nav__icon md-icon"></span>
  370. External Secrets
  371. </label>
  372. <ul class="md-nav__list" data-md-scrollfix>
  373. <li class="md-nav__item">
  374. <a href="guides/all-keys-one-secret/" class="md-nav__link">
  375. Extract structured data
  376. </a>
  377. </li>
  378. <li class="md-nav__item">
  379. <a href="guides/getallsecrets/" class="md-nav__link">
  380. Find Secrets by Name or Metadata
  381. </a>
  382. </li>
  383. <li class="md-nav__item">
  384. <a href="guides/datafrom-rewrite/" class="md-nav__link">
  385. Rewriting Keys
  386. </a>
  387. </li>
  388. <li class="md-nav__item md-nav__item--nested">
  389. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  390. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  391. Advanced Templating
  392. <span class="md-nav__icon md-icon"></span>
  393. </label>
  394. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  395. <label class="md-nav__title" for="__nav_3_2_4">
  396. <span class="md-nav__icon md-icon"></span>
  397. Advanced Templating
  398. </label>
  399. <ul class="md-nav__list" data-md-scrollfix>
  400. <li class="md-nav__item">
  401. <a href="guides/templating/" class="md-nav__link">
  402. v2
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="guides/templating-v1/" class="md-nav__link">
  407. v1
  408. </a>
  409. </li>
  410. </ul>
  411. </nav>
  412. </li>
  413. <li class="md-nav__item">
  414. <a href="guides/common-k8s-secret-types/" class="md-nav__link">
  415. Kubernetes Secret Types
  416. </a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="guides/ownership-deletion-policy/" class="md-nav__link">
  420. Lifecycle: ownership & deletion
  421. </a>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="guides/decoding-strategy/" class="md-nav__link">
  425. Decoding Strategies
  426. </a>
  427. </li>
  428. <li class="md-nav__item">
  429. <a href="guides/controller-class/" class="md-nav__link">
  430. Controller Classes
  431. </a>
  432. </li>
  433. </ul>
  434. </nav>
  435. </li>
  436. <li class="md-nav__item">
  437. <a href="guides/generator/" class="md-nav__link">
  438. Generators
  439. </a>
  440. </li>
  441. <li class="md-nav__item md-nav__item--nested">
  442. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
  443. <label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
  444. Operations
  445. <span class="md-nav__icon md-icon"></span>
  446. </label>
  447. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
  448. <label class="md-nav__title" for="__nav_3_4">
  449. <span class="md-nav__icon md-icon"></span>
  450. Operations
  451. </label>
  452. <ul class="md-nav__list" data-md-scrollfix>
  453. <li class="md-nav__item">
  454. <a href="guides/multi-tenancy/" class="md-nav__link">
  455. Multi Tenancy
  456. </a>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="guides/security-best-practices/" class="md-nav__link">
  460. Security Best Practices
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="guides/threat-model/" class="md-nav__link">
  465. Threat Model
  466. </a>
  467. </li>
  468. <li class="md-nav__item">
  469. <a href="guides/v1beta1/" class="md-nav__link">
  470. Upgrading to v1beta1
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="guides/using-latest-image/" class="md-nav__link">
  475. Using Latest Image
  476. </a>
  477. </li>
  478. <li class="md-nav__item">
  479. <a href="guides/disable-cluster-features/" class="md-nav__link">
  480. Disable Cluster Features
  481. </a>
  482. </li>
  483. </ul>
  484. </nav>
  485. </li>
  486. </ul>
  487. </nav>
  488. </li>
  489. <li class="md-nav__item md-nav__item--nested">
  490. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  491. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  492. Provider
  493. <span class="md-nav__icon md-icon"></span>
  494. </label>
  495. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  496. <label class="md-nav__title" for="__nav_4">
  497. <span class="md-nav__icon md-icon"></span>
  498. Provider
  499. </label>
  500. <ul class="md-nav__list" data-md-scrollfix>
  501. <li class="md-nav__item">
  502. <a href="provider/aws-secrets-manager/" class="md-nav__link">
  503. AWS Secrets Manager
  504. </a>
  505. </li>
  506. <li class="md-nav__item">
  507. <a href="provider/aws-parameter-store/" class="md-nav__link">
  508. AWS Parameter Store
  509. </a>
  510. </li>
  511. <li class="md-nav__item">
  512. <a href="provider/azure-key-vault/" class="md-nav__link">
  513. Azure Key Vault
  514. </a>
  515. </li>
  516. <li class="md-nav__item">
  517. <a href="provider/conjur/" class="md-nav__link">
  518. CyberArk Conjur
  519. </a>
  520. </li>
  521. <li class="md-nav__item">
  522. <a href="provider/google-secrets-manager/" class="md-nav__link">
  523. Google Cloud Secret Manager
  524. </a>
  525. </li>
  526. <li class="md-nav__item">
  527. <a href="provider/hashicorp-vault/" class="md-nav__link">
  528. HashiCorp Vault
  529. </a>
  530. </li>
  531. <li class="md-nav__item">
  532. <a href="provider/kubernetes/" class="md-nav__link">
  533. Kubernetes
  534. </a>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="provider/ibm-secrets-manager/" class="md-nav__link">
  538. IBM Secrets Manager
  539. </a>
  540. </li>
  541. <li class="md-nav__item">
  542. <a href="provider/akeyless/" class="md-nav__link">
  543. Akeyless
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="provider/yandex-certificate-manager/" class="md-nav__link">
  548. Yandex Certificate Manager
  549. </a>
  550. </li>
  551. <li class="md-nav__item">
  552. <a href="provider/yandex-lockbox/" class="md-nav__link">
  553. Yandex Lockbox
  554. </a>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="provider/alibaba/" class="md-nav__link">
  558. Alibaba Cloud
  559. </a>
  560. </li>
  561. <li class="md-nav__item">
  562. <a href="provider/gitlab-variables/" class="md-nav__link">
  563. GitLab Variables
  564. </a>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="provider/oracle-vault/" class="md-nav__link">
  568. Oracle Vault
  569. </a>
  570. </li>
  571. <li class="md-nav__item">
  572. <a href="provider/1password-automation/" class="md-nav__link">
  573. 1Password Secrets Automation
  574. </a>
  575. </li>
  576. <li class="md-nav__item">
  577. <a href="provider/webhook/" class="md-nav__link">
  578. Webhook
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="provider/fake/" class="md-nav__link">
  583. Fake
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="provider/senhasegura-dsm/" class="md-nav__link">
  588. senhasegura DevOps Secrets Management (DSM)
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="provider/doppler/" class="md-nav__link">
  593. Doppler
  594. </a>
  595. </li>
  596. <li class="md-nav__item">
  597. <a href="provider/keeper-security/" class="md-nav__link">
  598. Keeper Security
  599. </a>
  600. </li>
  601. <li class="md-nav__item">
  602. <a href="provider/scaleway/" class="md-nav__link">
  603. Scaleway
  604. </a>
  605. </li>
  606. <li class="md-nav__item">
  607. <a href="provider/delinea/" class="md-nav__link">
  608. Delinea
  609. </a>
  610. </li>
  611. </ul>
  612. </nav>
  613. </li>
  614. <li class="md-nav__item md-nav__item--nested">
  615. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  616. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  617. Examples
  618. <span class="md-nav__icon md-icon"></span>
  619. </label>
  620. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  621. <label class="md-nav__title" for="__nav_5">
  622. <span class="md-nav__icon md-icon"></span>
  623. Examples
  624. </label>
  625. <ul class="md-nav__list" data-md-scrollfix>
  626. <li class="md-nav__item">
  627. <a href="examples/gitops-using-fluxcd/" class="md-nav__link">
  628. FluxCD
  629. </a>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="examples/anchore-engine-credentials/" class="md-nav__link">
  633. Anchore Engine
  634. </a>
  635. </li>
  636. <li class="md-nav__item">
  637. <a href="examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  638. Jenkins
  639. </a>
  640. </li>
  641. <li class="md-nav__item">
  642. <a href="examples/bitwarden/" class="md-nav__link">
  643. BitWarden
  644. </a>
  645. </li>
  646. </ul>
  647. </nav>
  648. </li>
  649. <li class="md-nav__item md-nav__item--nested">
  650. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  651. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  652. Community
  653. <span class="md-nav__icon md-icon"></span>
  654. </label>
  655. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  656. <label class="md-nav__title" for="__nav_6">
  657. <span class="md-nav__icon md-icon"></span>
  658. Community
  659. </label>
  660. <ul class="md-nav__list" data-md-scrollfix>
  661. <li class="md-nav__item md-nav__item--nested">
  662. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  663. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  664. Contributing
  665. <span class="md-nav__icon md-icon"></span>
  666. </label>
  667. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  668. <label class="md-nav__title" for="__nav_6_1">
  669. <span class="md-nav__icon md-icon"></span>
  670. Contributing
  671. </label>
  672. <ul class="md-nav__list" data-md-scrollfix>
  673. <li class="md-nav__item">
  674. <a href="contributing/devguide/" class="md-nav__link">
  675. Developer guide
  676. </a>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="contributing/process/" class="md-nav__link">
  680. Contributing Process
  681. </a>
  682. </li>
  683. <li class="md-nav__item">
  684. <a href="contributing/release/" class="md-nav__link">
  685. Release Process
  686. </a>
  687. </li>
  688. <li class="md-nav__item">
  689. <a href="contributing/coc/" class="md-nav__link">
  690. Code of Conduct
  691. </a>
  692. </li>
  693. <li class="md-nav__item">
  694. <a href="contributing/roadmap/" class="md-nav__link">
  695. Roadmap
  696. </a>
  697. </li>
  698. </ul>
  699. </nav>
  700. </li>
  701. <li class="md-nav__item md-nav__item--nested">
  702. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  703. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  704. External Resources
  705. <span class="md-nav__icon md-icon"></span>
  706. </label>
  707. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  708. <label class="md-nav__title" for="__nav_6_2">
  709. <span class="md-nav__icon md-icon"></span>
  710. External Resources
  711. </label>
  712. <ul class="md-nav__list" data-md-scrollfix>
  713. <li class="md-nav__item">
  714. <a href="eso-talks/" class="md-nav__link">
  715. Talks
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="eso-demos/" class="md-nav__link">
  720. Demos
  721. </a>
  722. </li>
  723. <li class="md-nav__item">
  724. <a href="eso-blogs/" class="md-nav__link">
  725. Blogs
  726. </a>
  727. </li>
  728. </ul>
  729. </nav>
  730. </li>
  731. </ul>
  732. </nav>
  733. </li>
  734. </ul>
  735. </nav>
  736. </div>
  737. </div>
  738. </div>
  739. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  740. <div class="md-sidebar__scrollwrap">
  741. <div class="md-sidebar__inner">
  742. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  743. <label class="md-nav__title" for="__toc">
  744. <span class="md-nav__icon md-icon"></span>
  745. Table of contents
  746. </label>
  747. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  748. <li class="md-nav__item">
  749. <a href="#what-is-the-goal-of-external-secrets-operator" class="md-nav__link">
  750. What is the goal of External Secrets Operator?
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="#where-to-get-started" class="md-nav__link">
  755. Where to get started
  756. </a>
  757. </li>
  758. <li class="md-nav__item">
  759. <a href="#how-to-get-involved" class="md-nav__link">
  760. How to get involved
  761. </a>
  762. </li>
  763. <li class="md-nav__item">
  764. <a href="#kicked-off-by" class="md-nav__link">
  765. Kicked off by
  766. </a>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="#sponsored-by" class="md-nav__link">
  770. Sponsored by
  771. </a>
  772. </li>
  773. </ul>
  774. </nav>
  775. </div>
  776. </div>
  777. </div>
  778. <div class="md-content" data-md-component="content">
  779. <article class="md-content__inner md-typeset">
  780. <h1 id="introduction">Introduction</h1>
  781. <p><img alt="high-level" src="pictures/diagrams-high-level-simple.png" /></p>
  782. <p><strong>External Secrets Operator</strong> is a Kubernetes operator that integrates external
  783. secret management systems like <a href="https://aws.amazon.com/secrets-manager/">AWS Secrets
  784. Manager</a>, <a href="https://www.vaultproject.io/">HashiCorp
  785. Vault</a>, <a href="https://cloud.google.com/secret-manager">Google Secrets
  786. Manager</a>, <a href="https://azure.microsoft.com/en-us/services/key-vault/">Azure Key
  787. Vault</a>, <a href="https://www.ibm.com/cloud/secrets-manager">IBM Cloud Secrets Manager</a>, <a href="https://www.conjur.org">CyberArk Conjur</a> and many more. The
  788. operator reads information from external APIs and automatically injects the
  789. values into a <a href="https://kubernetes.io/docs/concepts/configuration/secret/">Kubernetes
  790. Secret</a>.</p>
  791. <h3 id="what-is-the-goal-of-external-secrets-operator">What is the goal of External Secrets Operator?</h3>
  792. <p>The goal of External Secrets Operator is to synchronize secrets from external
  793. APIs into Kubernetes. ESO is a collection of custom API resources -
  794. <code>ExternalSecret</code>, <code>SecretStore</code> and <code>ClusterSecretStore</code> that provide a
  795. user-friendly abstraction for the external API that stores and manages the
  796. lifecycle of the secrets for you.</p>
  797. <h3 id="where-to-get-started">Where to get started</h3>
  798. <p>To get started, please read through <a href="introduction/overview/">API overview</a> this should
  799. give you a high-level overview to understand the API and use-cases. After that
  800. please follow one of our <a href="guides/introduction/">guides</a> to get a jump start
  801. using the operator. See our <a href="introduction/getting-started/">getting started guide</a> for installation instructions.</p>
  802. <p>For a complete reference of the API types please refer to our <a href="api/spec/">API
  803. Reference</a>.</p>
  804. <h3 id="how-to-get-involved">How to get involved</h3>
  805. <p>This project is driven by its users and contributors, and we welcome everybody
  806. to get involved. Join our meetings, open issues or ask questions in Slack. The
  807. success of this project depends on your input: No contribution is too small -
  808. even opinions matter!</p>
  809. <p>How to get involved:</p>
  810. <ul>
  811. <li>Bi-weekly Development Meeting every odd week at <a href="https://dateful.com/time-zone-converter?t=20:00&amp;tz=Europe/Berlin">8:00 PM Berlin Time</a> on Wednesday
  812. (<a href="https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA">agenda</a>, <a href="https://meet.jit.si/eso-community-meeting">jitsi call</a>)</li>
  813. <li><a href="https://kubernetes.slack.com/messages/external-secrets">Kubernetes Slack
  814. #external-secrets</a></li>
  815. <li><a href="contributing/process/">Contributing Process</a></li>
  816. <li><a href="https://twitter.com/ExtSecretsOptr">Twitter</a></li>
  817. </ul>
  818. <h3 id="kicked-off-by">Kicked off by</h3>
  819. <p><img alt="godaddy-logo" src="pictures/godaddy_logo.png" /></p>
  820. <h3 id="sponsored-by">Sponsored by</h3>
  821. <p><img alt="cs-logo" src="pictures/cs_logo.png" />
  822. <img alt="Form3" src="pictures/form3_logo.png" />
  823. <img alt="Pento" src="pictures/pento_logo.png" /></p>
  824. </article>
  825. </div>
  826. </div>
  827. </main>
  828. <footer class="md-footer">
  829. <div class="md-footer-meta md-typeset">
  830. <div class="md-footer-meta__inner md-grid">
  831. <div class="md-copyright">
  832. <div class="md-copyright__highlight">
  833. &copy; 2023 The external-secrets Authors.<br/>
  834. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  835. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  836. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  837. </div>
  838. Made with
  839. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  840. Material for MkDocs
  841. </a>
  842. </div>
  843. </div>
  844. </div>
  845. </footer>
  846. </div>
  847. <div class="md-dialog" data-md-component="dialog">
  848. <div class="md-dialog__inner md-typeset"></div>
  849. </div>
  850. <script id="__config" type="application/json">{"base": ".", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  851. <script src="assets/javascripts/bundle.fac441b0.min.js"></script>
  852. </body>
  853. </html>