index.html 63 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024
  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>FluxCD - 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="#gitops-using-fluxcd-v2" 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. FluxCD
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  72. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href=".." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../api-overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../api-externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../api-secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../api-clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. <li class="md-nav__item">
  166. <a href="../api-clusterexternalsecret/" class="md-nav__link">
  167. ClusterExternalSecret
  168. </a>
  169. </li>
  170. </ul>
  171. </nav>
  172. </li>
  173. <li class="md-nav__item md-nav__item--nested">
  174. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  175. <label class="md-nav__link" for="__nav_4">
  176. Guides
  177. <span class="md-nav__icon md-icon"></span>
  178. </label>
  179. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  180. <label class="md-nav__title" for="__nav_4">
  181. <span class="md-nav__icon md-icon"></span>
  182. Guides
  183. </label>
  184. <ul class="md-nav__list" data-md-scrollfix>
  185. <li class="md-nav__item">
  186. <a href="../guides-introduction/" class="md-nav__link">
  187. Introduction
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-getting-started/" class="md-nav__link">
  192. Getting started
  193. </a>
  194. </li>
  195. <li class="md-nav__item md-nav__item--nested">
  196. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  197. <label class="md-nav__link" for="__nav_4_3">
  198. Advanced Templating
  199. <span class="md-nav__icon md-icon"></span>
  200. </label>
  201. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  202. <label class="md-nav__title" for="__nav_4_3">
  203. <span class="md-nav__icon md-icon"></span>
  204. Advanced Templating
  205. </label>
  206. <ul class="md-nav__list" data-md-scrollfix>
  207. <li class="md-nav__item">
  208. <a href="../guides-templating/" class="md-nav__link">
  209. v2
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../guides-templating-v1/" class="md-nav__link">
  214. v1
  215. </a>
  216. </li>
  217. </ul>
  218. </nav>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  222. All keys, One secret
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  227. Common K8S Secret Types
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../guides-controller-class/" class="md-nav__link">
  232. Controller Classes
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="../guides-ownership-deletion-policy/" class="md-nav__link">
  237. Lifecycle: ownership & deletion
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../guides-decoding-strategy/" class="md-nav__link">
  242. Decoding Strategies
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../guides-getallsecrets/" class="md-nav__link">
  247. Getting Multiple Secrets
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../guides-multi-tenancy/" class="md-nav__link">
  252. Multi Tenancy
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../guides-metrics/" class="md-nav__link">
  257. Metrics
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="../guides-v1beta1/" class="md-nav__link">
  262. Upgrading to v1beta1
  263. </a>
  264. </li>
  265. <li class="md-nav__item">
  266. <a href="../guides-using-latest-image/" class="md-nav__link">
  267. Using Latest Image
  268. </a>
  269. </li>
  270. </ul>
  271. </nav>
  272. </li>
  273. <li class="md-nav__item md-nav__item--nested">
  274. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  275. <label class="md-nav__link" for="__nav_5">
  276. Provider
  277. <span class="md-nav__icon md-icon"></span>
  278. </label>
  279. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  280. <label class="md-nav__title" for="__nav_5">
  281. <span class="md-nav__icon md-icon"></span>
  282. Provider
  283. </label>
  284. <ul class="md-nav__list" data-md-scrollfix>
  285. <li class="md-nav__item md-nav__item--nested">
  286. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  287. <label class="md-nav__link" for="__nav_5_1">
  288. AWS
  289. <span class="md-nav__icon md-icon"></span>
  290. </label>
  291. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  292. <label class="md-nav__title" for="__nav_5_1">
  293. <span class="md-nav__icon md-icon"></span>
  294. AWS
  295. </label>
  296. <ul class="md-nav__list" data-md-scrollfix>
  297. <li class="md-nav__item">
  298. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  299. Secrets Manager
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  304. Parameter Store
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  312. <label class="md-nav__link" for="__nav_5_2">
  313. Azure
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_5_2">
  318. <span class="md-nav__icon md-icon"></span>
  319. Azure
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../provider-azure-key-vault/" class="md-nav__link">
  324. Key Vault
  325. </a>
  326. </li>
  327. </ul>
  328. </nav>
  329. </li>
  330. <li class="md-nav__item md-nav__item--nested">
  331. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  332. <label class="md-nav__link" for="__nav_5_3">
  333. Google
  334. <span class="md-nav__icon md-icon"></span>
  335. </label>
  336. <nav class="md-nav" aria-label="Google" data-md-level="2">
  337. <label class="md-nav__title" for="__nav_5_3">
  338. <span class="md-nav__icon md-icon"></span>
  339. Google
  340. </label>
  341. <ul class="md-nav__list" data-md-scrollfix>
  342. <li class="md-nav__item">
  343. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  344. Secret Manager
  345. </a>
  346. </li>
  347. </ul>
  348. </nav>
  349. </li>
  350. <li class="md-nav__item md-nav__item--nested">
  351. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  352. <label class="md-nav__link" for="__nav_5_4">
  353. IBM
  354. <span class="md-nav__icon md-icon"></span>
  355. </label>
  356. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  357. <label class="md-nav__title" for="__nav_5_4">
  358. <span class="md-nav__icon md-icon"></span>
  359. IBM
  360. </label>
  361. <ul class="md-nav__list" data-md-scrollfix>
  362. <li class="md-nav__item">
  363. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  364. Secrets Manager
  365. </a>
  366. </li>
  367. </ul>
  368. </nav>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../provider-akeyless/" class="md-nav__link">
  372. Akeyless
  373. </a>
  374. </li>
  375. <li class="md-nav__item">
  376. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  377. HashiCorp Vault
  378. </a>
  379. </li>
  380. <li class="md-nav__item md-nav__item--nested">
  381. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  382. <label class="md-nav__link" for="__nav_5_7">
  383. Yandex
  384. <span class="md-nav__icon md-icon"></span>
  385. </label>
  386. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  387. <label class="md-nav__title" for="__nav_5_7">
  388. <span class="md-nav__icon md-icon"></span>
  389. Yandex
  390. </label>
  391. <ul class="md-nav__list" data-md-scrollfix>
  392. <li class="md-nav__item">
  393. <a href="../provider-yandex-certificate-manager/" class="md-nav__link">
  394. Certificate Manager
  395. </a>
  396. </li>
  397. <li class="md-nav__item">
  398. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  399. Lockbox
  400. </a>
  401. </li>
  402. </ul>
  403. </nav>
  404. </li>
  405. <li class="md-nav__item md-nav__item--nested">
  406. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  407. <label class="md-nav__link" for="__nav_5_8">
  408. Gitlab
  409. <span class="md-nav__icon md-icon"></span>
  410. </label>
  411. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  412. <label class="md-nav__title" for="__nav_5_8">
  413. <span class="md-nav__icon md-icon"></span>
  414. Gitlab
  415. </label>
  416. <ul class="md-nav__list" data-md-scrollfix>
  417. <li class="md-nav__item">
  418. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  419. Gitlab Project Variables
  420. </a>
  421. </li>
  422. </ul>
  423. </nav>
  424. </li>
  425. <li class="md-nav__item md-nav__item--nested">
  426. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  427. <label class="md-nav__link" for="__nav_5_9">
  428. Oracle
  429. <span class="md-nav__icon md-icon"></span>
  430. </label>
  431. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  432. <label class="md-nav__title" for="__nav_5_9">
  433. <span class="md-nav__icon md-icon"></span>
  434. Oracle
  435. </label>
  436. <ul class="md-nav__list" data-md-scrollfix>
  437. <li class="md-nav__item">
  438. <a href="../provider-oracle-vault/" class="md-nav__link">
  439. Oracle Vault
  440. </a>
  441. </li>
  442. </ul>
  443. </nav>
  444. </li>
  445. <li class="md-nav__item md-nav__item--nested">
  446. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  447. <label class="md-nav__link" for="__nav_5_10">
  448. 1Password
  449. <span class="md-nav__icon md-icon"></span>
  450. </label>
  451. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  452. <label class="md-nav__title" for="__nav_5_10">
  453. <span class="md-nav__icon md-icon"></span>
  454. 1Password
  455. </label>
  456. <ul class="md-nav__list" data-md-scrollfix>
  457. <li class="md-nav__item">
  458. <a href="../provider-1password-automation/" class="md-nav__link">
  459. Secrets Automation
  460. </a>
  461. </li>
  462. </ul>
  463. </nav>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../provider-webhook/" class="md-nav__link">
  467. Webhook
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../provider-fake/" class="md-nav__link">
  472. Fake
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="../provider-kubernetes/" class="md-nav__link">
  477. Kubernetes
  478. </a>
  479. </li>
  480. <li class="md-nav__item md-nav__item--nested">
  481. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  482. <label class="md-nav__link" for="__nav_5_14">
  483. senhasegura
  484. <span class="md-nav__icon md-icon"></span>
  485. </label>
  486. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  487. <label class="md-nav__title" for="__nav_5_14">
  488. <span class="md-nav__icon md-icon"></span>
  489. senhasegura
  490. </label>
  491. <ul class="md-nav__list" data-md-scrollfix>
  492. <li class="md-nav__item">
  493. <a href="../provider-senhasegura-dsm/" class="md-nav__link">
  494. DevOps Secrets Management (DSM)
  495. </a>
  496. </li>
  497. </ul>
  498. </nav>
  499. </li>
  500. </ul>
  501. </nav>
  502. </li>
  503. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  504. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
  505. <label class="md-nav__link" for="__nav_6">
  506. Examples
  507. <span class="md-nav__icon md-icon"></span>
  508. </label>
  509. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  510. <label class="md-nav__title" for="__nav_6">
  511. <span class="md-nav__icon md-icon"></span>
  512. Examples
  513. </label>
  514. <ul class="md-nav__list" data-md-scrollfix>
  515. <li class="md-nav__item md-nav__item--active">
  516. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  517. <label class="md-nav__link md-nav__link--active" for="__toc">
  518. FluxCD
  519. <span class="md-nav__icon md-icon"></span>
  520. </label>
  521. <a href="./" class="md-nav__link md-nav__link--active">
  522. FluxCD
  523. </a>
  524. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  525. <label class="md-nav__title" for="__toc">
  526. <span class="md-nav__icon md-icon"></span>
  527. Table of contents
  528. </label>
  529. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  530. <li class="md-nav__item">
  531. <a href="#advantages" class="md-nav__link">
  532. Advantages
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="#the-approach" class="md-nav__link">
  537. The approach
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="#the-problem" class="md-nav__link">
  542. The problem
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="#the-solution" class="md-nav__link">
  547. The solution
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="#create-the-main-kustomization" class="md-nav__link">
  552. Create the main kustomization
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="#create-the-secret" class="md-nav__link">
  557. Create the secret
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="#creating-the-references-to-repositories" class="md-nav__link">
  562. Creating the references to repositories
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="#deploy-the-crds" class="md-nav__link">
  567. Deploy the CRDs
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="#deploy-the-operator" class="md-nav__link">
  572. Deploy the operator
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="#deploy-the-crs" class="md-nav__link">
  577. Deploy the CRs
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="#results" class="md-nav__link">
  582. Results
  583. </a>
  584. </li>
  585. </ul>
  586. </nav>
  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_7" type="checkbox" id="__nav_7" >
  603. <label class="md-nav__link" for="__nav_7">
  604. External Resources
  605. <span class="md-nav__icon md-icon"></span>
  606. </label>
  607. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  608. <label class="md-nav__title" for="__nav_7">
  609. <span class="md-nav__icon md-icon"></span>
  610. External Resources
  611. </label>
  612. <ul class="md-nav__list" data-md-scrollfix>
  613. <li class="md-nav__item">
  614. <a href="../eso-talks/" class="md-nav__link">
  615. Talks
  616. </a>
  617. </li>
  618. <li class="md-nav__item">
  619. <a href="../eso-demos/" class="md-nav__link">
  620. Demos
  621. </a>
  622. </li>
  623. <li class="md-nav__item">
  624. <a href="../eso-blogs/" class="md-nav__link">
  625. Blogs
  626. </a>
  627. </li>
  628. </ul>
  629. </nav>
  630. </li>
  631. <li class="md-nav__item md-nav__item--nested">
  632. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  633. <label class="md-nav__link" for="__nav_8">
  634. References
  635. <span class="md-nav__icon md-icon"></span>
  636. </label>
  637. <nav class="md-nav" aria-label="References" data-md-level="1">
  638. <label class="md-nav__title" for="__nav_8">
  639. <span class="md-nav__icon md-icon"></span>
  640. References
  641. </label>
  642. <ul class="md-nav__list" data-md-scrollfix>
  643. <li class="md-nav__item">
  644. <a href="../spec/" class="md-nav__link">
  645. API specification
  646. </a>
  647. </li>
  648. </ul>
  649. </nav>
  650. </li>
  651. <li class="md-nav__item md-nav__item--nested">
  652. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  653. <label class="md-nav__link" for="__nav_9">
  654. Contributing
  655. <span class="md-nav__icon md-icon"></span>
  656. </label>
  657. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  658. <label class="md-nav__title" for="__nav_9">
  659. <span class="md-nav__icon md-icon"></span>
  660. Contributing
  661. </label>
  662. <ul class="md-nav__list" data-md-scrollfix>
  663. <li class="md-nav__item">
  664. <a href="../contributing-devguide/" class="md-nav__link">
  665. Developer guide
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../contributing-process/" class="md-nav__link">
  670. Contributing Process
  671. </a>
  672. </li>
  673. <li class="md-nav__item">
  674. <a href="../contributing-release/" class="md-nav__link">
  675. Release Process
  676. </a>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="../contributing-coc/" class="md-nav__link">
  680. Code of Conduct
  681. </a>
  682. </li>
  683. </ul>
  684. </nav>
  685. </li>
  686. <li class="md-nav__item">
  687. <a href="../roadmap/" class="md-nav__link">
  688. Roadmap
  689. </a>
  690. </li>
  691. <li class="md-nav__item">
  692. <a href="../faq/" class="md-nav__link">
  693. FAQ
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="../stability-support/" class="md-nav__link">
  698. Stability and Support
  699. </a>
  700. </li>
  701. <li class="md-nav__item">
  702. <a href="../deprecation-policy/" class="md-nav__link">
  703. Deprecation Policy
  704. </a>
  705. </li>
  706. </ul>
  707. </nav>
  708. </div>
  709. </div>
  710. </div>
  711. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  712. <div class="md-sidebar__scrollwrap">
  713. <div class="md-sidebar__inner">
  714. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  715. <label class="md-nav__title" for="__toc">
  716. <span class="md-nav__icon md-icon"></span>
  717. Table of contents
  718. </label>
  719. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  720. <li class="md-nav__item">
  721. <a href="#advantages" class="md-nav__link">
  722. Advantages
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="#the-approach" class="md-nav__link">
  727. The approach
  728. </a>
  729. </li>
  730. <li class="md-nav__item">
  731. <a href="#the-problem" class="md-nav__link">
  732. The problem
  733. </a>
  734. </li>
  735. <li class="md-nav__item">
  736. <a href="#the-solution" class="md-nav__link">
  737. The solution
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="#create-the-main-kustomization" class="md-nav__link">
  742. Create the main kustomization
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="#create-the-secret" class="md-nav__link">
  747. Create the secret
  748. </a>
  749. </li>
  750. <li class="md-nav__item">
  751. <a href="#creating-the-references-to-repositories" class="md-nav__link">
  752. Creating the references to repositories
  753. </a>
  754. </li>
  755. <li class="md-nav__item">
  756. <a href="#deploy-the-crds" class="md-nav__link">
  757. Deploy the CRDs
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="#deploy-the-operator" class="md-nav__link">
  762. Deploy the operator
  763. </a>
  764. </li>
  765. <li class="md-nav__item">
  766. <a href="#deploy-the-crs" class="md-nav__link">
  767. Deploy the CRs
  768. </a>
  769. </li>
  770. <li class="md-nav__item">
  771. <a href="#results" class="md-nav__link">
  772. Results
  773. </a>
  774. </li>
  775. </ul>
  776. </nav>
  777. </div>
  778. </div>
  779. </div>
  780. <div class="md-content" data-md-component="content">
  781. <article class="md-content__inner md-typeset">
  782. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/examples-gitops-using-fluxcd.md" title="Edit this page" class="md-content__button md-icon">
  783. <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>
  784. </a>
  785. <h1 id="gitops-using-fluxcd-v2">GitOps using FluxCD (v2)</h1>
  786. <p>FluxCD is a GitOps operator for Kubernetes. It synchronizes the status of the cluster from manifests allocated in
  787. different repositories (Git or Helm). This approach fits perfectly with External Secrets on clusters which are dynamically
  788. created, to get credentials with no manual intervention from the beginning.</p>
  789. <h2 id="advantages">Advantages</h2>
  790. <p>This approach has several advantages as follows:</p>
  791. <ul>
  792. <li><strong>Homogenize environments</strong> allowing developers to use the same toolset in Kind in the same way they do in the cloud
  793. provider distributions such as EKS or GKE. This accelerates the development</li>
  794. <li><strong>Reduce security risks</strong>, because credentials can be easily obtained, so temptation to store them locally is reduced.</li>
  795. <li><strong>Application compatibility increase</strong>: Applications are deployed in different ways, and sometimes they need to share
  796. credentials. This can be done using External Secrets as a wire for them at real time.</li>
  797. <li><strong>Automation by default</strong> oh, come on!</li>
  798. </ul>
  799. <h2 id="the-approach">The approach</h2>
  800. <p>FluxCD is composed by several controllers dedicated to manage different custom resources. The most important
  801. ones are <strong>Kustomization</strong> (to clarify, Flux one, not Kubernetes' one) and <strong>HelmRelease</strong> to deploy using the approaches
  802. of the same names.</p>
  803. <p>External Secrets can be deployed using Helm <a href="../guides-getting-started/">as explained here</a>. The deployment includes the
  804. CRDs if enabled on the <code>values.yaml</code>, but after this, you need to deploy some <code>SecretStore</code> to start
  805. getting credentials from your secrets manager with External Secrets.</p>
  806. <blockquote>
  807. <p>The idea of this guide is to deploy the whole stack, using flux, needed by developers not to worry about the credentials,
  808. but only about the application and its code.</p>
  809. </blockquote>
  810. <h2 id="the-problem">The problem</h2>
  811. <p>This can sound easy, but External Secrets is deployed using Helm, which is managed by the HelmController,
  812. and your custom resources, for example a <code>ClusterSecretStore</code> and the related <code>Secret</code>, are often deployed using a
  813. <code>kustomization.yaml</code>, which is deployed by the KustomizeController.</p>
  814. <p>Both controllers manage the resources independently, at different moments, with no possibility to wait each other.
  815. This means that we have a wonderful race condition where sometimes the CRs (<code>SecretStore</code>,<code>ClusterSecretStore</code>...) tries
  816. to be deployed before than the CRDs needed to recognize them.</p>
  817. <h2 id="the-solution">The solution</h2>
  818. <p>Let's see the conditions to start working on a solution:</p>
  819. <ul>
  820. <li>The External Secrets operator is deployed with Helm, and admits disabling the CRDs deployment</li>
  821. <li>The race condition only affects the deployment of <code>CustomResourceDefinition</code> and the CRs needed later</li>
  822. <li>CRDs can be deployed directly from the Git repository of the project using a Flux <code>Kustomization</code></li>
  823. <li>Required CRs can be deployed using a Flux <code>Kustomization</code> too, allowing dependency between CRDs and CRs</li>
  824. <li>All previous manifests can be applied with a Kubernetes <code>kustomization</code></li>
  825. </ul>
  826. <h2 id="create-the-main-kustomization">Create the main kustomization</h2>
  827. <p>To have a better view of things needed later, the first manifest to be created is the <code>kustomization.yaml</code></p>
  828. <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">kustomize.config.k8s.io/v1beta1</span><span class="w"></span>
  829. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Kustomization</span><span class="w"></span>
  830. <span class="nt">resources</span><span class="p">:</span><span class="w"></span>
  831. <span class="c1"># Deploy the Vault access secret</span><span class="w"></span>
  832. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">namespace.yaml</span><span class="w"></span>
  833. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-token.yaml</span><span class="w"></span>
  834. <span class="c1"># Deploy the repositories</span><span class="w"></span>
  835. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">repositories.yaml</span><span class="w"></span>
  836. <span class="c1"># Deploy the CRDs</span><span class="w"></span>
  837. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">deployment-crds.yaml</span><span class="w"></span>
  838. <span class="c1"># Deploy the operator</span><span class="w"></span>
  839. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">deployment.yaml</span><span class="w"></span>
  840. <span class="c1"># Deploy default Custom Resources from &#39;crs&#39; directory</span><span class="w"></span>
  841. <span class="c1"># INFO: This depends on the CRDs deployment. Will happen after it</span><span class="w"></span>
  842. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">deployment-crs.yaml</span><span class="w"></span>
  843. </code></pre></div>
  844. <h2 id="create-the-secret">Create the secret</h2>
  845. <p>To access your secret manager, External Secrets needs some credentials. They are stored inside a Secret, which is intended
  846. to be deployed by automation as a good practise. This time, a placeholder called <code>secret-token.yaml</code> is show as an example:</p>
  847. <div class="highlight"><pre><span></span><code><span class="c1"># The namespace.yaml first</span><span class="w"></span>
  848. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span><span class="w"></span>
  849. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Namespace</span><span class="w"></span>
  850. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  851. <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">external-secrets</span><span class="w"></span>
  852. </code></pre></div>
  853. <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">v1</span><span class="w"></span>
  854. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span><span class="w"></span>
  855. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  856. <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">vault-token-global</span><span class="w"></span>
  857. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"></span>
  858. <span class="nt">stringData</span><span class="p">:</span><span class="w"></span>
  859. <span class="w"> </span><span class="c1"># This token must be patched by overlays. Not here for security reasons</span><span class="w"></span>
  860. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">change-me-placeholder</span><span class="w"></span>
  861. </code></pre></div>
  862. <h2 id="creating-the-references-to-repositories">Creating the references to repositories</h2>
  863. <p>Create a manifest called <code>repositories.yaml</code> to store the references to external repositories for Flux</p>
  864. <div class="highlight"><pre><span></span><code><span class="c1"># Reference to Helm repository</span><span class="w"></span>
  865. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">source.toolkit.fluxcd.io/v1beta1</span><span class="w"></span>
  866. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">HelmRepository</span><span class="w"></span>
  867. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  868. <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">external-secrets</span><span class="w"></span>
  869. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span><span class="w"></span>
  870. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  871. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span><span class="w"></span>
  872. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://charts.external-secrets.io</span><span class="w"></span>
  873. <span class="nn">---</span><span class="w"></span>
  874. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">source.toolkit.fluxcd.io/v1beta1</span><span class="w"></span>
  875. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GitRepository</span><span class="w"></span>
  876. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  877. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"></span>
  878. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span><span class="w"></span>
  879. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  880. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span><span class="w"></span>
  881. <span class="w"> </span><span class="nt">ref</span><span class="p">:</span><span class="w"></span>
  882. <span class="w"> </span><span class="nt">branch</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">main</span><span class="w"></span>
  883. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://github.com/external-secrets/external-secrets</span><span class="w"></span>
  884. </code></pre></div>
  885. <h2 id="deploy-the-crds">Deploy the CRDs</h2>
  886. <p>As mentioned, CRDs can be deployed using the official Helm package, but to solve the race condition, they will be deployed
  887. from our git repository using a Kustomization manifest called <code>deployment-crds.yaml</code> as follows:</p>
  888. <div class="highlight"><pre><span></span><code><span class="nn">---</span><span class="w"></span>
  889. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kustomize.toolkit.fluxcd.io/v1beta2</span><span class="w"></span>
  890. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Kustomization</span><span class="w"></span>
  891. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  892. <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">external-secrets-crds</span><span class="w"></span>
  893. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span><span class="w"></span>
  894. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  895. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span><span class="w"></span>
  896. <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">./deploy/crds</span><span class="w"></span>
  897. <span class="w"> </span><span class="nt">prune</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
  898. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  899. <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">GitRepository</span><span class="w"></span>
  900. <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">external-secrets</span><span class="w"></span>
  901. </code></pre></div>
  902. <h2 id="deploy-the-operator">Deploy the operator</h2>
  903. <p>The operator is deployed using a HelmRelease manifest to deploy the Helm package, but due to the special race condition,
  904. the deployment must be disabled in the <code>values</code> of the manifest called <code>deployment.yaml</code>, as follows:</p>
  905. <div class="highlight"><pre><span></span><code><span class="c1"># How to manage values files. Ref: https://fluxcd.io/docs/guides/helmreleases/#refer-to-values-inside-the-chart</span><span class="w"></span>
  906. <span class="c1"># How to inject values: https://fluxcd.io/docs/guides/helmreleases/#cloud-storage</span><span class="w"></span>
  907. <span class="nn">---</span><span class="w"></span>
  908. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">helm.toolkit.fluxcd.io/v2beta1</span><span class="w"></span>
  909. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">HelmRelease</span><span class="w"></span>
  910. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  911. <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">external-secrets</span><span class="w"></span>
  912. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span><span class="w"></span>
  913. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  914. <span class="w"> </span><span class="c1"># Override Release name to avoid the pattern Namespace-Release</span><span class="w"></span>
  915. <span class="w"> </span><span class="c1"># Ref: https://fluxcd.io/docs/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.HelmRelease</span><span class="w"></span>
  916. <span class="w"> </span><span class="nt">releaseName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"></span>
  917. <span class="w"> </span><span class="nt">targetNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"></span>
  918. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span><span class="w"></span>
  919. <span class="w"> </span><span class="nt">chart</span><span class="p">:</span><span class="w"></span>
  920. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  921. <span class="w"> </span><span class="nt">chart</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"></span>
  922. <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">0.3.9</span><span class="w"></span>
  923. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  924. <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">HelmRepository</span><span class="w"></span>
  925. <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">external-secrets</span><span class="w"></span>
  926. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span><span class="w"></span>
  927. <span class="w"> </span><span class="nt">values</span><span class="p">:</span><span class="w"></span>
  928. <span class="w"> </span><span class="nt">installCRDs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span><span class="w"></span>
  929. <span class="w"> </span><span class="c1"># Ref: https://fluxcd.io/docs/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.Install</span><span class="w"></span>
  930. <span class="w"> </span><span class="nt">install</span><span class="p">:</span><span class="w"></span>
  931. <span class="w"> </span><span class="nt">createNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
  932. </code></pre></div>
  933. <h2 id="deploy-the-crs">Deploy the CRs</h2>
  934. <p>Now, be ready for the arcane magic. Create a Kustomization manifest called <code>deployment-crs.yaml</code> with the following content:</p>
  935. <div class="highlight"><pre><span></span><code><span class="nn">---</span><span class="w"></span>
  936. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kustomize.toolkit.fluxcd.io/v1beta2</span><span class="w"></span>
  937. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Kustomization</span><span class="w"></span>
  938. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  939. <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">external-secrets-crs</span><span class="w"></span>
  940. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span><span class="w"></span>
  941. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  942. <span class="w"> </span><span class="nt">dependsOn</span><span class="p">:</span><span class="w"></span>
  943. <span class="w"> </span><span class="p p-Indicator">-</span><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">external-secrets-crds</span><span class="w"></span>
  944. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span><span class="w"></span>
  945. <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">./infrastructure/external-secrets/crs</span><span class="w"></span>
  946. <span class="w"> </span><span class="nt">prune</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
  947. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  948. <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">GitRepository</span><span class="w"></span>
  949. <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">flux-system</span><span class="w"></span>
  950. </code></pre></div>
  951. <p>There are several interesting details to see here, that finally solves the race condition:</p>
  952. <ol>
  953. <li>First one is the field <code>dependsOn</code>, which points to a previous Kustomization called <code>external-secrets-crds</code>. This
  954. dependency forces this deployment to wait for the other to be ready, before start being deployed.</li>
  955. <li>The reference to the place where to find the CRs
  956. <div class="highlight"><pre><span></span><code><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./infrastructure/external-secrets/crs</span><span class="w"></span>
  957. <span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  958. <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">GitRepository</span><span class="w"></span>
  959. <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">flux-system</span><span class="w"></span>
  960. </code></pre></div>
  961. Custom Resources will be searched in the relative path <code>./infrastructure/external-secrets/crs</code> of the GitRepository
  962. called <code>flux-system</code>, which is a reference to the same repository that FluxCD watches to synchronize the cluster.
  963. With fewer words, a reference to itself, but going to another directory called <code>crs</code></li>
  964. </ol>
  965. <p>Of course, allocate inside the mentioned path <code>./infrastructure/external-secrets/crs</code>, all the desired CRs to be deployed,
  966. for example, a manifest <code>clusterSecretStore.yaml</code> to reach your Hashicorp Vault as follows:</p>
  967. <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>
  968. <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>
  969. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  970. <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">vault-backend-global</span><span class="w"></span>
  971. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  972. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  973. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span><span class="w"></span>
  974. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.your-domain.com&quot;</span><span class="w"></span>
  975. <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">secret</span><span class="w"></span>
  976. <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">v2</span><span class="w"></span>
  977. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  978. <span class="w"> </span><span class="c1"># points to a secret that contains a vault token</span><span class="w"></span>
  979. <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/token</span><span class="w"></span>
  980. <span class="w"> </span><span class="nt">tokenSecretRef</span><span class="p">:</span><span class="w"></span>
  981. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-token-global&quot;</span><span class="w"></span>
  982. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;token&quot;</span><span class="w"></span>
  983. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"></span>
  984. </code></pre></div>
  985. <h2 id="results">Results</h2>
  986. <p>At the end, the required files tree is shown in the following picture:</p>
  987. <p><img alt="FluxCD files tree" src="../pictures/screenshot_gitops_final_directory_tree.png" /></p>
  988. </article>
  989. </div>
  990. </div>
  991. </main>
  992. <footer class="md-footer">
  993. <nav class="md-footer__inner md-grid" aria-label="Footer">
  994. <a href="../provider-senhasegura-dsm/" class="md-footer__link md-footer__link--prev" aria-label="Previous: DevOps Secrets Management (DSM)" rel="prev">
  995. <div class="md-footer__button md-icon">
  996. <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>
  997. </div>
  998. <div class="md-footer__title">
  999. <div class="md-ellipsis">
  1000. <span class="md-footer__direction">
  1001. Previous
  1002. </span>
  1003. DevOps Secrets Management (DSM)
  1004. </div>
  1005. </div>
  1006. </a>
  1007. <a href="../examples-anchore-engine-credentials/" class="md-footer__link md-footer__link--next" aria-label="Next: Anchore Engine" rel="next">
  1008. <div class="md-footer__title">
  1009. <div class="md-ellipsis">
  1010. <span class="md-footer__direction">
  1011. Next
  1012. </span>
  1013. Anchore Engine
  1014. </div>
  1015. </div>
  1016. <div class="md-footer__button md-icon">
  1017. <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>
  1018. </div>
  1019. </a>
  1020. </nav>
  1021. <div class="md-footer-meta md-typeset">
  1022. <div class="md-footer-meta__inner md-grid">
  1023. <div class="md-copyright">
  1024. Made with
  1025. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1026. Material for MkDocs
  1027. </a>
  1028. </div>
  1029. </div>
  1030. </div>
  1031. </footer>
  1032. </div>
  1033. <div class="md-dialog" data-md-component="dialog">
  1034. <div class="md-dialog__inner md-typeset"></div>
  1035. </div>
  1036. <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  1037. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  1038. </body>
  1039. </html>