index.html 59 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815
  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-controller-class/" class="md-nav__link">
  222. Controller Classes
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  227. All keys, One secret
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  232. Common K8S Secret Types
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="../guides-multi-tenancy/" class="md-nav__link">
  237. Multi Tenancy
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../guides-metrics/" class="md-nav__link">
  242. Metrics
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../guides-using-latest-image/" class="md-nav__link">
  247. Using Latest Image
  248. </a>
  249. </li>
  250. </ul>
  251. </nav>
  252. </li>
  253. <li class="md-nav__item md-nav__item--nested">
  254. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  255. <label class="md-nav__link" for="__nav_5">
  256. Provider
  257. <span class="md-nav__icon md-icon"></span>
  258. </label>
  259. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  260. <label class="md-nav__title" for="__nav_5">
  261. <span class="md-nav__icon md-icon"></span>
  262. Provider
  263. </label>
  264. <ul class="md-nav__list" data-md-scrollfix>
  265. <li class="md-nav__item md-nav__item--nested">
  266. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  267. <label class="md-nav__link" for="__nav_5_1">
  268. AWS
  269. <span class="md-nav__icon md-icon"></span>
  270. </label>
  271. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_5_1">
  273. <span class="md-nav__icon md-icon"></span>
  274. AWS
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  279. Secrets Manager
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  284. Parameter Store
  285. </a>
  286. </li>
  287. </ul>
  288. </nav>
  289. </li>
  290. <li class="md-nav__item md-nav__item--nested">
  291. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  292. <label class="md-nav__link" for="__nav_5_2">
  293. Azure
  294. <span class="md-nav__icon md-icon"></span>
  295. </label>
  296. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  297. <label class="md-nav__title" for="__nav_5_2">
  298. <span class="md-nav__icon md-icon"></span>
  299. Azure
  300. </label>
  301. <ul class="md-nav__list" data-md-scrollfix>
  302. <li class="md-nav__item">
  303. <a href="../provider-azure-key-vault/" class="md-nav__link">
  304. Key Vault
  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_3" type="checkbox" id="__nav_5_3" >
  312. <label class="md-nav__link" for="__nav_5_3">
  313. Google
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="Google" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_5_3">
  318. <span class="md-nav__icon md-icon"></span>
  319. Google
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  324. Secret Manager
  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_4" type="checkbox" id="__nav_5_4" >
  332. <label class="md-nav__link" for="__nav_5_4">
  333. IBM
  334. <span class="md-nav__icon md-icon"></span>
  335. </label>
  336. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  337. <label class="md-nav__title" for="__nav_5_4">
  338. <span class="md-nav__icon md-icon"></span>
  339. IBM
  340. </label>
  341. <ul class="md-nav__list" data-md-scrollfix>
  342. <li class="md-nav__item">
  343. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  344. Secrets Manager
  345. </a>
  346. </li>
  347. </ul>
  348. </nav>
  349. </li>
  350. <li class="md-nav__item">
  351. <a href="../provider-akeyless/" class="md-nav__link">
  352. Akeyless
  353. </a>
  354. </li>
  355. <li class="md-nav__item">
  356. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  357. HashiCorp Vault
  358. </a>
  359. </li>
  360. <li class="md-nav__item md-nav__item--nested">
  361. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  362. <label class="md-nav__link" for="__nav_5_7">
  363. Yandex
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  367. <label class="md-nav__title" for="__nav_5_7">
  368. <span class="md-nav__icon md-icon"></span>
  369. Yandex
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  374. Lockbox
  375. </a>
  376. </li>
  377. </ul>
  378. </nav>
  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_8" type="checkbox" id="__nav_5_8" >
  382. <label class="md-nav__link" for="__nav_5_8">
  383. Gitlab
  384. <span class="md-nav__icon md-icon"></span>
  385. </label>
  386. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  387. <label class="md-nav__title" for="__nav_5_8">
  388. <span class="md-nav__icon md-icon"></span>
  389. Gitlab
  390. </label>
  391. <ul class="md-nav__list" data-md-scrollfix>
  392. <li class="md-nav__item">
  393. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  394. Gitlab Project Variables
  395. </a>
  396. </li>
  397. </ul>
  398. </nav>
  399. </li>
  400. <li class="md-nav__item md-nav__item--nested">
  401. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  402. <label class="md-nav__link" for="__nav_5_9">
  403. Oracle
  404. <span class="md-nav__icon md-icon"></span>
  405. </label>
  406. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  407. <label class="md-nav__title" for="__nav_5_9">
  408. <span class="md-nav__icon md-icon"></span>
  409. Oracle
  410. </label>
  411. <ul class="md-nav__list" data-md-scrollfix>
  412. <li class="md-nav__item">
  413. <a href="../provider-oracle-vault/" class="md-nav__link">
  414. Oracle Vault
  415. </a>
  416. </li>
  417. </ul>
  418. </nav>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../provider-webhook/" class="md-nav__link">
  422. Webhook
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="../provider-fake/" class="md-nav__link">
  427. Fake
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="../provider-kubernetes/" class="md-nav__link">
  432. Kubernetes
  433. </a>
  434. </li>
  435. </ul>
  436. </nav>
  437. </li>
  438. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  439. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
  440. <label class="md-nav__link" for="__nav_6">
  441. Examples
  442. <span class="md-nav__icon md-icon"></span>
  443. </label>
  444. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  445. <label class="md-nav__title" for="__nav_6">
  446. <span class="md-nav__icon md-icon"></span>
  447. Examples
  448. </label>
  449. <ul class="md-nav__list" data-md-scrollfix>
  450. <li class="md-nav__item md-nav__item--active">
  451. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  452. <label class="md-nav__link md-nav__link--active" for="__toc">
  453. FluxCD
  454. <span class="md-nav__icon md-icon"></span>
  455. </label>
  456. <a href="./" class="md-nav__link md-nav__link--active">
  457. FluxCD
  458. </a>
  459. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  460. <label class="md-nav__title" for="__toc">
  461. <span class="md-nav__icon md-icon"></span>
  462. Table of contents
  463. </label>
  464. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  465. <li class="md-nav__item">
  466. <a href="#advantages" class="md-nav__link">
  467. Advantages
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="#the-approach" class="md-nav__link">
  472. The approach
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="#the-problem" class="md-nav__link">
  477. The problem
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="#the-solution" class="md-nav__link">
  482. The solution
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="#create-the-main-kustomization" class="md-nav__link">
  487. Create the main kustomization
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="#create-the-secret" class="md-nav__link">
  492. Create the secret
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="#creating-the-references-to-repositories" class="md-nav__link">
  497. Creating the references to repositories
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="#deploy-the-crds" class="md-nav__link">
  502. Deploy the CRDs
  503. </a>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="#deploy-the-operator" class="md-nav__link">
  507. Deploy the operator
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="#deploy-the-crs" class="md-nav__link">
  512. Deploy the CRs
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="#results" class="md-nav__link">
  517. Results
  518. </a>
  519. </li>
  520. </ul>
  521. </nav>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  525. Anchore Engine
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  530. Jenkins
  531. </a>
  532. </li>
  533. </ul>
  534. </nav>
  535. </li>
  536. <li class="md-nav__item md-nav__item--nested">
  537. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  538. <label class="md-nav__link" for="__nav_7">
  539. External Resources
  540. <span class="md-nav__icon md-icon"></span>
  541. </label>
  542. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  543. <label class="md-nav__title" for="__nav_7">
  544. <span class="md-nav__icon md-icon"></span>
  545. External Resources
  546. </label>
  547. <ul class="md-nav__list" data-md-scrollfix>
  548. <li class="md-nav__item">
  549. <a href="../eso-talks/" class="md-nav__link">
  550. Talks
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../eso-demos/" class="md-nav__link">
  555. Demos
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../eso-blogs/" class="md-nav__link">
  560. Blogs
  561. </a>
  562. </li>
  563. </ul>
  564. </nav>
  565. </li>
  566. <li class="md-nav__item md-nav__item--nested">
  567. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  568. <label class="md-nav__link" for="__nav_8">
  569. References
  570. <span class="md-nav__icon md-icon"></span>
  571. </label>
  572. <nav class="md-nav" aria-label="References" data-md-level="1">
  573. <label class="md-nav__title" for="__nav_8">
  574. <span class="md-nav__icon md-icon"></span>
  575. References
  576. </label>
  577. <ul class="md-nav__list" data-md-scrollfix>
  578. <li class="md-nav__item">
  579. <a href="../spec/" class="md-nav__link">
  580. API specification
  581. </a>
  582. </li>
  583. </ul>
  584. </nav>
  585. </li>
  586. <li class="md-nav__item md-nav__item--nested">
  587. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  588. <label class="md-nav__link" for="__nav_9">
  589. Contributing
  590. <span class="md-nav__icon md-icon"></span>
  591. </label>
  592. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  593. <label class="md-nav__title" for="__nav_9">
  594. <span class="md-nav__icon md-icon"></span>
  595. Contributing
  596. </label>
  597. <ul class="md-nav__list" data-md-scrollfix>
  598. <li class="md-nav__item">
  599. <a href="../contributing-devguide/" class="md-nav__link">
  600. Developer guide
  601. </a>
  602. </li>
  603. <li class="md-nav__item">
  604. <a href="../contributing-process/" class="md-nav__link">
  605. Contributing Process
  606. </a>
  607. </li>
  608. <li class="md-nav__item">
  609. <a href="../contributing-release/" class="md-nav__link">
  610. Release Process
  611. </a>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="../contributing-coc/" class="md-nav__link">
  615. Code of Conduct
  616. </a>
  617. </li>
  618. </ul>
  619. </nav>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../deprecation-policy/" class="md-nav__link">
  623. Deprecation Policy
  624. </a>
  625. </li>
  626. </ul>
  627. </nav>
  628. </div>
  629. </div>
  630. </div>
  631. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  632. <div class="md-sidebar__scrollwrap">
  633. <div class="md-sidebar__inner">
  634. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  635. <label class="md-nav__title" for="__toc">
  636. <span class="md-nav__icon md-icon"></span>
  637. Table of contents
  638. </label>
  639. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  640. <li class="md-nav__item">
  641. <a href="#advantages" class="md-nav__link">
  642. Advantages
  643. </a>
  644. </li>
  645. <li class="md-nav__item">
  646. <a href="#the-approach" class="md-nav__link">
  647. The approach
  648. </a>
  649. </li>
  650. <li class="md-nav__item">
  651. <a href="#the-problem" class="md-nav__link">
  652. The problem
  653. </a>
  654. </li>
  655. <li class="md-nav__item">
  656. <a href="#the-solution" class="md-nav__link">
  657. The solution
  658. </a>
  659. </li>
  660. <li class="md-nav__item">
  661. <a href="#create-the-main-kustomization" class="md-nav__link">
  662. Create the main kustomization
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="#create-the-secret" class="md-nav__link">
  667. Create the secret
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="#creating-the-references-to-repositories" class="md-nav__link">
  672. Creating the references to repositories
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="#deploy-the-crds" class="md-nav__link">
  677. Deploy the CRDs
  678. </a>
  679. </li>
  680. <li class="md-nav__item">
  681. <a href="#deploy-the-operator" class="md-nav__link">
  682. Deploy the operator
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="#deploy-the-crs" class="md-nav__link">
  687. Deploy the CRs
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="#results" class="md-nav__link">
  692. Results
  693. </a>
  694. </li>
  695. </ul>
  696. </nav>
  697. </div>
  698. </div>
  699. </div>
  700. <div class="md-content" data-md-component="content">
  701. <article class="md-content__inner md-typeset">
  702. <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">
  703. <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>
  704. </a>
  705. <h1 id="gitops-using-fluxcd-v2">GitOps using FluxCD (v2)</h1>
  706. <p>FluxCD is a GitOps operator for Kubernetes. It synchronizes the status of the cluster from manifests allocated in
  707. different repositories (Git or Helm). This approach fits perfectly with External Secrets on clusters which are dynamically
  708. created, to get credentials with no manual intervention from the beginning.</p>
  709. <h2 id="advantages">Advantages</h2>
  710. <p>This approach has several advantages as follows:</p>
  711. <ul>
  712. <li><strong>Homogenize environments</strong> allowing developers to use the same toolset in Kind in the same way they do in the cloud
  713. provider distributions such as EKS or GKE. This accelerates the development</li>
  714. <li><strong>Reduce security risks</strong>, because credentials can be easily obtained, so temptation to store them locally is reduced.</li>
  715. <li><strong>Application compatibility increase</strong>: Applications are deployed in different ways, and sometimes they need to share
  716. credentials. This can be done using External Secrets as a wire for them at real time.</li>
  717. <li><strong>Automation by default</strong> oh, come on!</li>
  718. </ul>
  719. <h2 id="the-approach">The approach</h2>
  720. <p>FluxCD is composed by several controllers dedicated to manage different custom resources. The most important
  721. ones are <strong>Kustomization</strong> (to clarify, Flux one, not Kubernetes' one) and <strong>HelmRelease</strong> to deploy using the approaches
  722. of the same names.</p>
  723. <p>External Secrets can be deployed using Helm <a href="../guides-getting-started/">as explained here</a>. The deployment includes the
  724. CRDs if enabled on the <code>values.yaml</code>, but after this, you need to deploy some <code>SecretStore</code> to start
  725. getting credentials from your secrets manager with External Secrets.</p>
  726. <blockquote>
  727. <p>The idea of this guide is to deploy the whole stack, using flux, needed by developers not to worry about the credentials,
  728. but only about the application and its code.</p>
  729. </blockquote>
  730. <h2 id="the-problem">The problem</h2>
  731. <p>This can sound easy, but External Secrets is deployed using Helm, which is managed by the HelmController,
  732. and your custom resources, for example a <code>ClusterSecretStore</code> and the related <code>Secret</code>, are often deployed using a
  733. <code>kustomization.yaml</code>, which is deployed by the KustomizeController.</p>
  734. <p>Both controllers manage the resources independently, at different moments, with no possibility to wait each other.
  735. This means that we have a wonderful race condition where sometimes the CRs (<code>SecretStore</code>,<code>ClusterSecretStore</code>...) tries
  736. to be deployed before than the CRDs needed to recognize them.</p>
  737. <h2 id="the-solution">The solution</h2>
  738. <p>Let's see the conditions to start working on a solution:</p>
  739. <ul>
  740. <li>The External Secrets operator is deployed with Helm, and admits disabling the CRDs deployment</li>
  741. <li>The race condition only affects the deployment of <code>CustomResourceDefinition</code> and the CRs needed later</li>
  742. <li>CRDs can be deployed directly from the Git repository of the project using a Flux <code>Kustomization</code></li>
  743. <li>Required CRs can be deployed using a Flux <code>Kustomization</code> too, allowing dependency between CRDs and CRs</li>
  744. <li>All previous manifests can be applied with a Kubernetes <code>kustomization</code></li>
  745. </ul>
  746. <h2 id="create-the-main-kustomization">Create the main kustomization</h2>
  747. <p>To have a better view of things needed later, the first manifest to be created is the <code>kustomization.yaml</code></p>
  748. <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>
  749. <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>
  750. <span class="nt">resources</span><span class="p">:</span><span class="w"></span>
  751. <span class="c1"># Deploy the Vault access secret</span><span class="w"></span>
  752. <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>
  753. <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>
  754. <span class="c1"># Deploy the repositories</span><span class="w"></span>
  755. <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>
  756. <span class="c1"># Deploy the CRDs</span><span class="w"></span>
  757. <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>
  758. <span class="c1"># Deploy the operator</span><span class="w"></span>
  759. <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>
  760. <span class="c1"># Deploy default Custom Resources from &#39;crs&#39; directory</span><span class="w"></span>
  761. <span class="c1"># INFO: This depends on the CRDs deployment. Will happen after it</span><span class="w"></span>
  762. <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>
  763. </code></pre></div>
  764. <h2 id="create-the-secret">Create the secret</h2>
  765. <p>To access your secret manager, External Secrets needs some credentials. They are stored inside a Secret, which is intended
  766. 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>
  767. <div class="highlight"><pre><span></span><code><span class="c1"># The namespace.yaml first</span><span class="w"></span>
  768. <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>
  769. <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>
  770. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  771. <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>
  772. </code></pre></div>
  773. <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>
  774. <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>
  775. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  776. <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>
  777. <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>
  778. <span class="nt">stringData</span><span class="p">:</span><span class="w"></span>
  779. <span class="w"> </span><span class="c1"># This token must be patched by overlays. Not here for security reasons</span><span class="w"></span>
  780. <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>
  781. </code></pre></div>
  782. <h2 id="creating-the-references-to-repositories">Creating the references to repositories</h2>
  783. <p>Create a manifest called <code>repositories.yaml</code> to store the references to external repositories for Flux</p>
  784. <div class="highlight"><pre><span></span><code><span class="c1"># Reference to Helm repository</span><span class="w"></span>
  785. <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>
  786. <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>
  787. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  788. <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>
  789. <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>
  790. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  791. <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>
  792. <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>
  793. <span class="nn">---</span><span class="w"></span>
  794. <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>
  795. <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>
  796. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  797. <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>
  798. <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>
  799. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  800. <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>
  801. <span class="w"> </span><span class="nt">ref</span><span class="p">:</span><span class="w"></span>
  802. <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>
  803. <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>
  804. </code></pre></div>
  805. <h2 id="deploy-the-crds">Deploy the CRDs</h2>
  806. <p>As mentioned, CRDs can be deployed using the official Helm package, but to solve the race condition, they will be deployed
  807. from our git repository using a Kustomization manifest called <code>deployment-crds.yaml</code> as follows:</p>
  808. <div class="highlight"><pre><span></span><code><span class="nn">---</span><span class="w"></span>
  809. <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>
  810. <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>
  811. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  812. <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>
  813. <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>
  814. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  815. <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>
  816. <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>
  817. <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>
  818. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  819. <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>
  820. <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>
  821. </code></pre></div>
  822. <h2 id="deploy-the-operator">Deploy the operator</h2>
  823. <p>The operator is deployed using a HelmRelease manifest to deploy the Helm package, but due to the special race condition,
  824. the deployment must be disabled in the <code>values</code> of the manifest called <code>deployment.yaml</code>, as follows:</p>
  825. <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>
  826. <span class="c1"># How to inject values: https://fluxcd.io/docs/guides/helmreleases/#cloud-storage</span><span class="w"></span>
  827. <span class="nn">---</span><span class="w"></span>
  828. <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>
  829. <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>
  830. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  831. <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>
  832. <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>
  833. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  834. <span class="w"> </span><span class="c1"># Override Release name to avoid the pattern Namespace-Release</span><span class="w"></span>
  835. <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>
  836. <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>
  837. <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>
  838. <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>
  839. <span class="w"> </span><span class="nt">chart</span><span class="p">:</span><span class="w"></span>
  840. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  841. <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>
  842. <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>
  843. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  844. <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>
  845. <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>
  846. <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>
  847. <span class="w"> </span><span class="nt">values</span><span class="p">:</span><span class="w"></span>
  848. <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>
  849. <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>
  850. <span class="w"> </span><span class="nt">install</span><span class="p">:</span><span class="w"></span>
  851. <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>
  852. </code></pre></div>
  853. <h2 id="deploy-the-crs">Deploy the CRs</h2>
  854. <p>Now, be ready for the arcane magic. Create a Kustomization manifest called <code>deployment-crs.yaml</code> with the following content:</p>
  855. <div class="highlight"><pre><span></span><code><span class="nn">---</span><span class="w"></span>
  856. <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>
  857. <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>
  858. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  859. <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>
  860. <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>
  861. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  862. <span class="w"> </span><span class="nt">dependsOn</span><span class="p">:</span><span class="w"></span>
  863. <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>
  864. <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>
  865. <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>
  866. <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>
  867. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  868. <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>
  869. <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>
  870. </code></pre></div>
  871. <p>There are several interesting details to see here, that finally solves the race condition:</p>
  872. <ol>
  873. <li>First one is the field <code>dependsOn</code>, which points to a previous Kustomization called <code>external-secrets-crds</code>. This
  874. dependency forces this deployment to wait for the other to be ready, before start being deployed.</li>
  875. <li>The reference to the place where to find the CRs
  876. <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>
  877. <span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  878. <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>
  879. <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>
  880. </code></pre></div>
  881. Custom Resources will be searched in the relative path <code>./infrastructure/external-secrets/crs</code> of the GitRepository
  882. called <code>flux-system</code>, which is a reference to the same repository that FluxCD watches to synchronize the cluster.
  883. With fewer words, a reference to itself, but going to another directory called <code>crs</code></li>
  884. </ol>
  885. <p>Of course, allocate inside the mentioned path <code>./infrastructure/external-secrets/crs</code>, all the desired CRs to be deployed,
  886. for example, a manifest <code>clusterSecretStore.yaml</code> to reach your Hashicorp Vault as follows:</p>
  887. <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>
  888. <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>
  889. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  890. <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>
  891. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  892. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  893. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span><span class="w"></span>
  894. <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>
  895. <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>
  896. <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>
  897. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  898. <span class="w"> </span><span class="c1"># points to a secret that contains a vault token</span><span class="w"></span>
  899. <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/token</span><span class="w"></span>
  900. <span class="w"> </span><span class="nt">tokenSecretRef</span><span class="p">:</span><span class="w"></span>
  901. <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>
  902. <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>
  903. <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>
  904. </code></pre></div>
  905. <h2 id="results">Results</h2>
  906. <p>At the end, the required files tree is shown in the following picture:</p>
  907. <p><img alt="FluxCD files tree" src="../pictures/screenshot_gitops_final_directory_tree.png" /></p>
  908. </article>
  909. </div>
  910. </div>
  911. </main>
  912. <footer class="md-footer">
  913. <nav class="md-footer__inner md-grid" aria-label="Footer">
  914. <a href="../provider-kubernetes/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Kubernetes" rel="prev">
  915. <div class="md-footer__button md-icon">
  916. <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>
  917. </div>
  918. <div class="md-footer__title">
  919. <div class="md-ellipsis">
  920. <span class="md-footer__direction">
  921. Previous
  922. </span>
  923. Kubernetes
  924. </div>
  925. </div>
  926. </a>
  927. <a href="../examples-anchore-engine-credentials/" class="md-footer__link md-footer__link--next" aria-label="Next: Anchore Engine" rel="next">
  928. <div class="md-footer__title">
  929. <div class="md-ellipsis">
  930. <span class="md-footer__direction">
  931. Next
  932. </span>
  933. Anchore Engine
  934. </div>
  935. </div>
  936. <div class="md-footer__button md-icon">
  937. <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>
  938. </div>
  939. </a>
  940. </nav>
  941. <div class="md-footer-meta md-typeset">
  942. <div class="md-footer-meta__inner md-grid">
  943. <div class="md-copyright">
  944. Made with
  945. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  946. Material for MkDocs
  947. </a>
  948. </div>
  949. </div>
  950. </div>
  951. </footer>
  952. </div>
  953. <div class="md-dialog" data-md-component="dialog">
  954. <div class="md-dialog__inner md-typeset"></div>
  955. </div>
  956. <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>
  957. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  958. </body>
  959. </html>