index.html 53 KB

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