index.html 57 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461
  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="prev" href="../overview/">
  7. <link rel="next" href="../faq/">
  8. <link rel="icon" href="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.9">
  10. <title>Getting started - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.85bb2934.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <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">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <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>
  16. <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>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <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>
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#getting-started" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <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>
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. Getting started
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <label class="md-header__button md-icon" for="__search">
  65. <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>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <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>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <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>
  74. <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>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <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>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <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>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link md-tabs__link--active">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../../api/components/" class="md-tabs__link">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../guides/introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. </ul>
  141. </div>
  142. </nav>
  143. <main class="md-main" data-md-component="main">
  144. <div class="md-main__inner md-grid">
  145. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  146. <div class="md-sidebar__scrollwrap">
  147. <div class="md-sidebar__inner">
  148. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  149. <label class="md-nav__title" for="__drawer">
  150. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  151. <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>
  152. </a>
  153. External Secrets Operator
  154. </label>
  155. <div class="md-nav__source">
  156. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  157. <div class="md-source__icon md-icon">
  158. <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>
  159. </div>
  160. <div class="md-source__repository">
  161. External Secrets Operator
  162. </div>
  163. </a>
  164. </div>
  165. <ul class="md-nav__list" data-md-scrollfix>
  166. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  167. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" checked>
  168. <div class="md-nav__link md-nav__link--index ">
  169. <a href="../..">Introduction</a>
  170. <label for="__nav_1">
  171. <span class="md-nav__icon md-icon"></span>
  172. </label>
  173. </div>
  174. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="true">
  175. <label class="md-nav__title" for="__nav_1">
  176. <span class="md-nav__icon md-icon"></span>
  177. Introduction
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../overview/" class="md-nav__link">
  182. Overview
  183. </a>
  184. </li>
  185. <li class="md-nav__item md-nav__item--active">
  186. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  187. <label class="md-nav__link md-nav__link--active" for="__toc">
  188. Getting started
  189. <span class="md-nav__icon md-icon"></span>
  190. </label>
  191. <a href="./" class="md-nav__link md-nav__link--active">
  192. Getting started
  193. </a>
  194. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  195. <label class="md-nav__title" for="__toc">
  196. <span class="md-nav__icon md-icon"></span>
  197. Table of contents
  198. </label>
  199. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  200. <li class="md-nav__item">
  201. <a href="#installing-with-helm" class="md-nav__link">
  202. Installing with Helm
  203. </a>
  204. <nav class="md-nav" aria-label="Installing with Helm">
  205. <ul class="md-nav__list">
  206. <li class="md-nav__item">
  207. <a href="#option-1-install-from-chart-repository" class="md-nav__link">
  208. Option 1: Install from chart repository
  209. </a>
  210. </li>
  211. <li class="md-nav__item">
  212. <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
  213. Option 2: Install chart from local build
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="#create-a-secret-containing-your-aws-credentials" class="md-nav__link">
  218. Create a secret containing your AWS credentials
  219. </a>
  220. </li>
  221. <li class="md-nav__item">
  222. <a href="#create-your-first-secretstore" class="md-nav__link">
  223. Create your first SecretStore
  224. </a>
  225. </li>
  226. <li class="md-nav__item">
  227. <a href="#create-your-first-externalsecret" class="md-nav__link">
  228. Create your first ExternalSecret
  229. </a>
  230. </li>
  231. </ul>
  232. </nav>
  233. </li>
  234. <li class="md-nav__item">
  235. <a href="#installing-with-olm" class="md-nav__link">
  236. Installing with OLM
  237. </a>
  238. </li>
  239. <li class="md-nav__item">
  240. <a href="#uninstalling" class="md-nav__link">
  241. Uninstalling
  242. </a>
  243. <nav class="md-nav" aria-label="Uninstalling">
  244. <ul class="md-nav__list">
  245. <li class="md-nav__item">
  246. <a href="#uninstalling-with-helm" class="md-nav__link">
  247. Uninstalling with Helm
  248. </a>
  249. </li>
  250. </ul>
  251. </nav>
  252. </li>
  253. </ul>
  254. </nav>
  255. </li>
  256. <li class="md-nav__item">
  257. <a href="../faq/" class="md-nav__link">
  258. FAQ
  259. </a>
  260. </li>
  261. <li class="md-nav__item">
  262. <a href="../stability-support/" class="md-nav__link">
  263. Stability and Support
  264. </a>
  265. </li>
  266. <li class="md-nav__item">
  267. <a href="../deprecation-policy/" class="md-nav__link">
  268. Deprecation Policy
  269. </a>
  270. </li>
  271. </ul>
  272. </nav>
  273. </li>
  274. <li class="md-nav__item md-nav__item--nested">
  275. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  276. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  277. API
  278. <span class="md-nav__icon md-icon"></span>
  279. </label>
  280. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  281. <label class="md-nav__title" for="__nav_2">
  282. <span class="md-nav__icon md-icon"></span>
  283. API
  284. </label>
  285. <ul class="md-nav__list" data-md-scrollfix>
  286. <li class="md-nav__item">
  287. <a href="../../api/components/" class="md-nav__link">
  288. Components
  289. </a>
  290. </li>
  291. <li class="md-nav__item md-nav__item--nested">
  292. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  293. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  294. Core Resources
  295. <span class="md-nav__icon md-icon"></span>
  296. </label>
  297. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  298. <label class="md-nav__title" for="__nav_2_2">
  299. <span class="md-nav__icon md-icon"></span>
  300. Core Resources
  301. </label>
  302. <ul class="md-nav__list" data-md-scrollfix>
  303. <li class="md-nav__item">
  304. <a href="../../api/externalsecret/" class="md-nav__link">
  305. ExternalSecret
  306. </a>
  307. </li>
  308. <li class="md-nav__item">
  309. <a href="../../api/secretstore/" class="md-nav__link">
  310. SecretStore
  311. </a>
  312. </li>
  313. <li class="md-nav__item">
  314. <a href="../../api/clustersecretstore/" class="md-nav__link">
  315. ClusterSecretStore
  316. </a>
  317. </li>
  318. <li class="md-nav__item">
  319. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  320. ClusterExternalSecret
  321. </a>
  322. </li>
  323. <li class="md-nav__item">
  324. <a href="../../api/pushsecret/" class="md-nav__link">
  325. PushSecret
  326. </a>
  327. </li>
  328. </ul>
  329. </nav>
  330. </li>
  331. <li class="md-nav__item md-nav__item--nested">
  332. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  333. <div class="md-nav__link md-nav__link--index ">
  334. <a href="../../api/generator/">Generators</a>
  335. <label for="__nav_2_3">
  336. <span class="md-nav__icon md-icon"></span>
  337. </label>
  338. </div>
  339. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  340. <label class="md-nav__title" for="__nav_2_3">
  341. <span class="md-nav__icon md-icon"></span>
  342. Generators
  343. </label>
  344. <ul class="md-nav__list" data-md-scrollfix>
  345. <li class="md-nav__item">
  346. <a href="../../api/generator/acr/" class="md-nav__link">
  347. Azure Container Registry
  348. </a>
  349. </li>
  350. <li class="md-nav__item">
  351. <a href="../../api/generator/ecr/" class="md-nav__link">
  352. AWS Elastic Container Registry
  353. </a>
  354. </li>
  355. <li class="md-nav__item">
  356. <a href="../../api/generator/gcr/" class="md-nav__link">
  357. Google Container Registry
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="../../api/generator/vault/" class="md-nav__link">
  362. Vault Dynamic Secret
  363. </a>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="../../api/generator/password/" class="md-nav__link">
  367. Password
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../../api/generator/fake/" class="md-nav__link">
  372. Fake
  373. </a>
  374. </li>
  375. </ul>
  376. </nav>
  377. </li>
  378. <li class="md-nav__item md-nav__item--nested">
  379. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  380. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  381. Reference Docs
  382. <span class="md-nav__icon md-icon"></span>
  383. </label>
  384. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  385. <label class="md-nav__title" for="__nav_2_4">
  386. <span class="md-nav__icon md-icon"></span>
  387. Reference Docs
  388. </label>
  389. <ul class="md-nav__list" data-md-scrollfix>
  390. <li class="md-nav__item">
  391. <a href="../../api/spec/" class="md-nav__link">
  392. API specification
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../../api/controller-options/" class="md-nav__link">
  397. Controller Options
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../../api/metrics/" class="md-nav__link">
  402. Metrics
  403. </a>
  404. </li>
  405. </ul>
  406. </nav>
  407. </li>
  408. </ul>
  409. </nav>
  410. </li>
  411. <li class="md-nav__item md-nav__item--nested">
  412. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  413. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  414. Guides
  415. <span class="md-nav__icon md-icon"></span>
  416. </label>
  417. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  418. <label class="md-nav__title" for="__nav_3">
  419. <span class="md-nav__icon md-icon"></span>
  420. Guides
  421. </label>
  422. <ul class="md-nav__list" data-md-scrollfix>
  423. <li class="md-nav__item">
  424. <a href="../../guides/introduction/" class="md-nav__link">
  425. Introduction
  426. </a>
  427. </li>
  428. <li class="md-nav__item md-nav__item--nested">
  429. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  430. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  431. External Secrets
  432. <span class="md-nav__icon md-icon"></span>
  433. </label>
  434. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  435. <label class="md-nav__title" for="__nav_3_2">
  436. <span class="md-nav__icon md-icon"></span>
  437. External Secrets
  438. </label>
  439. <ul class="md-nav__list" data-md-scrollfix>
  440. <li class="md-nav__item">
  441. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  442. Extract structured data
  443. </a>
  444. </li>
  445. <li class="md-nav__item">
  446. <a href="../../guides/getallsecrets/" class="md-nav__link">
  447. Find Secrets by Name or Metadata
  448. </a>
  449. </li>
  450. <li class="md-nav__item">
  451. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  452. Rewriting Keys
  453. </a>
  454. </li>
  455. <li class="md-nav__item md-nav__item--nested">
  456. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  457. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  458. Advanced Templating
  459. <span class="md-nav__icon md-icon"></span>
  460. </label>
  461. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  462. <label class="md-nav__title" for="__nav_3_2_4">
  463. <span class="md-nav__icon md-icon"></span>
  464. Advanced Templating
  465. </label>
  466. <ul class="md-nav__list" data-md-scrollfix>
  467. <li class="md-nav__item">
  468. <a href="../../guides/templating/" class="md-nav__link">
  469. v2
  470. </a>
  471. </li>
  472. <li class="md-nav__item">
  473. <a href="../../guides/templating-v1/" class="md-nav__link">
  474. v1
  475. </a>
  476. </li>
  477. </ul>
  478. </nav>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  482. Kubernetes Secret Types
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  487. Lifecycle: ownership & deletion
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  492. Decoding Strategies
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../../guides/controller-class/" class="md-nav__link">
  497. Controller Classes
  498. </a>
  499. </li>
  500. </ul>
  501. </nav>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="../../guides/generator/" class="md-nav__link">
  505. Generators
  506. </a>
  507. </li>
  508. <li class="md-nav__item md-nav__item--nested">
  509. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
  510. <label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
  511. Operations
  512. <span class="md-nav__icon md-icon"></span>
  513. </label>
  514. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
  515. <label class="md-nav__title" for="__nav_3_4">
  516. <span class="md-nav__icon md-icon"></span>
  517. Operations
  518. </label>
  519. <ul class="md-nav__list" data-md-scrollfix>
  520. <li class="md-nav__item">
  521. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  522. Multi Tenancy
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../../guides/security-best-practices/" class="md-nav__link">
  527. Security Best Practices
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../../guides/threat-model/" class="md-nav__link">
  532. Threat Model
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="../../guides/v1beta1/" class="md-nav__link">
  537. Upgrading to v1beta1
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="../../guides/using-latest-image/" class="md-nav__link">
  542. Using Latest Image
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  547. Disable Cluster Features
  548. </a>
  549. </li>
  550. </ul>
  551. </nav>
  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 md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  558. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  559. Provider
  560. <span class="md-nav__icon md-icon"></span>
  561. </label>
  562. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  563. <label class="md-nav__title" for="__nav_4">
  564. <span class="md-nav__icon md-icon"></span>
  565. Provider
  566. </label>
  567. <ul class="md-nav__list" data-md-scrollfix>
  568. <li class="md-nav__item">
  569. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  570. AWS Secrets Manager
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  575. AWS Parameter Store
  576. </a>
  577. </li>
  578. <li class="md-nav__item">
  579. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  580. Azure Key Vault
  581. </a>
  582. </li>
  583. <li class="md-nav__item">
  584. <a href="../../provider/conjur/" class="md-nav__link">
  585. CyberArk Conjur
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  590. Google Cloud Secret Manager
  591. </a>
  592. </li>
  593. <li class="md-nav__item">
  594. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  595. HashiCorp Vault
  596. </a>
  597. </li>
  598. <li class="md-nav__item">
  599. <a href="../../provider/kubernetes/" class="md-nav__link">
  600. Kubernetes
  601. </a>
  602. </li>
  603. <li class="md-nav__item">
  604. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  605. IBM Secrets Manager
  606. </a>
  607. </li>
  608. <li class="md-nav__item">
  609. <a href="../../provider/akeyless/" class="md-nav__link">
  610. Akeyless
  611. </a>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  615. Yandex Certificate Manager
  616. </a>
  617. </li>
  618. <li class="md-nav__item">
  619. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  620. Yandex Lockbox
  621. </a>
  622. </li>
  623. <li class="md-nav__item">
  624. <a href="../../provider/alibaba/" class="md-nav__link">
  625. Alibaba Cloud
  626. </a>
  627. </li>
  628. <li class="md-nav__item">
  629. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  630. GitLab Variables
  631. </a>
  632. </li>
  633. <li class="md-nav__item">
  634. <a href="../../provider/oracle-vault/" class="md-nav__link">
  635. Oracle Vault
  636. </a>
  637. </li>
  638. <li class="md-nav__item">
  639. <a href="../../provider/1password-automation/" class="md-nav__link">
  640. 1Password Secrets Automation
  641. </a>
  642. </li>
  643. <li class="md-nav__item">
  644. <a href="../../provider/webhook/" class="md-nav__link">
  645. Webhook
  646. </a>
  647. </li>
  648. <li class="md-nav__item">
  649. <a href="../../provider/fake/" class="md-nav__link">
  650. Fake
  651. </a>
  652. </li>
  653. <li class="md-nav__item">
  654. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  655. senhasegura DevOps Secrets Management (DSM)
  656. </a>
  657. </li>
  658. <li class="md-nav__item">
  659. <a href="../../provider/doppler/" class="md-nav__link">
  660. Doppler
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="../../provider/keeper-security/" class="md-nav__link">
  665. Keeper Security
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../../provider/cloak/" class="md-nav__link">
  670. Cloak End 2 End Encrypted Secrets
  671. </a>
  672. </li>
  673. <li class="md-nav__item">
  674. <a href="../../provider/scaleway/" class="md-nav__link">
  675. Scaleway
  676. </a>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="../../provider/delinea/" class="md-nav__link">
  680. Delinea
  681. </a>
  682. </li>
  683. </ul>
  684. </nav>
  685. </li>
  686. <li class="md-nav__item md-nav__item--nested">
  687. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  688. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  689. Examples
  690. <span class="md-nav__icon md-icon"></span>
  691. </label>
  692. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  693. <label class="md-nav__title" for="__nav_5">
  694. <span class="md-nav__icon md-icon"></span>
  695. Examples
  696. </label>
  697. <ul class="md-nav__list" data-md-scrollfix>
  698. <li class="md-nav__item">
  699. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  700. FluxCD
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  705. Anchore Engine
  706. </a>
  707. </li>
  708. <li class="md-nav__item">
  709. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  710. Jenkins
  711. </a>
  712. </li>
  713. <li class="md-nav__item">
  714. <a href="../../examples/bitwarden/" class="md-nav__link">
  715. BitWarden
  716. </a>
  717. </li>
  718. </ul>
  719. </nav>
  720. </li>
  721. <li class="md-nav__item md-nav__item--nested">
  722. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  723. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  724. Community
  725. <span class="md-nav__icon md-icon"></span>
  726. </label>
  727. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  728. <label class="md-nav__title" for="__nav_6">
  729. <span class="md-nav__icon md-icon"></span>
  730. Community
  731. </label>
  732. <ul class="md-nav__list" data-md-scrollfix>
  733. <li class="md-nav__item md-nav__item--nested">
  734. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  735. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  736. Contributing
  737. <span class="md-nav__icon md-icon"></span>
  738. </label>
  739. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  740. <label class="md-nav__title" for="__nav_6_1">
  741. <span class="md-nav__icon md-icon"></span>
  742. Contributing
  743. </label>
  744. <ul class="md-nav__list" data-md-scrollfix>
  745. <li class="md-nav__item">
  746. <a href="../../contributing/devguide/" class="md-nav__link">
  747. Developer guide
  748. </a>
  749. </li>
  750. <li class="md-nav__item">
  751. <a href="../../contributing/process/" class="md-nav__link">
  752. Contributing Process
  753. </a>
  754. </li>
  755. <li class="md-nav__item">
  756. <a href="../../contributing/release/" class="md-nav__link">
  757. Release Process
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="../../contributing/coc/" class="md-nav__link">
  762. Code of Conduct
  763. </a>
  764. </li>
  765. <li class="md-nav__item">
  766. <a href="../../contributing/roadmap/" class="md-nav__link">
  767. Roadmap
  768. </a>
  769. </li>
  770. </ul>
  771. </nav>
  772. </li>
  773. <li class="md-nav__item md-nav__item--nested">
  774. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  775. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  776. External Resources
  777. <span class="md-nav__icon md-icon"></span>
  778. </label>
  779. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  780. <label class="md-nav__title" for="__nav_6_2">
  781. <span class="md-nav__icon md-icon"></span>
  782. External Resources
  783. </label>
  784. <ul class="md-nav__list" data-md-scrollfix>
  785. <li class="md-nav__item">
  786. <a href="../../eso-talks/" class="md-nav__link">
  787. Talks
  788. </a>
  789. </li>
  790. <li class="md-nav__item">
  791. <a href="../../eso-demos/" class="md-nav__link">
  792. Demos
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="../../eso-blogs/" class="md-nav__link">
  797. Blogs
  798. </a>
  799. </li>
  800. </ul>
  801. </nav>
  802. </li>
  803. </ul>
  804. </nav>
  805. </li>
  806. </ul>
  807. </nav>
  808. </div>
  809. </div>
  810. </div>
  811. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  812. <div class="md-sidebar__scrollwrap">
  813. <div class="md-sidebar__inner">
  814. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  815. <label class="md-nav__title" for="__toc">
  816. <span class="md-nav__icon md-icon"></span>
  817. Table of contents
  818. </label>
  819. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  820. <li class="md-nav__item">
  821. <a href="#installing-with-helm" class="md-nav__link">
  822. Installing with Helm
  823. </a>
  824. <nav class="md-nav" aria-label="Installing with Helm">
  825. <ul class="md-nav__list">
  826. <li class="md-nav__item">
  827. <a href="#option-1-install-from-chart-repository" class="md-nav__link">
  828. Option 1: Install from chart repository
  829. </a>
  830. </li>
  831. <li class="md-nav__item">
  832. <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
  833. Option 2: Install chart from local build
  834. </a>
  835. </li>
  836. <li class="md-nav__item">
  837. <a href="#create-a-secret-containing-your-aws-credentials" class="md-nav__link">
  838. Create a secret containing your AWS credentials
  839. </a>
  840. </li>
  841. <li class="md-nav__item">
  842. <a href="#create-your-first-secretstore" class="md-nav__link">
  843. Create your first SecretStore
  844. </a>
  845. </li>
  846. <li class="md-nav__item">
  847. <a href="#create-your-first-externalsecret" class="md-nav__link">
  848. Create your first ExternalSecret
  849. </a>
  850. </li>
  851. </ul>
  852. </nav>
  853. </li>
  854. <li class="md-nav__item">
  855. <a href="#installing-with-olm" class="md-nav__link">
  856. Installing with OLM
  857. </a>
  858. </li>
  859. <li class="md-nav__item">
  860. <a href="#uninstalling" class="md-nav__link">
  861. Uninstalling
  862. </a>
  863. <nav class="md-nav" aria-label="Uninstalling">
  864. <ul class="md-nav__list">
  865. <li class="md-nav__item">
  866. <a href="#uninstalling-with-helm" class="md-nav__link">
  867. Uninstalling with Helm
  868. </a>
  869. </li>
  870. </ul>
  871. </nav>
  872. </li>
  873. </ul>
  874. </nav>
  875. </div>
  876. </div>
  877. </div>
  878. <div class="md-content" data-md-component="content">
  879. <article class="md-content__inner md-typeset">
  880. <h1 id="getting-started">Getting started</h1>
  881. <p>External-secrets runs within your Kubernetes cluster as a deployment resource.
  882. It utilizes CustomResourceDefinitions to configure access to secret providers through SecretStore resources
  883. and manages Kubernetes secret resources with ExternalSecret resources.</p>
  884. <blockquote>
  885. <p>Note: The minimum supported version of Kubernetes is <code>1.16.0</code>. Users still running Kubernetes v1.15 or below should upgrade
  886. to a supported version before installing external-secrets.</p>
  887. </blockquote>
  888. <h2 id="installing-with-helm">Installing with Helm</h2>
  889. <p>The default install options will automatically install and manage the CRDs as part of your helm release. If you do not want the CRDs to be automatically upgraded and managed, you must set the <code>installCRDs</code> option to <code>false</code>. (e.g. <code>--set installCRDS=false</code>)</p>
  890. <p>Uncomment the relevant line in the next steps to disable the automatic install of CRDs.</p>
  891. <h3 id="option-1-install-from-chart-repository">Option 1: Install from chart repository</h3>
  892. <div class="highlight"><pre><span></span><code>helm<span class="w"> </span>repo<span class="w"> </span>add<span class="w"> </span>external-secrets<span class="w"> </span>https://charts.external-secrets.io
  893. helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  894. <span class="w"> </span>external-secrets/external-secrets<span class="w"> </span><span class="se">\</span>
  895. <span class="w"> </span>-n<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  896. <span class="w"> </span>--create-namespace<span class="w"> </span><span class="se">\</span>
  897. <span class="w"> </span><span class="c1"># --set installCRDs=false</span>
  898. </code></pre></div>
  899. <h3 id="option-2-install-chart-from-local-build">Option 2: Install chart from local build</h3>
  900. <p>Build and install the Helm chart locally after cloning the repository.</p>
  901. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>helm.build
  902. helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  903. <span class="w"> </span>./bin/chart/external-secrets.tgz<span class="w"> </span><span class="se">\</span>
  904. <span class="w"> </span>-n<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  905. <span class="w"> </span>--create-namespace<span class="w"> </span><span class="se">\</span>
  906. <span class="w"> </span><span class="c1"># --set installCRDs=false</span>
  907. </code></pre></div>
  908. <h3 id="create-a-secret-containing-your-aws-credentials">Create a secret containing your AWS credentials</h3>
  909. <div class="highlight"><pre><span></span><code><span class="nb">echo</span><span class="w"> </span>-n<span class="w"> </span><span class="s1">&#39;KEYID&#39;</span><span class="w"> </span>&gt;<span class="w"> </span>./access-key
  910. <span class="nb">echo</span><span class="w"> </span>-n<span class="w"> </span><span class="s1">&#39;SECRETKEY&#39;</span><span class="w"> </span>&gt;<span class="w"> </span>./secret-access-key
  911. kubectl<span class="w"> </span>create<span class="w"> </span>secret<span class="w"> </span>generic<span class="w"> </span>awssm-secret<span class="w"> </span>--from-file<span class="o">=</span>./access-key<span class="w"> </span>--from-file<span class="o">=</span>./secret-access-key
  912. </code></pre></div>
  913. <h3 id="create-your-first-secretstore">Create your first SecretStore</h3>
  914. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  915. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  916. <span class="nt">metadata</span><span class="p">:</span>
  917. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secretstore-sample</span>
  918. <span class="nt">spec</span><span class="p">:</span>
  919. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  920. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  921. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  922. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">us-east-1</span>
  923. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  924. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  925. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  926. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  927. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">access-key</span>
  928. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  929. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  930. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-access-key</span>
  931. </code></pre></div>
  932. <h3 id="create-your-first-externalsecret">Create your first ExternalSecret</h3>
  933. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  934. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  935. <span class="nt">metadata</span><span class="p">:</span>
  936. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
  937. <span class="nt">spec</span><span class="p">:</span>
  938. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span>
  939. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  940. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secretstore-sample</span>
  941. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  942. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  943. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-to-be-created</span>
  944. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Owner</span>
  945. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  946. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-key-to-be-managed</span>
  947. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  948. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">provider-key</span>
  949. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">provider-key-version</span>
  950. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">provider-key-property</span>
  951. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  952. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  953. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">remote-key-in-the-provider</span>
  954. </code></pre></div>
  955. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>describe<span class="w"> </span>externalsecret<span class="w"> </span>example
  956. <span class="c1"># [...]</span>
  957. Name:<span class="w"> </span>example
  958. Status:
  959. <span class="w"> </span>Binding:
  960. <span class="w"> </span>Name:<span class="w"> </span>secret-to-be-created
  961. <span class="w"> </span>Conditions:
  962. <span class="w"> </span>Last<span class="w"> </span>Transition<span class="w"> </span>Time:<span class="w"> </span><span class="m">2021</span>-02-24T16:45:23Z
  963. <span class="w"> </span>Message:<span class="w"> </span>Secret<span class="w"> </span>was<span class="w"> </span>synced
  964. <span class="w"> </span>Reason:<span class="w"> </span>SecretSynced
  965. <span class="w"> </span>Status:<span class="w"> </span>True
  966. <span class="w"> </span>Type:<span class="w"> </span>Ready
  967. <span class="w"> </span>Refresh<span class="w"> </span>Time:<span class="w"> </span><span class="m">2021</span>-02-24T16:45:24Z
  968. Events:<span class="w"> </span>&lt;none&gt;
  969. </code></pre></div>
  970. <p>For more advanced examples, please read the other
  971. <a href="../../guides/introduction/">guides</a>.</p>
  972. <h2 id="installing-with-olm">Installing with OLM</h2>
  973. <p>External-secrets can be managed by <a href="https://olm.operatorframework.io/">Operator Lifecycle Manager</a> (OLM) via an installer operator. It is made available through <a href="https://operatorhub.io/">OperatorHub.io</a>, this installation method is suited best for OpenShift. See installation instructions on the <a href="https://operatorhub.io/operator/external-secrets-operator">external-secrets-operator</a> package.</p>
  974. <h2 id="uninstalling">Uninstalling</h2>
  975. <p>Before continuing, ensure that all external-secret resources that have been created by users have been deleted.
  976. You can check for any existing resources with the following command:</p>
  977. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>get<span class="w"> </span>SecretStores,ClusterSecretStores,ExternalSecrets<span class="w"> </span>--all-namespaces
  978. </code></pre></div>
  979. <p>Once all these resources have been deleted you are ready to uninstall external-secrets.</p>
  980. <h3 id="uninstalling-with-helm">Uninstalling with Helm</h3>
  981. <p>Uninstall the helm release using the delete command.</p>
  982. <div class="highlight"><pre><span></span><code>helm<span class="w"> </span>delete<span class="w"> </span>external-secrets<span class="w"> </span>--namespace<span class="w"> </span>external-secrets
  983. </code></pre></div>
  984. </article>
  985. </div>
  986. </div>
  987. </main>
  988. <footer class="md-footer">
  989. <div class="md-footer-meta md-typeset">
  990. <div class="md-footer-meta__inner md-grid">
  991. <div class="md-copyright">
  992. <div class="md-copyright__highlight">
  993. &copy; 2023 The external-secrets Authors.<br/>
  994. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  995. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  996. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  997. </div>
  998. Made with
  999. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1000. Material for MkDocs
  1001. </a>
  1002. </div>
  1003. </div>
  1004. </div>
  1005. </footer>
  1006. </div>
  1007. <div class="md-dialog" data-md-component="dialog">
  1008. <div class="md-dialog__inner md-typeset"></div>
  1009. </div>
  1010. <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>
  1011. <script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
  1012. </body>
  1013. </html>