index.html 60 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159
  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>ExternalSecret - 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="#template" 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. ExternalSecret
  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">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../components/" class="md-tabs__link md-tabs__link--active">
  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--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" 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="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="../components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" type="checkbox" id="__nav_2_2" checked>
  225. <label class="md-nav__link" for="__nav_2_2">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_2_2">
  231. <span class="md-nav__icon md-icon"></span>
  232. Core Resources
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item md-nav__item--active">
  236. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  237. <label class="md-nav__link md-nav__link--active" for="__toc">
  238. ExternalSecret
  239. <span class="md-nav__icon md-icon"></span>
  240. </label>
  241. <a href="./" class="md-nav__link md-nav__link--active">
  242. ExternalSecret
  243. </a>
  244. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  245. <label class="md-nav__title" for="__toc">
  246. <span class="md-nav__icon md-icon"></span>
  247. Table of contents
  248. </label>
  249. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  250. <li class="md-nav__item">
  251. <a href="#template" class="md-nav__link">
  252. Template
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="#update-behavior" class="md-nav__link">
  257. Update Behavior
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="#features" class="md-nav__link">
  262. Features
  263. </a>
  264. </li>
  265. <li class="md-nav__item">
  266. <a href="#example" class="md-nav__link">
  267. Example
  268. </a>
  269. </li>
  270. </ul>
  271. </nav>
  272. </li>
  273. <li class="md-nav__item">
  274. <a href="../secretstore/" class="md-nav__link">
  275. SecretStore
  276. </a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="../clustersecretstore/" class="md-nav__link">
  280. ClusterSecretStore
  281. </a>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="../clusterexternalsecret/" class="md-nav__link">
  285. ClusterExternalSecret
  286. </a>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="../pushsecret/" class="md-nav__link">
  290. PushSecret
  291. </a>
  292. </li>
  293. </ul>
  294. </nav>
  295. </li>
  296. <li class="md-nav__item md-nav__item--nested">
  297. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  298. <div class="md-nav__link md-nav__link--index ">
  299. <a href="../generator/">Generators</a>
  300. <label for="__nav_2_3">
  301. <span class="md-nav__icon md-icon"></span>
  302. </label>
  303. </div>
  304. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  305. <label class="md-nav__title" for="__nav_2_3">
  306. <span class="md-nav__icon md-icon"></span>
  307. Generators
  308. </label>
  309. <ul class="md-nav__list" data-md-scrollfix>
  310. <li class="md-nav__item">
  311. <a href="../generator/acr/" class="md-nav__link">
  312. Azure Container Registry
  313. </a>
  314. </li>
  315. <li class="md-nav__item">
  316. <a href="../generator/ecr/" class="md-nav__link">
  317. AWS Elastic Container Registry
  318. </a>
  319. </li>
  320. <li class="md-nav__item">
  321. <a href="../generator/gcr/" class="md-nav__link">
  322. Google Container Registry
  323. </a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="../generator/password/" class="md-nav__link">
  327. Password
  328. </a>
  329. </li>
  330. <li class="md-nav__item">
  331. <a href="../generator/fake/" class="md-nav__link">
  332. Fake
  333. </a>
  334. </li>
  335. </ul>
  336. </nav>
  337. </li>
  338. <li class="md-nav__item md-nav__item--nested">
  339. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  340. <label class="md-nav__link" for="__nav_2_4">
  341. Reference Docs
  342. <span class="md-nav__icon md-icon"></span>
  343. </label>
  344. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  345. <label class="md-nav__title" for="__nav_2_4">
  346. <span class="md-nav__icon md-icon"></span>
  347. Reference Docs
  348. </label>
  349. <ul class="md-nav__list" data-md-scrollfix>
  350. <li class="md-nav__item">
  351. <a href="../spec/" class="md-nav__link">
  352. API specification
  353. </a>
  354. </li>
  355. <li class="md-nav__item">
  356. <a href="../controller-options/" class="md-nav__link">
  357. Controller Options
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="../metrics/" class="md-nav__link">
  362. Metrics
  363. </a>
  364. </li>
  365. </ul>
  366. </nav>
  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_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  373. <label class="md-nav__link" for="__nav_3">
  374. Guides
  375. <span class="md-nav__icon md-icon"></span>
  376. </label>
  377. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  378. <label class="md-nav__title" for="__nav_3">
  379. <span class="md-nav__icon md-icon"></span>
  380. Guides
  381. </label>
  382. <ul class="md-nav__list" data-md-scrollfix>
  383. <li class="md-nav__item">
  384. <a href="../../guides/introduction/" class="md-nav__link">
  385. Introduction
  386. </a>
  387. </li>
  388. <li class="md-nav__item md-nav__item--nested">
  389. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  390. <label class="md-nav__link" for="__nav_3_2">
  391. Advanced Templating
  392. <span class="md-nav__icon md-icon"></span>
  393. </label>
  394. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  395. <label class="md-nav__title" for="__nav_3_2">
  396. <span class="md-nav__icon md-icon"></span>
  397. Advanced Templating
  398. </label>
  399. <ul class="md-nav__list" data-md-scrollfix>
  400. <li class="md-nav__item">
  401. <a href="../../guides/templating/" class="md-nav__link">
  402. v2
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../guides/templating-v1/" class="md-nav__link">
  407. v1
  408. </a>
  409. </li>
  410. </ul>
  411. </nav>
  412. </li>
  413. <li class="md-nav__item">
  414. <a href="../../guides/generator/" class="md-nav__link">
  415. Generators
  416. </a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  420. All keys, One secret
  421. </a>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  425. Common K8S Secret Types
  426. </a>
  427. </li>
  428. <li class="md-nav__item">
  429. <a href="../../guides/controller-class/" class="md-nav__link">
  430. Controller Classes
  431. </a>
  432. </li>
  433. <li class="md-nav__item">
  434. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  435. Lifecycle: ownership & deletion
  436. </a>
  437. </li>
  438. <li class="md-nav__item">
  439. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  440. Decoding Strategies
  441. </a>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../../guides/getallsecrets/" class="md-nav__link">
  445. Getting Multiple Secrets
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  450. Multi Tenancy
  451. </a>
  452. </li>
  453. <li class="md-nav__item">
  454. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  455. Rewriting Keys
  456. </a>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="../../guides/v1beta1/" class="md-nav__link">
  460. Upgrading to v1beta1
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../../guides/using-latest-image/" class="md-nav__link">
  465. Using Latest Image
  466. </a>
  467. </li>
  468. </ul>
  469. </nav>
  470. </li>
  471. <li class="md-nav__item md-nav__item--nested">
  472. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  473. <label class="md-nav__link" for="__nav_4">
  474. Provider
  475. <span class="md-nav__icon md-icon"></span>
  476. </label>
  477. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  478. <label class="md-nav__title" for="__nav_4">
  479. <span class="md-nav__icon md-icon"></span>
  480. Provider
  481. </label>
  482. <ul class="md-nav__list" data-md-scrollfix>
  483. <li class="md-nav__item">
  484. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  485. AWS Secrets Manager
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  490. AWS Parameter Store
  491. </a>
  492. </li>
  493. <li class="md-nav__item">
  494. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  495. Azure Key Vault
  496. </a>
  497. </li>
  498. <li class="md-nav__item">
  499. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  500. Google Secret Manager
  501. </a>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  505. IBM Secrets Manager
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../provider/akeyless/" class="md-nav__link">
  510. Akeyless
  511. </a>
  512. </li>
  513. <li class="md-nav__item">
  514. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  515. HashiCorp Vault
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  520. Yandex Certificate Manager
  521. </a>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  525. Yandex Lockbox
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  530. Gitlab Variables
  531. </a>
  532. </li>
  533. <li class="md-nav__item">
  534. <a href="../../provider/oracle-vault/" class="md-nav__link">
  535. Oracle Vault
  536. </a>
  537. </li>
  538. <li class="md-nav__item">
  539. <a href="../../provider/1password-automation/" class="md-nav__link">
  540. 1Password Secrets Automation
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="../../provider/webhook/" class="md-nav__link">
  545. Webhook
  546. </a>
  547. </li>
  548. <li class="md-nav__item">
  549. <a href="../../provider/fake/" class="md-nav__link">
  550. Fake
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../../provider/kubernetes/" class="md-nav__link">
  555. Kubernetes
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  560. senhasegura DevOps Secrets Management (DSM)
  561. </a>
  562. </li>
  563. <li class="md-nav__item">
  564. <a href="../../provider/doppler/" class="md-nav__link">
  565. Doppler
  566. </a>
  567. </li>
  568. </ul>
  569. </nav>
  570. </li>
  571. <li class="md-nav__item md-nav__item--nested">
  572. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  573. <label class="md-nav__link" for="__nav_5">
  574. Examples
  575. <span class="md-nav__icon md-icon"></span>
  576. </label>
  577. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  578. <label class="md-nav__title" for="__nav_5">
  579. <span class="md-nav__icon md-icon"></span>
  580. Examples
  581. </label>
  582. <ul class="md-nav__list" data-md-scrollfix>
  583. <li class="md-nav__item">
  584. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  585. FluxCD
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  590. Anchore Engine
  591. </a>
  592. </li>
  593. <li class="md-nav__item">
  594. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  595. Jenkins
  596. </a>
  597. </li>
  598. </ul>
  599. </nav>
  600. </li>
  601. <li class="md-nav__item md-nav__item--nested">
  602. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  603. <label class="md-nav__link" for="__nav_6">
  604. Community
  605. <span class="md-nav__icon md-icon"></span>
  606. </label>
  607. <nav class="md-nav" aria-label="Community" data-md-level="1">
  608. <label class="md-nav__title" for="__nav_6">
  609. <span class="md-nav__icon md-icon"></span>
  610. Community
  611. </label>
  612. <ul class="md-nav__list" data-md-scrollfix>
  613. <li class="md-nav__item md-nav__item--nested">
  614. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  615. <label class="md-nav__link" for="__nav_6_1">
  616. Contributing
  617. <span class="md-nav__icon md-icon"></span>
  618. </label>
  619. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  620. <label class="md-nav__title" for="__nav_6_1">
  621. <span class="md-nav__icon md-icon"></span>
  622. Contributing
  623. </label>
  624. <ul class="md-nav__list" data-md-scrollfix>
  625. <li class="md-nav__item">
  626. <a href="../../contributing/devguide/" class="md-nav__link">
  627. Developer guide
  628. </a>
  629. </li>
  630. <li class="md-nav__item">
  631. <a href="../../contributing/process/" class="md-nav__link">
  632. Contributing Process
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../../contributing/release/" class="md-nav__link">
  637. Release Process
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../../contributing/coc/" class="md-nav__link">
  642. Code of Conduct
  643. </a>
  644. </li>
  645. <li class="md-nav__item">
  646. <a href="../../contributing/roadmap/" class="md-nav__link">
  647. Roadmap
  648. </a>
  649. </li>
  650. </ul>
  651. </nav>
  652. </li>
  653. <li class="md-nav__item md-nav__item--nested">
  654. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  655. <label class="md-nav__link" for="__nav_6_2">
  656. External Resources
  657. <span class="md-nav__icon md-icon"></span>
  658. </label>
  659. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  660. <label class="md-nav__title" for="__nav_6_2">
  661. <span class="md-nav__icon md-icon"></span>
  662. External Resources
  663. </label>
  664. <ul class="md-nav__list" data-md-scrollfix>
  665. <li class="md-nav__item">
  666. <a href="../../eso-talks/" class="md-nav__link">
  667. Talks
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="../../eso-demos/" class="md-nav__link">
  672. Demos
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../../eso-blogs/" class="md-nav__link">
  677. Blogs
  678. </a>
  679. </li>
  680. </ul>
  681. </nav>
  682. </li>
  683. </ul>
  684. </nav>
  685. </li>
  686. </ul>
  687. </nav>
  688. </div>
  689. </div>
  690. </div>
  691. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  692. <div class="md-sidebar__scrollwrap">
  693. <div class="md-sidebar__inner">
  694. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  695. <label class="md-nav__title" for="__toc">
  696. <span class="md-nav__icon md-icon"></span>
  697. Table of contents
  698. </label>
  699. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  700. <li class="md-nav__item">
  701. <a href="#template" class="md-nav__link">
  702. Template
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="#update-behavior" class="md-nav__link">
  707. Update Behavior
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="#features" class="md-nav__link">
  712. Features
  713. </a>
  714. </li>
  715. <li class="md-nav__item">
  716. <a href="#example" class="md-nav__link">
  717. Example
  718. </a>
  719. </li>
  720. </ul>
  721. </nav>
  722. </div>
  723. </div>
  724. </div>
  725. <div class="md-content" data-md-component="content">
  726. <article class="md-content__inner md-typeset">
  727. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/api/externalsecret.md" title="Edit this page" class="md-content__button md-icon">
  728. <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>
  729. </a>
  730. <h1>ExternalSecret</h1>
  731. <p>The <code>ExternalSecret</code> describes what data should be fetched, how the data should
  732. be transformed and saved as a <code>Kind=Secret</code>:</p>
  733. <ul>
  734. <li>tells the operator what secrets should be synced by using <code>spec.data</code> to
  735. explicitly sync individual keys or use <code>spec.dataFrom</code> to get <strong>all values</strong>
  736. from the external API.</li>
  737. <li>you can specify how the secret should look like by specifying a
  738. <code>spec.target.template</code></li>
  739. </ul>
  740. <h2 id="template">Template</h2>
  741. <p>When the controller reconciles the <code>ExternalSecret</code> it will use the <code>spec.template</code> as a blueprint to construct a new <code>Kind=Secret</code>. You can use golang templates to define the blueprint and use template functions to transform secret values. You can also pull in <code>ConfigMaps</code> that contain golang-template data using <code>templateFrom</code>. See <a href="../../guides/templating/">advanced templating</a> for details.</p>
  742. <h2 id="update-behavior">Update Behavior</h2>
  743. <p>The <code>Kind=Secret</code> is updated when:</p>
  744. <ul>
  745. <li>the <code>spec.refreshInterval</code> has passed and is not <code>0</code></li>
  746. <li>the <code>ExternalSecret</code>'s <code>labels</code> or <code>annotations</code> are changed</li>
  747. <li>the <code>ExternalSecret</code>'s <code>spec</code> has been changed</li>
  748. </ul>
  749. <p>You can trigger a secret refresh by using kubectl or any other kubernetes api client:</p>
  750. <div class="highlight"><pre><span></span><code>kubectl annotate es my-es force-sync=$(date +%s) --overwrite
  751. </code></pre></div>
  752. <h2 id="features">Features</h2>
  753. <p>Individual features are described in the <a href="../guides/">Guides section</a>:</p>
  754. <ul>
  755. <li><a href="../../guides/getallsecrets/">Find many secrets / Extract from structured data</a></li>
  756. <li><a href="../../guides/templating/">Templating</a></li>
  757. <li><a href="../../guides/generator/">Using Generators</a></li>
  758. <li><a href="../../guides/ownership-deletion-policy/">Secret Ownership and Deletion</a></li>
  759. <li><a href="../../guides/datafrom-rewrite/">Key Rewriting</a></li>
  760. <li><a href="../../guides/decoding-strategy/">Decoding Strategy</a></li>
  761. </ul>
  762. <h2 id="example">Example</h2>
  763. <p>Take a look at an annotated example to understand the design behind the
  764. <code>ExternalSecret</code>.</p>
  765. <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>
  766. <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>
  767. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  768. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;hello-world&quot;</span><span class="w"></span>
  769. <span class="w"> </span><span class="c1"># labels and annotations are copied over to the</span><span class="w"></span>
  770. <span class="w"> </span><span class="c1"># secret that will be created</span><span class="w"></span>
  771. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"></span>
  772. <span class="w"> </span><span class="nt">acme.org/owned-by</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;q-team&quot;</span><span class="w"></span>
  773. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"></span>
  774. <span class="w"> </span><span class="nt">acme.org/sha</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1234</span><span class="w"></span>
  775. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  776. <span class="w"> </span><span class="c1"># Optional, SecretStoreRef defines the default SecretStore to use when fetching the secret data.</span><span class="w"></span>
  777. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  778. <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">aws-store</span><span class="w"></span>
  779. <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><span class="c1"># or ClusterSecretStore</span><span class="w"></span>
  780. <span class="w"> </span><span class="c1"># RefreshInterval is the amount of time before the values reading again from the SecretStore provider</span><span class="w"></span>
  781. <span class="w"> </span><span class="c1"># Valid time units are &quot;ns&quot;, &quot;us&quot; (or &quot;µs&quot;), &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot; (from time.ParseDuration)</span><span class="w"></span>
  782. <span class="w"> </span><span class="c1"># May be set to zero to fetch and create it once</span><span class="w"></span>
  783. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;1h&quot;</span><span class="w"></span>
  784. <span class="w"> </span><span class="c1"># the target describes the secret that shall be created</span><span class="w"></span>
  785. <span class="w"> </span><span class="c1"># there can only be one target per ExternalSecret</span><span class="w"></span>
  786. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  787. <span class="w"> </span><span class="c1"># The secret name of the resource</span><span class="w"></span>
  788. <span class="w"> </span><span class="c1"># Defaults to .metadata.name of the ExternalSecret</span><span class="w"></span>
  789. <span class="w"> </span><span class="c1"># It is immutable</span><span class="w"></span>
  790. <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">application-config</span><span class="w"></span>
  791. <span class="w"> </span><span class="c1"># Enum with values: &#39;Owner&#39;, &#39;Merge&#39;, or &#39;None&#39;</span><span class="w"></span>
  792. <span class="w"> </span><span class="c1"># Default value of &#39;Owner&#39;</span><span class="w"></span>
  793. <span class="w"> </span><span class="c1"># Owner creates the secret and sets .metadata.ownerReferences of the resource</span><span class="w"></span>
  794. <span class="w"> </span><span class="c1"># Merge does not create the secret, but merges in the data fields to the secret</span><span class="w"></span>
  795. <span class="w"> </span><span class="c1"># None does not create a secret (future use with injector)</span><span class="w"></span>
  796. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;Merge&#39;</span><span class="w"></span>
  797. <span class="w"> </span><span class="c1"># DeletionPolicy defines how/when to delete the Secret in Kubernetes</span><span class="w"></span>
  798. <span class="w"> </span><span class="c1"># if the provider secret gets deleted.</span><span class="w"></span>
  799. <span class="w"> </span><span class="c1"># Valid values are Delete, Merge, Retain</span><span class="w"></span>
  800. <span class="w"> </span><span class="nt">deletionPolicy</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Retain&quot;</span><span class="w"></span>
  801. <span class="w"> </span><span class="c1"># Specify a blueprint for the resulting Kind=Secret</span><span class="w"></span>
  802. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  803. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubernetes.io/dockerconfigjson</span><span class="w"> </span><span class="c1"># or TLS...</span><span class="w"></span>
  804. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  805. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span><span class="w"></span>
  806. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span><span class="w"></span>
  807. <span class="w"> </span><span class="c1"># Use inline templates to construct your desired config file that contains your secret</span><span class="w"></span>
  808. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  809. <span class="w"> </span><span class="nt">config.yml</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span><span class="w"></span>
  810. <span class="w"> </span><span class="no">database:</span><span class="w"></span>
  811. <span class="w"> </span><span class="no">connection: postgres://{{ .username }}:{{ .password }}@{{ .database_host }}:5432/payments</span><span class="w"></span>
  812. <span class="w"> </span><span class="c1"># Uses an existing template from configmap</span><span class="w"></span>
  813. <span class="w"> </span><span class="c1"># Secret is fetched, merged and templated within the referenced configMap data</span><span class="w"></span>
  814. <span class="w"> </span><span class="c1"># It does not update the configmap, it creates a secret with: data[&quot;alertmanager.yml&quot;] = ...result...</span><span class="w"></span>
  815. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span><span class="w"></span>
  816. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">configMap</span><span class="p">:</span><span class="w"></span>
  817. <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">application-config-tmpl</span><span class="w"></span>
  818. <span class="w"> </span><span class="nt">items</span><span class="p">:</span><span class="w"></span>
  819. <span class="w"> </span><span class="p p-Indicator">-</span><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">config.yml</span><span class="w"></span>
  820. <span class="w"> </span><span class="c1"># Data defines the connection between the Kubernetes Secret keys and the Provider data</span><span class="w"></span>
  821. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  822. <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">username</span><span class="w"></span>
  823. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  824. <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">database-credentials</span><span class="w"></span>
  825. <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">v1</span><span class="w"></span>
  826. <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">username</span><span class="w"></span>
  827. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">None</span><span class="w"> </span><span class="c1"># can be None, Base64, Base64URL or Auto</span><span class="w"></span>
  828. <span class="w"> </span><span class="c1"># define the source of the secret. Can be a SecretStore or a Generator kind</span><span class="w"></span>
  829. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  830. <span class="w"> </span><span class="c1"># point to a SecretStore that should be used to fetch a secret.</span><span class="w"></span>
  831. <span class="w"> </span><span class="c1"># must be defined if no spec.secretStoreRef is defined.</span><span class="w"></span>
  832. <span class="w"> </span><span class="nt">storeRef</span><span class="p">:</span><span class="w"></span>
  833. <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">aws-secretstore</span><span class="w"></span>
  834. <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">ClusterSecretStore</span><span class="w"></span>
  835. <span class="w"> </span><span class="c1"># point to a generator resource that provides the secret value</span><span class="w"></span>
  836. <span class="w"> </span><span class="nt">generatorRef</span><span class="p">:</span><span class="w"></span>
  837. <span class="w"> </span><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">generators.external-secrets.io/v1alpha1</span><span class="w"></span>
  838. <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">Password</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">db-password</span><span class="w"></span>
  840. <span class="w"> </span><span class="c1"># Used to fetch all properties from the Provider key</span><span class="w"></span>
  841. <span class="w"> </span><span class="c1"># If multiple dataFrom are specified, secrets are merged in the specified order</span><span class="w"></span>
  842. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  843. <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>
  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">database-credentials</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">v1</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">data</span><span class="w"></span>
  847. <span class="w"> </span><span class="nt">conversionStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Default</span><span class="w"></span>
  848. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Auto</span><span class="w"></span>
  849. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span><span class="w"></span>
  850. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"></span>
  851. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;exp-(.*?)-ression&quot;</span><span class="w"></span>
  852. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;rewriting-${1}-with-groups&quot;</span><span class="w"></span>
  853. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span><span class="w"></span>
  854. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">path-to-filter</span><span class="w"></span>
  855. <span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">source</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="s">&quot;exp-(.*?)-ression&quot;</span><span class="w"></span>
  856. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;rewriting-${1}-with-groups&quot;</span><span class="w"></span>
  857. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"></span>
  858. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;.*foobar.*&quot;</span><span class="w"></span>
  859. <span class="w"> </span><span class="nt">tags</span><span class="p">:</span><span class="w"></span>
  860. <span class="w"> </span><span class="nt">foo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bar</span><span class="w"></span>
  861. <span class="w"> </span><span class="nt">conversionStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Unicode</span><span class="w"></span>
  862. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Base64</span><span class="w"></span>
  863. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span><span class="w"></span>
  864. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"></span>
  865. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="w"></span>
  866. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;bar&quot;</span><span class="w"></span>
  867. <span class="nt">status</span><span class="p">:</span><span class="w"></span>
  868. <span class="w"> </span><span class="c1"># refreshTime is the time and date the external secret was fetched and</span><span class="w"></span>
  869. <span class="w"> </span><span class="c1"># the target secret updated</span><span class="w"></span>
  870. <span class="w"> </span><span class="nt">refreshTime</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-08-12T12:33:02Z&quot;</span><span class="w"></span>
  871. <span class="w"> </span><span class="c1"># Standard condition schema</span><span class="w"></span>
  872. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span><span class="w"></span>
  873. <span class="w"> </span><span class="c1"># ExternalSecret ready condition indicates the secret is ready for use.</span><span class="w"></span>
  874. <span class="w"> </span><span class="c1"># This is defined as:</span><span class="w"></span>
  875. <span class="w"> </span><span class="c1"># - The target secret exists</span><span class="w"></span>
  876. <span class="w"> </span><span class="c1"># - The target secret has been refreshed within the last refreshInterval</span><span class="w"></span>
  877. <span class="w"> </span><span class="c1"># - The target secret content is up-to-date based on any target templates</span><span class="w"></span>
  878. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Ready</span><span class="w"></span>
  879. <span class="w"> </span><span class="nt">status</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;True&quot;</span><span class="w"> </span><span class="c1"># False if last refresh was not successful</span><span class="w"></span>
  880. <span class="w"> </span><span class="nt">reason</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SecretSynced&quot;</span><span class="w"></span>
  881. <span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Secret</span><span class="nv"> </span><span class="s">was</span><span class="nv"> </span><span class="s">synced&quot;</span><span class="w"></span>
  882. <span class="w"> </span><span class="nt">lastTransitionTime</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-08-12T12:33:02Z&quot;</span><span class="w"></span>
  883. </code></pre></div>
  884. </article>
  885. </div>
  886. </div>
  887. </main>
  888. <footer class="md-footer">
  889. <nav class="md-footer__inner md-grid" aria-label="Footer">
  890. <a href="../components/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Components" rel="prev">
  891. <div class="md-footer__button md-icon">
  892. <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>
  893. </div>
  894. <div class="md-footer__title">
  895. <div class="md-ellipsis">
  896. <span class="md-footer__direction">
  897. Previous
  898. </span>
  899. Components
  900. </div>
  901. </div>
  902. </a>
  903. <a href="../secretstore/" class="md-footer__link md-footer__link--next" aria-label="Next: SecretStore" rel="next">
  904. <div class="md-footer__title">
  905. <div class="md-ellipsis">
  906. <span class="md-footer__direction">
  907. Next
  908. </span>
  909. SecretStore
  910. </div>
  911. </div>
  912. <div class="md-footer__button md-icon">
  913. <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>
  914. </div>
  915. </a>
  916. </nav>
  917. <div class="md-footer-meta md-typeset">
  918. <div class="md-footer-meta__inner md-grid">
  919. <div class="md-copyright">
  920. <div class="md-copyright__highlight">
  921. &copy; 2022 The external-secrets Authors.<br/>
  922. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  923. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  924. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  925. </div>
  926. Made with
  927. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  928. Material for MkDocs
  929. </a>
  930. </div>
  931. </div>
  932. </div>
  933. </footer>
  934. </div>
  935. <div class="md-dialog" data-md-component="dialog">
  936. <div class="md-dialog__inner md-typeset"></div>
  937. </div>
  938. <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>
  939. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  940. </body>
  941. </html>