index.html 49 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901
  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-getallsecrets/" class="md-nav__link">
  308. Getting Multiple Secrets
  309. </a>
  310. </li>
  311. <li class="md-nav__item">
  312. <a href="../guides-multi-tenancy/" class="md-nav__link">
  313. Multi Tenancy
  314. </a>
  315. </li>
  316. <li class="md-nav__item">
  317. <a href="../guides-metrics/" class="md-nav__link">
  318. Metrics
  319. </a>
  320. </li>
  321. <li class="md-nav__item">
  322. <a href="../guides-v1beta1/" class="md-nav__link">
  323. Upgrading to v1beta1
  324. </a>
  325. </li>
  326. <li class="md-nav__item">
  327. <a href="../guides-using-latest-image/" class="md-nav__link">
  328. Using Latest Image
  329. </a>
  330. </li>
  331. </ul>
  332. </nav>
  333. </li>
  334. <li class="md-nav__item md-nav__item--nested">
  335. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  336. <label class="md-nav__link" for="__nav_5">
  337. Provider
  338. <span class="md-nav__icon md-icon"></span>
  339. </label>
  340. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  341. <label class="md-nav__title" for="__nav_5">
  342. <span class="md-nav__icon md-icon"></span>
  343. Provider
  344. </label>
  345. <ul class="md-nav__list" data-md-scrollfix>
  346. <li class="md-nav__item md-nav__item--nested">
  347. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  348. <label class="md-nav__link" for="__nav_5_1">
  349. AWS
  350. <span class="md-nav__icon md-icon"></span>
  351. </label>
  352. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  353. <label class="md-nav__title" for="__nav_5_1">
  354. <span class="md-nav__icon md-icon"></span>
  355. AWS
  356. </label>
  357. <ul class="md-nav__list" data-md-scrollfix>
  358. <li class="md-nav__item">
  359. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  360. Secrets Manager
  361. </a>
  362. </li>
  363. <li class="md-nav__item">
  364. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  365. Parameter Store
  366. </a>
  367. </li>
  368. </ul>
  369. </nav>
  370. </li>
  371. <li class="md-nav__item md-nav__item--nested">
  372. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  373. <label class="md-nav__link" for="__nav_5_2">
  374. Azure
  375. <span class="md-nav__icon md-icon"></span>
  376. </label>
  377. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  378. <label class="md-nav__title" for="__nav_5_2">
  379. <span class="md-nav__icon md-icon"></span>
  380. Azure
  381. </label>
  382. <ul class="md-nav__list" data-md-scrollfix>
  383. <li class="md-nav__item">
  384. <a href="../provider-azure-key-vault/" class="md-nav__link">
  385. Key Vault
  386. </a>
  387. </li>
  388. </ul>
  389. </nav>
  390. </li>
  391. <li class="md-nav__item md-nav__item--nested">
  392. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  393. <label class="md-nav__link" for="__nav_5_3">
  394. Google
  395. <span class="md-nav__icon md-icon"></span>
  396. </label>
  397. <nav class="md-nav" aria-label="Google" data-md-level="2">
  398. <label class="md-nav__title" for="__nav_5_3">
  399. <span class="md-nav__icon md-icon"></span>
  400. Google
  401. </label>
  402. <ul class="md-nav__list" data-md-scrollfix>
  403. <li class="md-nav__item">
  404. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  405. Secret Manager
  406. </a>
  407. </li>
  408. </ul>
  409. </nav>
  410. </li>
  411. <li class="md-nav__item md-nav__item--nested">
  412. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  413. <label class="md-nav__link" for="__nav_5_4">
  414. IBM
  415. <span class="md-nav__icon md-icon"></span>
  416. </label>
  417. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  418. <label class="md-nav__title" for="__nav_5_4">
  419. <span class="md-nav__icon md-icon"></span>
  420. IBM
  421. </label>
  422. <ul class="md-nav__list" data-md-scrollfix>
  423. <li class="md-nav__item">
  424. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  425. Secrets Manager
  426. </a>
  427. </li>
  428. </ul>
  429. </nav>
  430. </li>
  431. <li class="md-nav__item">
  432. <a href="../provider-akeyless/" class="md-nav__link">
  433. Akeyless
  434. </a>
  435. </li>
  436. <li class="md-nav__item">
  437. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  438. HashiCorp Vault
  439. </a>
  440. </li>
  441. <li class="md-nav__item md-nav__item--nested">
  442. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  443. <label class="md-nav__link" for="__nav_5_7">
  444. Yandex
  445. <span class="md-nav__icon md-icon"></span>
  446. </label>
  447. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  448. <label class="md-nav__title" for="__nav_5_7">
  449. <span class="md-nav__icon md-icon"></span>
  450. Yandex
  451. </label>
  452. <ul class="md-nav__list" data-md-scrollfix>
  453. <li class="md-nav__item">
  454. <a href="../provider-yandex-certificate-manager/" class="md-nav__link">
  455. Certificate Manager
  456. </a>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  460. Lockbox
  461. </a>
  462. </li>
  463. </ul>
  464. </nav>
  465. </li>
  466. <li class="md-nav__item md-nav__item--nested">
  467. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  468. <label class="md-nav__link" for="__nav_5_8">
  469. Gitlab
  470. <span class="md-nav__icon md-icon"></span>
  471. </label>
  472. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  473. <label class="md-nav__title" for="__nav_5_8">
  474. <span class="md-nav__icon md-icon"></span>
  475. Gitlab
  476. </label>
  477. <ul class="md-nav__list" data-md-scrollfix>
  478. <li class="md-nav__item">
  479. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  480. Gitlab Project Variables
  481. </a>
  482. </li>
  483. </ul>
  484. </nav>
  485. </li>
  486. <li class="md-nav__item md-nav__item--nested">
  487. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  488. <label class="md-nav__link" for="__nav_5_9">
  489. Oracle
  490. <span class="md-nav__icon md-icon"></span>
  491. </label>
  492. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  493. <label class="md-nav__title" for="__nav_5_9">
  494. <span class="md-nav__icon md-icon"></span>
  495. Oracle
  496. </label>
  497. <ul class="md-nav__list" data-md-scrollfix>
  498. <li class="md-nav__item">
  499. <a href="../provider-oracle-vault/" class="md-nav__link">
  500. Oracle Vault
  501. </a>
  502. </li>
  503. </ul>
  504. </nav>
  505. </li>
  506. <li class="md-nav__item md-nav__item--nested">
  507. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  508. <label class="md-nav__link" for="__nav_5_10">
  509. 1Password
  510. <span class="md-nav__icon md-icon"></span>
  511. </label>
  512. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  513. <label class="md-nav__title" for="__nav_5_10">
  514. <span class="md-nav__icon md-icon"></span>
  515. 1Password
  516. </label>
  517. <ul class="md-nav__list" data-md-scrollfix>
  518. <li class="md-nav__item">
  519. <a href="../provider-1password-automation/" class="md-nav__link">
  520. Secrets Automation
  521. </a>
  522. </li>
  523. </ul>
  524. </nav>
  525. </li>
  526. <li class="md-nav__item">
  527. <a href="../provider-webhook/" class="md-nav__link">
  528. Webhook
  529. </a>
  530. </li>
  531. <li class="md-nav__item">
  532. <a href="../provider-fake/" class="md-nav__link">
  533. Fake
  534. </a>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="../provider-kubernetes/" class="md-nav__link">
  538. Kubernetes
  539. </a>
  540. </li>
  541. <li class="md-nav__item md-nav__item--nested">
  542. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  543. <label class="md-nav__link" for="__nav_5_14">
  544. senhasegura
  545. <span class="md-nav__icon md-icon"></span>
  546. </label>
  547. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  548. <label class="md-nav__title" for="__nav_5_14">
  549. <span class="md-nav__icon md-icon"></span>
  550. senhasegura
  551. </label>
  552. <ul class="md-nav__list" data-md-scrollfix>
  553. <li class="md-nav__item">
  554. <a href="../provider-senhasegura-dsm/" class="md-nav__link">
  555. DevOps Secrets Management (DSM)
  556. </a>
  557. </li>
  558. </ul>
  559. </nav>
  560. </li>
  561. </ul>
  562. </nav>
  563. </li>
  564. <li class="md-nav__item md-nav__item--nested">
  565. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  566. <label class="md-nav__link" for="__nav_6">
  567. Examples
  568. <span class="md-nav__icon md-icon"></span>
  569. </label>
  570. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  571. <label class="md-nav__title" for="__nav_6">
  572. <span class="md-nav__icon md-icon"></span>
  573. Examples
  574. </label>
  575. <ul class="md-nav__list" data-md-scrollfix>
  576. <li class="md-nav__item">
  577. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  578. FluxCD
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  583. Anchore Engine
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  588. Jenkins
  589. </a>
  590. </li>
  591. </ul>
  592. </nav>
  593. </li>
  594. <li class="md-nav__item md-nav__item--nested">
  595. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  596. <label class="md-nav__link" for="__nav_7">
  597. External Resources
  598. <span class="md-nav__icon md-icon"></span>
  599. </label>
  600. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  601. <label class="md-nav__title" for="__nav_7">
  602. <span class="md-nav__icon md-icon"></span>
  603. External Resources
  604. </label>
  605. <ul class="md-nav__list" data-md-scrollfix>
  606. <li class="md-nav__item">
  607. <a href="../eso-talks/" class="md-nav__link">
  608. Talks
  609. </a>
  610. </li>
  611. <li class="md-nav__item">
  612. <a href="../eso-demos/" class="md-nav__link">
  613. Demos
  614. </a>
  615. </li>
  616. <li class="md-nav__item">
  617. <a href="../eso-blogs/" class="md-nav__link">
  618. Blogs
  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_8" type="checkbox" id="__nav_8" >
  626. <label class="md-nav__link" for="__nav_8">
  627. References
  628. <span class="md-nav__icon md-icon"></span>
  629. </label>
  630. <nav class="md-nav" aria-label="References" data-md-level="1">
  631. <label class="md-nav__title" for="__nav_8">
  632. <span class="md-nav__icon md-icon"></span>
  633. References
  634. </label>
  635. <ul class="md-nav__list" data-md-scrollfix>
  636. <li class="md-nav__item">
  637. <a href="../spec/" class="md-nav__link">
  638. API specification
  639. </a>
  640. </li>
  641. </ul>
  642. </nav>
  643. </li>
  644. <li class="md-nav__item md-nav__item--nested">
  645. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  646. <label class="md-nav__link" for="__nav_9">
  647. Contributing
  648. <span class="md-nav__icon md-icon"></span>
  649. </label>
  650. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  651. <label class="md-nav__title" for="__nav_9">
  652. <span class="md-nav__icon md-icon"></span>
  653. Contributing
  654. </label>
  655. <ul class="md-nav__list" data-md-scrollfix>
  656. <li class="md-nav__item">
  657. <a href="../contributing-devguide/" class="md-nav__link">
  658. Developer guide
  659. </a>
  660. </li>
  661. <li class="md-nav__item">
  662. <a href="../contributing-process/" class="md-nav__link">
  663. Contributing Process
  664. </a>
  665. </li>
  666. <li class="md-nav__item">
  667. <a href="../contributing-release/" class="md-nav__link">
  668. Release Process
  669. </a>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="../contributing-coc/" class="md-nav__link">
  673. Code of Conduct
  674. </a>
  675. </li>
  676. </ul>
  677. </nav>
  678. </li>
  679. <li class="md-nav__item">
  680. <a href="../roadmap/" class="md-nav__link">
  681. Roadmap
  682. </a>
  683. </li>
  684. <li class="md-nav__item">
  685. <a href="../faq/" class="md-nav__link">
  686. FAQ
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../stability-support/" class="md-nav__link">
  691. Stability and Support
  692. </a>
  693. </li>
  694. <li class="md-nav__item">
  695. <a href="../deprecation-policy/" class="md-nav__link">
  696. Deprecation Policy
  697. </a>
  698. </li>
  699. </ul>
  700. </nav>
  701. </div>
  702. </div>
  703. </div>
  704. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  705. <div class="md-sidebar__scrollwrap">
  706. <div class="md-sidebar__inner">
  707. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  708. <label class="md-nav__title" for="__toc">
  709. <span class="md-nav__icon md-icon"></span>
  710. Table of contents
  711. </label>
  712. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  713. <li class="md-nav__item">
  714. <a href="#installing-with-helm" class="md-nav__link">
  715. Installing with Helm
  716. </a>
  717. <nav class="md-nav" aria-label="Installing with Helm">
  718. <ul class="md-nav__list">
  719. <li class="md-nav__item">
  720. <a href="#option-1-install-from-chart-repository" class="md-nav__link">
  721. Option 1: Install from chart repository
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
  726. Option 2: Install chart from local build
  727. </a>
  728. </li>
  729. <li class="md-nav__item">
  730. <a href="#create-a-secret-containing-your-aws-credentials" class="md-nav__link">
  731. Create a secret containing your AWS credentials
  732. </a>
  733. </li>
  734. <li class="md-nav__item">
  735. <a href="#create-your-first-secretstore" class="md-nav__link">
  736. Create your first SecretStore
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="#create-your-first-externalsecret" class="md-nav__link">
  741. Create your first ExternalSecret
  742. </a>
  743. </li>
  744. </ul>
  745. </nav>
  746. </li>
  747. <li class="md-nav__item">
  748. <a href="#installing-with-olm" class="md-nav__link">
  749. Installing with OLM
  750. </a>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="#uninstalling" class="md-nav__link">
  754. Uninstalling
  755. </a>
  756. <nav class="md-nav" aria-label="Uninstalling">
  757. <ul class="md-nav__list">
  758. <li class="md-nav__item">
  759. <a href="#uninstalling-with-helm" class="md-nav__link">
  760. Uninstalling with Helm
  761. </a>
  762. </li>
  763. </ul>
  764. </nav>
  765. </li>
  766. </ul>
  767. </nav>
  768. </div>
  769. </div>
  770. </div>
  771. <div class="md-content" data-md-component="content">
  772. <article class="md-content__inner md-typeset">
  773. <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">
  774. <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>
  775. </a>
  776. <h1 id="getting-started">Getting started</h1>
  777. <p>External-secrets runs within your Kubernetes cluster as a deployment resource.
  778. It utilizes CustomResourceDefinitions to configure access to secret providers through SecretStore resources
  779. and manages Kubernetes secret resources with ExternalSecret resources.</p>
  780. <blockquote>
  781. <p>Note: The minimum supported version of Kubernetes is <code>1.16.0</code>. Users still running Kubernetes v1.15 or below should upgrade
  782. to a supported version before installing external-secrets.</p>
  783. </blockquote>
  784. <h2 id="installing-with-helm">Installing with Helm</h2>
  785. <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>
  786. <p>Uncomment the relevant line in the next steps to enable this.</p>
  787. <h3 id="option-1-install-from-chart-repository">Option 1: Install from chart repository</h3>
  788. <div class="highlight"><pre><span></span><code>helm repo add external-secrets https://charts.external-secrets.io
  789. helm install external-secrets <span class="se">\</span>
  790. external-secrets/external-secrets <span class="se">\</span>
  791. -n external-secrets <span class="se">\</span>
  792. --create-namespace <span class="se">\</span>
  793. <span class="c1"># --set installCRDs=true</span>
  794. </code></pre></div>
  795. <h3 id="option-2-install-chart-from-local-build">Option 2: Install chart from local build</h3>
  796. <p>Build and install the Helm chart locally after cloning the repository.</p>
  797. <div class="highlight"><pre><span></span><code>make helm.build
  798. helm install external-secrets <span class="se">\</span>
  799. ./bin/chart/external-secrets.tgz <span class="se">\</span>
  800. -n external-secrets <span class="se">\</span>
  801. --create-namespace <span class="se">\</span>
  802. <span class="c1"># --set installCRDs=true</span>
  803. </code></pre></div>
  804. <h3 id="create-a-secret-containing-your-aws-credentials">Create a secret containing your AWS credentials</h3>
  805. <div class="highlight"><pre><span></span><code><span class="nb">echo</span> -n <span class="s1">&#39;KEYID&#39;</span> &gt; ./access-key
  806. <span class="nb">echo</span> -n <span class="s1">&#39;SECRETKEY&#39;</span> &gt; ./secret-access-key
  807. kubectl create secret generic awssm-secret --from-file<span class="o">=</span>./access-key --from-file<span class="o">=</span>./secret-access-key
  808. </code></pre></div>
  809. <h3 id="create-your-first-secretstore">Create your first SecretStore</h3>
  810. <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>
  811. <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>
  812. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  813. <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>
  814. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  815. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  816. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span><span class="w"></span>
  817. <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>
  818. <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>
  819. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  820. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  821. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span><span class="w"></span>
  822. <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>
  823. <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>
  824. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span><span class="w"></span>
  825. <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>
  826. <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>
  827. </code></pre></div>
  828. <h3 id="create-your-first-externalsecret">Create your first ExternalSecret</h3>
  829. <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>
  830. <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>
  831. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  832. <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>
  833. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  834. <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>
  835. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  836. <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>
  837. <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>
  838. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  839. <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>
  840. <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>
  841. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  842. <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>
  843. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  844. <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>
  845. <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>
  846. <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>
  847. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  848. <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>
  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">remote-key-in-the-provider</span><span class="w"></span>
  850. </code></pre></div>
  851. <div class="highlight"><pre><span></span><code>kubectl describe externalsecret example
  852. <span class="c1"># [...]</span>
  853. Name: example
  854. Status:
  855. Conditions:
  856. Last Transition Time: <span class="m">2021</span>-02-24T16:45:23Z
  857. Message: Secret was synced
  858. Reason: SecretSynced
  859. Status: True
  860. Type: Ready
  861. Refresh Time: <span class="m">2021</span>-02-24T16:45:24Z
  862. Events: &lt;none&gt;
  863. </code></pre></div>
  864. <p>For more advanced examples, please read the other
  865. <a href="../guides-introduction/">guides</a>.</p>
  866. <h2 id="installing-with-olm">Installing with OLM</h2>
  867. <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>
  868. <h2 id="uninstalling">Uninstalling</h2>
  869. <p>Before continuing, ensure that all external-secret resources that have been created by users have been deleted.
  870. You can check for any existing resources with the following command:</p>
  871. <div class="highlight"><pre><span></span><code>kubectl get SecretStores,ClusterSecretStores,ExternalSecrets --all-namespaces
  872. </code></pre></div>
  873. <p>Once all these resources have been deleted you are ready to uninstall external-secrets.</p>
  874. <h3 id="uninstalling-with-helm">Uninstalling with Helm</h3>
  875. <p>Uninstall the helm release using the delete command.</p>
  876. <div class="highlight"><pre><span></span><code>helm delete external-secrets --namespace external-secrets
  877. </code></pre></div>
  878. </article>
  879. </div>
  880. </div>
  881. </main>
  882. <footer class="md-footer">
  883. <nav class="md-footer__inner md-grid" aria-label="Footer">
  884. <a href="../guides-introduction/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Introduction" rel="prev">
  885. <div class="md-footer__button md-icon">
  886. <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>
  887. </div>
  888. <div class="md-footer__title">
  889. <div class="md-ellipsis">
  890. <span class="md-footer__direction">
  891. Previous
  892. </span>
  893. Introduction
  894. </div>
  895. </div>
  896. </a>
  897. <a href="../guides-templating/" class="md-footer__link md-footer__link--next" aria-label="Next: v2" rel="next">
  898. <div class="md-footer__title">
  899. <div class="md-ellipsis">
  900. <span class="md-footer__direction">
  901. Next
  902. </span>
  903. v2
  904. </div>
  905. </div>
  906. <div class="md-footer__button md-icon">
  907. <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>
  908. </div>
  909. </a>
  910. </nav>
  911. <div class="md-footer-meta md-typeset">
  912. <div class="md-footer-meta__inner md-grid">
  913. <div class="md-copyright">
  914. Made with
  915. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  916. Material for MkDocs
  917. </a>
  918. </div>
  919. </div>
  920. </div>
  921. </footer>
  922. </div>
  923. <div class="md-dialog" data-md-component="dialog">
  924. <div class="md-dialog__inner md-typeset"></div>
  925. </div>
  926. <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>
  927. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  928. </body>
  929. </html>