index.html 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915
  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. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href=".." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../api-overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../api-externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../api-secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../api-clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. <li class="md-nav__item">
  166. <a href="../api-clusterexternalsecret/" class="md-nav__link">
  167. ClusterExternalSecret
  168. </a>
  169. </li>
  170. </ul>
  171. </nav>
  172. </li>
  173. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  174. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
  175. <label class="md-nav__link" for="__nav_4">
  176. Guides
  177. <span class="md-nav__icon md-icon"></span>
  178. </label>
  179. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  180. <label class="md-nav__title" for="__nav_4">
  181. <span class="md-nav__icon md-icon"></span>
  182. Guides
  183. </label>
  184. <ul class="md-nav__list" data-md-scrollfix>
  185. <li class="md-nav__item">
  186. <a href="../guides-introduction/" class="md-nav__link">
  187. Introduction
  188. </a>
  189. </li>
  190. <li class="md-nav__item md-nav__item--active">
  191. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  192. <label class="md-nav__link md-nav__link--active" for="__toc">
  193. Getting started
  194. <span class="md-nav__icon md-icon"></span>
  195. </label>
  196. <a href="./" class="md-nav__link md-nav__link--active">
  197. Getting started
  198. </a>
  199. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  200. <label class="md-nav__title" for="__toc">
  201. <span class="md-nav__icon md-icon"></span>
  202. Table of contents
  203. </label>
  204. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  205. <li class="md-nav__item">
  206. <a href="#installing-with-helm" class="md-nav__link">
  207. Installing with Helm
  208. </a>
  209. <nav class="md-nav" aria-label="Installing with Helm">
  210. <ul class="md-nav__list">
  211. <li class="md-nav__item">
  212. <a href="#option-1-install-from-chart-repository" class="md-nav__link">
  213. Option 1: Install from chart repository
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
  218. Option 2: Install chart from local build
  219. </a>
  220. </li>
  221. <li class="md-nav__item">
  222. <a href="#create-a-secret-containing-your-aws-credentials" class="md-nav__link">
  223. Create a secret containing your AWS credentials
  224. </a>
  225. </li>
  226. <li class="md-nav__item">
  227. <a href="#create-your-first-secretstore" class="md-nav__link">
  228. Create your first SecretStore
  229. </a>
  230. </li>
  231. <li class="md-nav__item">
  232. <a href="#create-your-first-externalsecret" class="md-nav__link">
  233. Create your first ExternalSecret
  234. </a>
  235. </li>
  236. </ul>
  237. </nav>
  238. </li>
  239. <li class="md-nav__item">
  240. <a href="#installing-with-olm" class="md-nav__link">
  241. Installing with OLM
  242. </a>
  243. </li>
  244. <li class="md-nav__item">
  245. <a href="#uninstalling" class="md-nav__link">
  246. Uninstalling
  247. </a>
  248. <nav class="md-nav" aria-label="Uninstalling">
  249. <ul class="md-nav__list">
  250. <li class="md-nav__item">
  251. <a href="#uninstalling-with-helm" class="md-nav__link">
  252. Uninstalling with Helm
  253. </a>
  254. </li>
  255. </ul>
  256. </nav>
  257. </li>
  258. </ul>
  259. </nav>
  260. </li>
  261. <li class="md-nav__item md-nav__item--nested">
  262. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  263. <label class="md-nav__link" for="__nav_4_3">
  264. Advanced Templating
  265. <span class="md-nav__icon md-icon"></span>
  266. </label>
  267. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  268. <label class="md-nav__title" for="__nav_4_3">
  269. <span class="md-nav__icon md-icon"></span>
  270. Advanced Templating
  271. </label>
  272. <ul class="md-nav__list" data-md-scrollfix>
  273. <li class="md-nav__item">
  274. <a href="../guides-templating/" class="md-nav__link">
  275. v2
  276. </a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="../guides-templating-v1/" class="md-nav__link">
  280. v1
  281. </a>
  282. </li>
  283. </ul>
  284. </nav>
  285. </li>
  286. <li class="md-nav__item">
  287. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  288. All keys, One secret
  289. </a>
  290. </li>
  291. <li class="md-nav__item">
  292. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  293. Common K8S Secret Types
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../guides-controller-class/" class="md-nav__link">
  298. Controller Classes
  299. </a>
  300. </li>
  301. <li class="md-nav__item">
  302. <a href="../guides-ownership-deletion-policy/" class="md-nav__link">
  303. Lifecycle: ownership & deletion
  304. </a>
  305. </li>
  306. <li class="md-nav__item">
  307. <a href="../guides-decoding-strategy/" class="md-nav__link">
  308. Decoding Strategies
  309. </a>
  310. </li>
  311. <li class="md-nav__item">
  312. <a href="../guides-getallsecrets/" class="md-nav__link">
  313. Getting Multiple Secrets
  314. </a>
  315. </li>
  316. <li class="md-nav__item">
  317. <a href="../guides-multi-tenancy/" class="md-nav__link">
  318. Multi Tenancy
  319. </a>
  320. </li>
  321. <li class="md-nav__item">
  322. <a href="../guides-metrics/" class="md-nav__link">
  323. Metrics
  324. </a>
  325. </li>
  326. <li class="md-nav__item">
  327. <a href="../guides-v1beta1/" class="md-nav__link">
  328. Upgrading to v1beta1
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="../guides-using-latest-image/" class="md-nav__link">
  333. Using Latest Image
  334. </a>
  335. </li>
  336. </ul>
  337. </nav>
  338. </li>
  339. <li class="md-nav__item md-nav__item--nested">
  340. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  341. <label class="md-nav__link" for="__nav_5">
  342. Provider
  343. <span class="md-nav__icon md-icon"></span>
  344. </label>
  345. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  346. <label class="md-nav__title" for="__nav_5">
  347. <span class="md-nav__icon md-icon"></span>
  348. Provider
  349. </label>
  350. <ul class="md-nav__list" data-md-scrollfix>
  351. <li class="md-nav__item md-nav__item--nested">
  352. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  353. <label class="md-nav__link" for="__nav_5_1">
  354. AWS
  355. <span class="md-nav__icon md-icon"></span>
  356. </label>
  357. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  358. <label class="md-nav__title" for="__nav_5_1">
  359. <span class="md-nav__icon md-icon"></span>
  360. AWS
  361. </label>
  362. <ul class="md-nav__list" data-md-scrollfix>
  363. <li class="md-nav__item">
  364. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  365. Secrets Manager
  366. </a>
  367. </li>
  368. <li class="md-nav__item">
  369. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  370. Parameter Store
  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_5_2" type="checkbox" id="__nav_5_2" >
  378. <label class="md-nav__link" for="__nav_5_2">
  379. Azure
  380. <span class="md-nav__icon md-icon"></span>
  381. </label>
  382. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  383. <label class="md-nav__title" for="__nav_5_2">
  384. <span class="md-nav__icon md-icon"></span>
  385. Azure
  386. </label>
  387. <ul class="md-nav__list" data-md-scrollfix>
  388. <li class="md-nav__item">
  389. <a href="../provider-azure-key-vault/" class="md-nav__link">
  390. Key Vault
  391. </a>
  392. </li>
  393. </ul>
  394. </nav>
  395. </li>
  396. <li class="md-nav__item md-nav__item--nested">
  397. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  398. <label class="md-nav__link" for="__nav_5_3">
  399. Google
  400. <span class="md-nav__icon md-icon"></span>
  401. </label>
  402. <nav class="md-nav" aria-label="Google" data-md-level="2">
  403. <label class="md-nav__title" for="__nav_5_3">
  404. <span class="md-nav__icon md-icon"></span>
  405. Google
  406. </label>
  407. <ul class="md-nav__list" data-md-scrollfix>
  408. <li class="md-nav__item">
  409. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  410. Secret Manager
  411. </a>
  412. </li>
  413. </ul>
  414. </nav>
  415. </li>
  416. <li class="md-nav__item md-nav__item--nested">
  417. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  418. <label class="md-nav__link" for="__nav_5_4">
  419. IBM
  420. <span class="md-nav__icon md-icon"></span>
  421. </label>
  422. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  423. <label class="md-nav__title" for="__nav_5_4">
  424. <span class="md-nav__icon md-icon"></span>
  425. IBM
  426. </label>
  427. <ul class="md-nav__list" data-md-scrollfix>
  428. <li class="md-nav__item">
  429. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  430. Secrets Manager
  431. </a>
  432. </li>
  433. </ul>
  434. </nav>
  435. </li>
  436. <li class="md-nav__item">
  437. <a href="../provider-akeyless/" class="md-nav__link">
  438. Akeyless
  439. </a>
  440. </li>
  441. <li class="md-nav__item">
  442. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  443. HashiCorp Vault
  444. </a>
  445. </li>
  446. <li class="md-nav__item md-nav__item--nested">
  447. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  448. <label class="md-nav__link" for="__nav_5_7">
  449. Yandex
  450. <span class="md-nav__icon md-icon"></span>
  451. </label>
  452. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  453. <label class="md-nav__title" for="__nav_5_7">
  454. <span class="md-nav__icon md-icon"></span>
  455. Yandex
  456. </label>
  457. <ul class="md-nav__list" data-md-scrollfix>
  458. <li class="md-nav__item">
  459. <a href="../provider-yandex-certificate-manager/" class="md-nav__link">
  460. Certificate Manager
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  465. Lockbox
  466. </a>
  467. </li>
  468. </ul>
  469. </nav>
  470. </li>
  471. <li class="md-nav__item md-nav__item--nested">
  472. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  473. <label class="md-nav__link" for="__nav_5_8">
  474. Gitlab
  475. <span class="md-nav__icon md-icon"></span>
  476. </label>
  477. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  478. <label class="md-nav__title" for="__nav_5_8">
  479. <span class="md-nav__icon md-icon"></span>
  480. Gitlab
  481. </label>
  482. <ul class="md-nav__list" data-md-scrollfix>
  483. <li class="md-nav__item">
  484. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  485. Gitlab Project Variables
  486. </a>
  487. </li>
  488. </ul>
  489. </nav>
  490. </li>
  491. <li class="md-nav__item md-nav__item--nested">
  492. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  493. <label class="md-nav__link" for="__nav_5_9">
  494. Oracle
  495. <span class="md-nav__icon md-icon"></span>
  496. </label>
  497. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  498. <label class="md-nav__title" for="__nav_5_9">
  499. <span class="md-nav__icon md-icon"></span>
  500. Oracle
  501. </label>
  502. <ul class="md-nav__list" data-md-scrollfix>
  503. <li class="md-nav__item">
  504. <a href="../provider-oracle-vault/" class="md-nav__link">
  505. Oracle Vault
  506. </a>
  507. </li>
  508. </ul>
  509. </nav>
  510. </li>
  511. <li class="md-nav__item md-nav__item--nested">
  512. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  513. <label class="md-nav__link" for="__nav_5_10">
  514. 1Password
  515. <span class="md-nav__icon md-icon"></span>
  516. </label>
  517. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  518. <label class="md-nav__title" for="__nav_5_10">
  519. <span class="md-nav__icon md-icon"></span>
  520. 1Password
  521. </label>
  522. <ul class="md-nav__list" data-md-scrollfix>
  523. <li class="md-nav__item">
  524. <a href="../provider-1password-automation/" class="md-nav__link">
  525. Secrets Automation
  526. </a>
  527. </li>
  528. </ul>
  529. </nav>
  530. </li>
  531. <li class="md-nav__item">
  532. <a href="../provider-webhook/" class="md-nav__link">
  533. Webhook
  534. </a>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="../provider-fake/" class="md-nav__link">
  538. Fake
  539. </a>
  540. </li>
  541. <li class="md-nav__item">
  542. <a href="../provider-kubernetes/" class="md-nav__link">
  543. Kubernetes
  544. </a>
  545. </li>
  546. <li class="md-nav__item md-nav__item--nested">
  547. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  548. <label class="md-nav__link" for="__nav_5_14">
  549. senhasegura
  550. <span class="md-nav__icon md-icon"></span>
  551. </label>
  552. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  553. <label class="md-nav__title" for="__nav_5_14">
  554. <span class="md-nav__icon md-icon"></span>
  555. senhasegura
  556. </label>
  557. <ul class="md-nav__list" data-md-scrollfix>
  558. <li class="md-nav__item">
  559. <a href="../provider-senhasegura-dsm/" class="md-nav__link">
  560. DevOps Secrets Management (DSM)
  561. </a>
  562. </li>
  563. </ul>
  564. </nav>
  565. </li>
  566. </ul>
  567. </nav>
  568. </li>
  569. <li class="md-nav__item md-nav__item--nested">
  570. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  571. <label class="md-nav__link" for="__nav_6">
  572. Examples
  573. <span class="md-nav__icon md-icon"></span>
  574. </label>
  575. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  576. <label class="md-nav__title" for="__nav_6">
  577. <span class="md-nav__icon md-icon"></span>
  578. Examples
  579. </label>
  580. <ul class="md-nav__list" data-md-scrollfix>
  581. <li class="md-nav__item">
  582. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  583. FluxCD
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  588. Anchore Engine
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  593. Jenkins
  594. </a>
  595. </li>
  596. </ul>
  597. </nav>
  598. </li>
  599. <li class="md-nav__item md-nav__item--nested">
  600. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  601. <label class="md-nav__link" for="__nav_7">
  602. External Resources
  603. <span class="md-nav__icon md-icon"></span>
  604. </label>
  605. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  606. <label class="md-nav__title" for="__nav_7">
  607. <span class="md-nav__icon md-icon"></span>
  608. External Resources
  609. </label>
  610. <ul class="md-nav__list" data-md-scrollfix>
  611. <li class="md-nav__item">
  612. <a href="../eso-talks/" class="md-nav__link">
  613. Talks
  614. </a>
  615. </li>
  616. <li class="md-nav__item">
  617. <a href="../eso-demos/" class="md-nav__link">
  618. Demos
  619. </a>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../eso-blogs/" class="md-nav__link">
  623. Blogs
  624. </a>
  625. </li>
  626. </ul>
  627. </nav>
  628. </li>
  629. <li class="md-nav__item md-nav__item--nested">
  630. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  631. <label class="md-nav__link" for="__nav_8">
  632. References
  633. <span class="md-nav__icon md-icon"></span>
  634. </label>
  635. <nav class="md-nav" aria-label="References" data-md-level="1">
  636. <label class="md-nav__title" for="__nav_8">
  637. <span class="md-nav__icon md-icon"></span>
  638. References
  639. </label>
  640. <ul class="md-nav__list" data-md-scrollfix>
  641. <li class="md-nav__item">
  642. <a href="../spec/" class="md-nav__link">
  643. API specification
  644. </a>
  645. </li>
  646. </ul>
  647. </nav>
  648. </li>
  649. <li class="md-nav__item md-nav__item--nested">
  650. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  651. <label class="md-nav__link" for="__nav_9">
  652. Contributing
  653. <span class="md-nav__icon md-icon"></span>
  654. </label>
  655. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  656. <label class="md-nav__title" for="__nav_9">
  657. <span class="md-nav__icon md-icon"></span>
  658. Contributing
  659. </label>
  660. <ul class="md-nav__list" data-md-scrollfix>
  661. <li class="md-nav__item">
  662. <a href="../contributing-devguide/" class="md-nav__link">
  663. Developer guide
  664. </a>
  665. </li>
  666. <li class="md-nav__item">
  667. <a href="../contributing-process/" class="md-nav__link">
  668. Contributing Process
  669. </a>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="../contributing-release/" class="md-nav__link">
  673. Release Process
  674. </a>
  675. </li>
  676. <li class="md-nav__item">
  677. <a href="../contributing-coc/" class="md-nav__link">
  678. Code of Conduct
  679. </a>
  680. </li>
  681. </ul>
  682. </nav>
  683. </li>
  684. <li class="md-nav__item">
  685. <a href="../roadmap/" class="md-nav__link">
  686. Roadmap
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../faq/" class="md-nav__link">
  691. FAQ
  692. </a>
  693. </li>
  694. <li class="md-nav__item">
  695. <a href="../stability-support/" class="md-nav__link">
  696. Stability and Support
  697. </a>
  698. </li>
  699. <li class="md-nav__item">
  700. <a href="../deprecation-policy/" class="md-nav__link">
  701. Deprecation Policy
  702. </a>
  703. </li>
  704. </ul>
  705. </nav>
  706. </div>
  707. </div>
  708. </div>
  709. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  710. <div class="md-sidebar__scrollwrap">
  711. <div class="md-sidebar__inner">
  712. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  713. <label class="md-nav__title" for="__toc">
  714. <span class="md-nav__icon md-icon"></span>
  715. Table of contents
  716. </label>
  717. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  718. <li class="md-nav__item">
  719. <a href="#installing-with-helm" class="md-nav__link">
  720. Installing with Helm
  721. </a>
  722. <nav class="md-nav" aria-label="Installing with Helm">
  723. <ul class="md-nav__list">
  724. <li class="md-nav__item">
  725. <a href="#option-1-install-from-chart-repository" class="md-nav__link">
  726. Option 1: Install from chart repository
  727. </a>
  728. </li>
  729. <li class="md-nav__item">
  730. <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
  731. Option 2: Install chart from local build
  732. </a>
  733. </li>
  734. <li class="md-nav__item">
  735. <a href="#create-a-secret-containing-your-aws-credentials" class="md-nav__link">
  736. Create a secret containing your AWS credentials
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="#create-your-first-secretstore" class="md-nav__link">
  741. Create your first SecretStore
  742. </a>
  743. </li>
  744. <li class="md-nav__item">
  745. <a href="#create-your-first-externalsecret" class="md-nav__link">
  746. Create your first ExternalSecret
  747. </a>
  748. </li>
  749. </ul>
  750. </nav>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="#installing-with-olm" class="md-nav__link">
  754. Installing with OLM
  755. </a>
  756. </li>
  757. <li class="md-nav__item">
  758. <a href="#uninstalling" class="md-nav__link">
  759. Uninstalling
  760. </a>
  761. <nav class="md-nav" aria-label="Uninstalling">
  762. <ul class="md-nav__list">
  763. <li class="md-nav__item">
  764. <a href="#uninstalling-with-helm" class="md-nav__link">
  765. Uninstalling with Helm
  766. </a>
  767. </li>
  768. </ul>
  769. </nav>
  770. </li>
  771. </ul>
  772. </nav>
  773. </div>
  774. </div>
  775. </div>
  776. <div class="md-content" data-md-component="content">
  777. <article class="md-content__inner md-typeset">
  778. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/guides-getting-started.md" title="Edit this page" class="md-content__button md-icon">
  779. <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>
  780. </a>
  781. <h1 id="getting-started">Getting started</h1>
  782. <p>External-secrets runs within your Kubernetes cluster as a deployment resource.
  783. It utilizes CustomResourceDefinitions to configure access to secret providers through SecretStore resources
  784. and manages Kubernetes secret resources with ExternalSecret resources.</p>
  785. <blockquote>
  786. <p>Note: The minimum supported version of Kubernetes is <code>1.16.0</code>. Users still running Kubernetes v1.15 or below should upgrade
  787. to a supported version before installing external-secrets.</p>
  788. </blockquote>
  789. <h2 id="installing-with-helm">Installing with Helm</h2>
  790. <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>
  791. <p>Uncomment the relevant line in the next steps to enable this.</p>
  792. <h3 id="option-1-install-from-chart-repository">Option 1: Install from chart repository</h3>
  793. <div class="highlight"><pre><span></span><code>helm repo add external-secrets https://charts.external-secrets.io
  794. helm install external-secrets <span class="se">\</span>
  795. external-secrets/external-secrets <span class="se">\</span>
  796. -n external-secrets <span class="se">\</span>
  797. --create-namespace <span class="se">\</span>
  798. <span class="c1"># --set installCRDs=true</span>
  799. </code></pre></div>
  800. <h3 id="option-2-install-chart-from-local-build">Option 2: Install chart from local build</h3>
  801. <p>Build and install the Helm chart locally after cloning the repository.</p>
  802. <div class="highlight"><pre><span></span><code>make helm.build
  803. helm install external-secrets <span class="se">\</span>
  804. ./bin/chart/external-secrets.tgz <span class="se">\</span>
  805. -n external-secrets <span class="se">\</span>
  806. --create-namespace <span class="se">\</span>
  807. <span class="c1"># --set installCRDs=true</span>
  808. </code></pre></div>
  809. <h3 id="create-a-secret-containing-your-aws-credentials">Create a secret containing your AWS credentials</h3>
  810. <div class="highlight"><pre><span></span><code><span class="nb">echo</span> -n <span class="s1">&#39;KEYID&#39;</span> &gt; ./access-key
  811. <span class="nb">echo</span> -n <span class="s1">&#39;SECRETKEY&#39;</span> &gt; ./secret-access-key
  812. kubectl create secret generic awssm-secret --from-file<span class="o">=</span>./access-key --from-file<span class="o">=</span>./secret-access-key
  813. </code></pre></div>
  814. <h3 id="create-your-first-secretstore">Create your first SecretStore</h3>
  815. <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>
  816. <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>
  817. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  818. <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>
  819. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  820. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  821. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  822. <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>
  823. <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>
  824. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  825. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  826. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span><span class="w"></span>
  827. <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>
  828. <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>
  829. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  830. <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>
  831. <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>
  832. </code></pre></div>
  833. <h3 id="create-your-first-externalsecret">Create your first ExternalSecret</h3>
  834. <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>
  835. <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>
  836. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  837. <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>
  838. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  839. <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>
  840. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  841. <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>
  842. <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>
  843. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  844. <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>
  845. <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>
  846. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  847. <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>
  848. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  849. <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>
  850. <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>
  851. <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>
  852. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  853. <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>
  854. <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>
  855. </code></pre></div>
  856. <div class="highlight"><pre><span></span><code>kubectl describe externalsecret example
  857. <span class="c1"># [...]</span>
  858. Name: example
  859. Status:
  860. Conditions:
  861. Last Transition Time: <span class="m">2021</span>-02-24T16:45:23Z
  862. Message: Secret was synced
  863. Reason: SecretSynced
  864. Status: True
  865. Type: Ready
  866. Refresh Time: <span class="m">2021</span>-02-24T16:45:24Z
  867. Events: &lt;none&gt;
  868. </code></pre></div>
  869. <p>For more advanced examples, please read the other
  870. <a href="../guides-introduction/">guides</a>.</p>
  871. <h2 id="installing-with-olm">Installing with OLM</h2>
  872. <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>
  873. <h2 id="uninstalling">Uninstalling</h2>
  874. <p>Before continuing, ensure that all external-secret resources that have been created by users have been deleted.
  875. You can check for any existing resources with the following command:</p>
  876. <div class="highlight"><pre><span></span><code>kubectl get SecretStores,ClusterSecretStores,ExternalSecrets --all-namespaces
  877. </code></pre></div>
  878. <p>Once all these resources have been deleted you are ready to uninstall external-secrets.</p>
  879. <h3 id="uninstalling-with-helm">Uninstalling with Helm</h3>
  880. <p>Uninstall the helm release using the delete command.</p>
  881. <div class="highlight"><pre><span></span><code>helm delete external-secrets --namespace external-secrets
  882. </code></pre></div>
  883. </article>
  884. </div>
  885. </div>
  886. </main>
  887. <footer class="md-footer">
  888. <nav class="md-footer__inner md-grid" aria-label="Footer">
  889. <a href="../guides-introduction/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Introduction" rel="prev">
  890. <div class="md-footer__button md-icon">
  891. <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>
  892. </div>
  893. <div class="md-footer__title">
  894. <div class="md-ellipsis">
  895. <span class="md-footer__direction">
  896. Previous
  897. </span>
  898. Introduction
  899. </div>
  900. </div>
  901. </a>
  902. <a href="../guides-templating/" class="md-footer__link md-footer__link--next" aria-label="Next: v2" rel="next">
  903. <div class="md-footer__title">
  904. <div class="md-ellipsis">
  905. <span class="md-footer__direction">
  906. Next
  907. </span>
  908. v2
  909. </div>
  910. </div>
  911. <div class="md-footer__button md-icon">
  912. <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>
  913. </div>
  914. </a>
  915. </nav>
  916. <div class="md-footer-meta md-typeset">
  917. <div class="md-footer-meta__inner md-grid">
  918. <div class="md-copyright">
  919. Made with
  920. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  921. Material for MkDocs
  922. </a>
  923. </div>
  924. </div>
  925. </div>
  926. </footer>
  927. </div>
  928. <div class="md-dialog" data-md-component="dialog">
  929. <div class="md-dialog__inner md-typeset"></div>
  930. </div>
  931. <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  932. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  933. </body>
  934. </html>