index.html 53 KB

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